e5e7057650
- 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
29 lines
1023 B
Markdown
29 lines
1023 B
Markdown
# Region TOML Reference
|
|
|
|
Each region is a directory under `world/` (e.g. `world/town/`) containing a `region.toml` file. The directory name is the region ID (e.g. `town`). Room, NPC, and object IDs in this region are prefixed with `"<region>:"` (e.g. `town:tavern`).
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description |
|
|
|-------|------|----------|-------------|
|
|
| `name` | string | Yes | Display name of the region (e.g. for logs or future use). |
|
|
|
|
Additional keys (e.g. `description`) may be present in the file; only `name` is required by the loader.
|
|
|
|
## Example
|
|
|
|
```toml
|
|
name = "Thornwall"
|
|
description = "A fortified trading town at the crossroads of the known world."
|
|
```
|
|
|
|
## Region contents
|
|
|
|
Place TOML files in these subdirectories of the region folder:
|
|
|
|
- `rooms/*.toml` — room definitions (see `rooms/ROOMS.md`)
|
|
- `npcs/*.toml` — NPC definitions (see `npcs/NPCS.md`)
|
|
- `objects/*.toml` — object definitions (see `objects/OBJECTS.md`)
|
|
|
|
The server loads all regions whose folder contains a `region.toml` file.
|