# AGENTS.md

OBS Studio - Free and open source software for live streaming and screen recording

## Setup

```
# TODO: the install command. No lockfile was found, so this could not be inferred.
```

## Commands

```
# TODO: nothing declares a build or test command, so an agent has to guess.
# This is the single most valuable section of this file. Fill it in.
```

## Layout

- `plugins/`      550 source files
- `frontend/`     377 source files
- `deps/`         344 source files
- `libobs/`       221 source files
- `shared/`       95 source files
- `libobs-metal/` 35 source files

## Conventions

- Tests live alongside the code they cover, following `deps/w32-pthreads/tests/Bmakefile`.
- CI defines what passing means. See `.github/workflows/analyze-project.yaml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `deps/glad/include/glad/glad.h` is 684KB. It will not fit comfortably in context, so read it in parts.
- No lockfile is committed, so an install here may not match what CI produced.

---

Drafted by agentreadme.com from what is in this repository. Everything marked TODO
needs a human. Check it in as AGENTS.md at the root.