Schema reference
Generated by
pnpm schemas:generatefrom the Zod schemas inpackages/shared/src/schemas/. Do not edit by hand; change the schema's.describe()text instead.
Field tables for every file a world or plugin author writes. Concepts, boundaries and reasons stay in the hand-written reference pages; legal fields live here.
| File | Fields | JSON Schema |
|---|---|---|
world.yaml | world manifest | world-manifest.schema.json |
data/world.data.yaml | world data descriptor | world-data.schema.json |
data/dimensions.yaml | world dimensions | world-dimensions.schema.json |
PLUGIN.md frontmatter | plugin manifest | plugin-manifest.schema.json |
RUNTIME.md frontmatter | runtime manifest | runtime-manifest.schema.json |
Editor support
Editors that use the YAML language server show completion, hover text and inline errors once a file names its schema on the first line:
yaml
# yaml-language-server: $schema=../../packages/shared/schemas/world-manifest.schema.jsonThe path is relative to the file. The bundled worlds under worlds/ use the form above for world.yaml.
What the JSON Schema does not check
The Zod schemas stay authoritative. Cross-field rules, uniqueness rules and the dimension value subset are enforced only by pnpm validate:world and pnpm validate:plugin.