Documentation
Docs/en/reference/map-format/index.md
Generated Map Format Reference
Generated reference. Do not edit directly. Update
BuildTools/MapFormatInterface.jsonor the owning engine metadata, then runpython BuildTools/docs_map_format.py --write.
| Index | Syntax | Properties | Baking | Validation | Canonical JSON | Authoring guide |
This reference describes the reusable engine contract for authored .fomap files, their side-specific bake products, and initial runtime materialization.
Contract status
| Field | Value |
|---|---|
| Stability | experimental |
| Support policy | The contract is generated for a pinned engine revision. Project map catalogs, custom metadata, gameplay semantics, and composition policy remain project-owned. |
| Source manifest | BuildTools/MapFormatInterface.json |
| Contract digest | 07431a7209c6beff0e6b2d828070b596d7a4f7ac0d6a2859c79bfb23effe732a |
| Reference | Entries | Purpose |
|---|---|---|
| Syntax | 8 | Sections and control directives. |
| Properties | 108 | Engine-owned Map, Critter, and Item properties. |
| Baking | 4 | Ownership and server/client materialization. |
| Validation | 19 | Source-backed requirements and limitations. |
Boundary
Included:
- one or more ProtoMap anchors with nested map-addressed Critter and Item sections
- map identity, placement ids, prototype references, ownership, and property overrides
- mapper normalization, side-specific baking, and runtime materialization
- engine-owned Map, Critter, and Item property catalogs
Excluded:
- project-authored properties, prototype ids, map catalogs, and directory taxonomy
- quest, encounter, balance, visual-kit, and level-design policy
- runtime save records and dynamic entities created after map materialization
- pathfinding, combat geometry, lighting design, and renderer-specific composition guidance
Embedding projects must document their added metadata, prototypes, map catalog, and level-design conventions separately.