pokeplatinum/docs
Kuruyia eab4f9a4ad Start Markdown documentation of the maps system
This starts a human-readable documentation of the various subsystems
used in the game's map system. The following files are included in this
commit:

- `maps.md`: a general overview of maps
- `bdhc.md`: an overview of the BDHC subsystem, which is used to provide
  height information on maps
- `loading_maps.md`: an overview of how maps are loaded by the game
- `file_format_specifications.md`: specs for the maps data structures

The `file_format_specifications.md` is meant to be a purely technical
document that contains a precise description of the data structures used
by the game's map system.

The other files are meant to be semi-technical documentation, where some
of the nitty-gritty details have been either simplified or left out
entirely.

Some of the maps subsystems were purposefully left out of this commit,
such as map objects and map scripts. They will need to be addressed in
future updates to those documents.

Signed-off-by: Kuruyia <github@kuruyia.net>
2025-03-16 21:40:56 +01:00
..
editor_setup Overhaul CONTRIBUTING.md + integrate editorconfig and pre-commit 2025-03-08 21:43:47 -08:00
maps Start Markdown documentation of the maps system 2025-03-16 21:40:56 +01:00
2d_rendering.md Start 2D rendering documentation + document background system 2024-10-22 12:52:12 -07:00
3d_rendering.md Identify unk_02017728 -> system and zip core_sys.h into it 2025-02-07 21:53:06 -08:00
bugs_and_glitches.md wild_encounter PR cleanup 2025-02-05 01:16:46 -05:00
index.md Overhaul CONTRIBUTING.md + integrate editorconfig and pre-commit 2025-03-08 21:43:47 -08:00