Documentation
Docs/en/reference/prototype-format/index.md
Generated Prototype Format Reference
Generated reference. Do not edit directly. Update
BuildTools/PrototypeFormatInterface.jsonor the owning engine metadata, then runpython BuildTools/docs_prototype_format.py --write.
| Index | Syntax | Properties | Validation | Canonical JSON | Authoring guide |
This reference describes the engine-owned prototype grammar and the built-in metadata available to any embedding project at this engine revision.
Contract status
| Field | Value |
|---|---|
| Stability | experimental |
| Support policy | The grammar is documented for a pinned engine revision. Concrete project entity types, properties, file extensions, ids, and gameplay semantics remain project-owned. |
| Source manifest | BuildTools/PrototypeFormatInterface.json |
| Contract digest | c64f7648fda0f3013bebb941061880467aa4f276e8316872eb988cdcf53edd6a |
| Reference | Entries | Purpose |
|---|---|---|
| Syntax | 5 | Discovery, sections, identity, and inheritance. |
| Properties | 112 | Built-in HasProtos types and engine-owned property keys. |
| Validation | 14 | Source-backed bake and migration requirements. |
Boundary
Included:
- prototype file discovery and side-specific bake outputs
- section forms, prototype identity, inheritance, and migration
- property applicability and strict text-value validation
- built-in InitScript callback signature validation
- built-in HasProtos entity types and their engine-owned property catalog
Excluded:
- project-authored entity and FixedType declarations or properties
- nested map placement sections addressed as $Name/Critter or $Name/Item
- gameplay balance, content ids, directory taxonomy, and localization policy
- runtime persistence records and project migration rollout policy
Embedding projects must generate or document their additional entity declarations, FixedType metadata, properties, extensions, and content IDs separately.