Developer guide

How the codebase works and how to build, test, package, and release it. ARCHITECTURE.md is the source of truth for current behavior; everything else here supports it.

Suggested reading order

New to the codebase? Read these in order:

1. ARCHITECTURE.md — codebase layout, layering rules, code generation, and the game package/plugin model.
2. terminology.md — the canonical glossary mapping user-facing terms to code identifiers. Check it before naming anything; persisted names are contracts.
3. conventions.md — the house rules for naming, comments, ordering, tests, docs, and commits.
4. design-system.md — design tokens, shared widgets, and the icon-only/tooltip conventions for building screens.
5. Topic guides as needed:
   • system-dependencies.md — runtime and build libraries per platform.
   • ci-and-packaging.md — the CI pipeline, packaging formats, signing, release versioning, and the GitLab Pages site.
6. ../PROJECT_PLAN.md — the original phased roadmap, kept for historical context in the repo. It is not a statement of current feature status.
7. ../adr/README.md — why specific technical choices were made. ADRs are historical too; they are not updated when implementation evolves. Both documents are excluded from this site and browsed in the repo instead.