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

Must

  • Treat archive contents as untrusted input: validate sizes, refuse path escapes (rfa.safe_path).
  • Keep each format's reference implementation in tools/ and its spec in docs/formats/.
  • Use synthetic data in tests (Python unittest, C++ test_engine).
  • Port a format to C++ only after its Python reference and spec exist; keep both in sync.
  • Tools build on each other one way: rfa ← con (VFS) ← sm.

Must not

  • Commit game data or personal paths (ADR 0001).
  • Add third-party Python dependencies to tools/ (ADR 0002).
  • Abort on unknown .con lines: retail scripts contain junk.

Irreversible decisions

Decision ADR
No game data, read the user's install 0001
Python tools, C++ engine 0002
SDL2 + OpenGL 3.3 + epoxy, CPU texture decoding 0003
Jolt for rigid bodies; vehicle parts as our forces 0004
Network compatibility with original clients and servers; fidelity required 0005

Module rules and allowed dependencies: boundaries.md.