Project audits, implementation research, release handoffs, and technical roadmaps live in docs/. Read the relevant documents there before changing the corresponding subsystem, and update them when new evidence changes a recorded conclusion.
Start with:
docs/README.mdfor the documentation catalog and maintenance rules.docs/netplay-audit.mdfor the netplay verdict, evidence boundaries, risk summary, and document index.docs/netplay-lobby.mdfor lobby discovery, connection, mapping, and start/stop behavior.docs/netplay-protocol-security.mdfor protocol, trust-boundary, parser, save-transfer, and reliability findings.docs/netplay-rollback-roadmap.mdfor fixed-delay behavior, rollback experiments, measurements, tests, and the staged implementation plan.docs/build-release-pipeline.mdfor Windows cross-compilation, caching, artifact publication, and AppImage packaging.docs/windows-runtime-controls.mdfor packaged Windows dependencies, first-run compilation, controls, netplay startup, and troubleshooting.docs/release-history-and-testing.mdfor theellrelease lineage, validation evidence, and remaining platform test gaps.docs/launcher-ui-research.mdfor launcher architecture and cross-platform setup research.docs/launcher-experience-prototype.mdfor the implemented source launcher, setup flow, UI decisions, validation evidence, and release boundary.
Documentation rules:
- Keep
README.mdat the repository root as the user-facing project entry point. - Keep subsystem-owned
README.md,CONTRIBUTING.md, and provenance files beside the code they describe; thedocs/rule applies to repository-level research and handoffs. - Put new research and handoff Markdown in
docs/, not in the repository root. - Record the commit, date, exact reproduction commands, and source path/line evidence for audits and measurements.
- Separate shipped behavior, historical measurements, proposed work, and unverified assumptions.
- Do not describe the integrated C++ launcher as packaged or shipped yet: commit
514cd424is a source-tree prototype, while the Windows ZIP and Linux AppImage still use their existing wrapper and script setup paths. - Do not describe current netplay as rollback: the audited implementation is fixed-delay lockstep. Rollback exists only as experimental state/replay groundwork until the live protocol gains prediction, snapshots, correction, and resimulation.