Developers - poli0981/frameledger GitHub Wiki
FrameLedger is a C++ component loaded into the games a user chose, a C# capture agent beside it, and a WPF app, with one
SQLite file between them. These pages are short on purpose: each says what a part is and where its full document is.
The full set is docs/, and the rules every AI-assisted change follows are in
CLAUDE.md.
Start here
- Contributor rules — the rules every change keeps. Safety comes first, and some changes are refused whatever they improve.
- Architecture, then Repository map.
- Build and test —
./build.ps1 checkis the whole gate, the same one CI runs.
Picking up work where it stopped: docs/HANDOFF.md has the sequencing, the owner's decisions
and the traps that each cost a cycle.
Where status lives
These pages never say what is done or what is next. Status is in four files, and nowhere else:
| Question | File |
|---|---|
| What is unresolved, and what does it block? | docs/20_OPEN_QUESTIONS.md |
| What was measured, and on what machine? | docs/spike-notes.md |
| Which phase is where? | docs/15_ROADMAP.md |
| What landed, in which release? | CHANGELOG.md |
Check a status claim against the code before you plan on it: more than one document has said "built" of something that was not, and the repository corrects such sentences where they stand — struck through and dated — rather than quietly.
The other pages
- Capture pipeline — what the agent does from the moment a game starts.
- Metrics — what each number means, and the rules for showing it.
- Data and IPC — the database, the shared memory and the pipe.
- App UI development — the WPF app, and the traps of its UI library.
- Releasing — from a merged change to an update on a user's PC.
- Developer glossary — the project's own words.
Contributing is described in CONTRIBUTING.md, redistributing in FORKING.md,
and how to report a vulnerability in SECURITY.md.