This adds a reference to where to find documentation about NSBTP files
in the maps Markdown docs, and adds that this file format can be
encountered in the map prop animations NARC.
Signed-off-by: Kuruyia <github@kuruyia.net>
This starts the Markdown documentation for the dynamic map features,
explaining their purpose, how they are used, the data structures and
interfaces that are defined.
This also documents the platform lift dynamic map feature.
Signed-off-by: Kuruyia <github@kuruyia.net>
This fixes the size of the `modelID` field found in the land data NARC
files. It was incorrectly documented as being 2 bytes, where it is in
reality 4 bytes.
Signed-off-by: Kuruyia <github@kuruyia.net>
This fixes the following related to area light in the file format
specifications Markdown document:
- change the name of the area light NARC file from `area_light.narc` to
`arealight.narc` to reflect its real name in the repo
- change the "light enabled" parameter to "light valid", as documented
in area light-related code.
Signed-off-by: Kuruyia <github@kuruyia.net>
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>
Documents honey_tree. Mostly. There are some functions related to the overworld tree shaking animation that I didn't document, but it's at least contextually obvious what the end result is.
Also might have a bit of roamer stuff, idk, this commit was sitting for 2 weeks
