README.md
1321 bytes · Original / download
Documentation
Start with ARCHITECTURE.md, then read the document for the area you are changing. Contribution rules are in ../CONTRIBUTING.md.
| Document | Covers |
|---|---|
| ARCHITECTURE.md | Layers, boot, one frame, where things are, runtime files |
| THREADS.md | Cores, pacing, who owns which data, known races |
| RENDERING.md | The three presentation paths, voxel passes, GBA overlay, GPU rules |
| SCENES_16_9.md | How GBA screens fill 960×544, and the planned Wide Scene system |
| VOXEL_ENGINE.md | The 3D overworld modules, chunks, atlas, map changes |
| VITA_UI.md | The native 16:9 touch interface (src/platform/ui/), its five themes, battle HUD, and the Vita features behind it |
| BUILD_YOUR_OWN.md | For users: make your own VPK from your Pokémon Emerald cartridge (Spanish) |
| BUILD.md | Toolchain, build steps, CMake options, installing and testing |
| ASSETS.md | Where every data file comes from and how it is generated |
| DEBUGGING.md | Logs, per-frame telemetry, crash dumps |
The design mocks of the new UI are in ../design/stitch/.