OpenBF1942-Plus
Refractor 1, rebuilt from scratch
Loading...
Searching...
No Matches
DEVELOPMENT_GUIDE

Workflow for a new format

  1. Survey: extract samples to out/ (git-ignored) or a scratch dir, inventory structure.
  2. Write the reader in tools/<format>.py with a synthetic-data test in tools/test_<format>.py.
  3. Verify locally against every matching file in <BF1942_DIR>; record the counts in the spec.
  4. Write docs/formats/<format>.md; mark anything not verified.
  5. Update SYSTEM_SUMMARY and add a PROJECT_MEMORY stage.
  6. C++ port (when the engine needs it): module in engine/, tests in engine/test_engine.cpp, row in boundaries.

Quality bar

  • Tests, engine build without warnings, engine tests and doc checks from the SYSTEM_SUMMARY commands pass; CI (.github/workflows/ci.yml) runs the same on every push.
  • Game changes: the level sweep still runs clean — obf_sim on every level of the three mods (--play 2 --sim 120), no errors. A refactor must reproduce --shot logs and images exactly (same build flags).

Commits

  • Imperative subject, body says why. One topic per commit; code and the docs it affects together.

Doc-sync

When you change Update
A format reader its docs/formats/*.md, SYSTEM_SUMMARY contracts
Files or folders in the tree SYSTEM_SUMMARY tree
A roadmap step's state SYSTEM_SUMMARY, both READMEs
A hard rule or stack choice new ADR, ARCHITECTURE_NOTES, AGENTS.md
An engine module or its dependencies boundaries.md, SYSTEM_SUMMARY tree
A risk or open question docs/roadmap/debt.md
English README the five translations (README.es.md, README.pt.md, README.fr.md, README.de.md, README.ru.md) in the same commit

Memory entry template

## YYYY-MM-DD — topic
- what changed and why it mattered
- what was rejected
- what is left open