Add TOML reference docs for all world data types
- world/MANIFEST.md: manifest.toml and directory layout - world/races/RACES.md: race schema (stats, body, natural, resistances, etc.) - world/classes/CLASSES.md: class schema (base_stats, growth, hidden, guild) - world/guilds/GUILDS.md: guild schema and [growth] - world/spells/SPELLS.md: spell schema and types - world/town/REGION.md: region.toml - world/town/rooms/ROOMS.md: room schema and exits - world/town/npcs/NPCS.md: NPC schema, race/class resolution - world/town/objects/OBJECTS.md: object schema and [stats] Made-with: Cursor
This commit is contained in:
34
world/MANIFEST.md
Normal file
34
world/MANIFEST.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# World Manifest Reference
|
||||
|
||||
The file `world/manifest.toml` defines the world identity and spawn location. There is exactly one manifest per world.
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
|-------|------|----------|-------------|
|
||||
| `name` | string | Yes | World name (e.g. shown at login). |
|
||||
| `spawn_room` | string | Yes | Full room ID where new characters and respawned dead characters appear (e.g. `"town:town_square"`). Must reference an existing room. |
|
||||
|
||||
## Example
|
||||
|
||||
```toml
|
||||
name = "The Shattered Realm"
|
||||
spawn_room = "town:town_square"
|
||||
```
|
||||
|
||||
## Directory layout
|
||||
|
||||
The loader expects (under `world/`):
|
||||
|
||||
- `manifest.toml` — this file
|
||||
- `races/*.toml` — race definitions (see `races/RACES.md`)
|
||||
- `classes/*.toml` — class definitions (see `classes/CLASSES.md`)
|
||||
- `guilds/*.toml` — guild definitions (see `guilds/GUILDS.md`)
|
||||
- `spells/*.toml` — spell definitions (see `spells/SPELLS.md`)
|
||||
- `<region>/` — one folder per region (e.g. `town/`), each containing:
|
||||
- `region.toml` — region metadata (see `town/REGION.md`)
|
||||
- `rooms/*.toml` — rooms (see `town/rooms/ROOMS.md`)
|
||||
- `npcs/*.toml` — NPCs (see `town/npcs/NPCS.md`)
|
||||
- `objects/*.toml` — objects (see `town/objects/OBJECTS.md`)
|
||||
|
||||
Folder names `races`, `classes`, `guilds`, and `spells` are reserved; other top-level directories are treated as regions.
|
||||
Reference in New Issue
Block a user