lily/mudserver
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Clean up README: remove redundant TOML examples, point to schema docs

Browse Source 
Made-with: Cursor
This commit is contained in:
AI Agent
2026-03-14 16:41:29 -06:00
parent e5e7057650
commit 156410bc39
1 changed files with 22 additions and 101 deletions
Download Patch File Download Diff File Expand all files Collapse all files

123
README.md
View File

@@ -55,118 +55,39 @@ RUST_LOG=debug ./target/release/mudserver # verbose
## World Data ## World Data
The world is defined entirely in TOML files under a `world/` directory. The server reads this at startup — no recompilation needed to change content. The world is defined in TOML files under `world/`. The server loads them at startup — no recompilation needed to change content.
### Directory Structure ### Directory structure
``` ```
world/ world/
├── manifest.toml # world name and spawn room ├── manifest.toml
├── races/ # playable races ├── races/
│ ├── dwarf.toml ├── classes/
│ ├── elf.toml ├── guilds/
│ └── ... ├── spells/
├── classes/ # playable classes └── <region>/
│ ├── warrior.toml ├── region.toml
│ ├── mage.toml
│ └── ...
└── <region>/ # one directory per region
├── region.toml # region metadata
├── rooms/ ├── rooms/
│ ├── town_square.toml
│ └── ...
├── npcs/ ├── npcs/
│ ├── barkeep.toml
│ └── ...
└── objects/ └── objects/
├── rusty_sword.toml
└── ...
``` ```
### manifest.toml ### Schema reference
```toml Each folder contains a reference doc listing every TOML option:
name = "The Shattered Realm"
spawn_room = "town:town_square"
```
### Room | Location | Reference |
|----------|-----------|
```toml | `world/` | [MANIFEST.md](world/MANIFEST.md) — world name, spawn room, layout |
name = "Town Square" | `world/races/` | [RACES.md](world/races/RACES.md) — stats, body, natural attacks, resistances, etc. |
description = "A cobblestone square with a fountain." | `world/classes/` | [CLASSES.md](world/classes/CLASSES.md) — base stats, growth, hidden, guild |
| `world/guilds/` | [GUILDS.md](world/guilds/GUILDS.md) — spells, growth, race restrictions |
[exits] | `world/spells/` | [SPELLS.md](world/spells/SPELLS.md) — damage, cost, cooldown, effects |
north = "town:tavern" | `world/<region>/` | [REGION.md](world/town/REGION.md) — region metadata |
south = "town:gate" | `world/<region>/rooms/` | [ROOMS.md](world/town/rooms/ROOMS.md) — name, description, exits |
east = "town:market" | `world/<region>/npcs/` | [NPCS.md](world/town/npcs/NPCS.md) — attitude, race/class, combat, dialogue |
``` | `world/<region>/objects/` | [OBJECTS.md](world/town/objects/OBJECTS.md) — slot, stats, takeable |
Room IDs are `<region>:<filename_stem>`.
### NPC
```toml
name = "Town Guard"
description = "A bored guard."
room = "town:gate"
base_attitude = "neutral" # friendly, neutral, wary, aggressive, hostile
faction = "guards" # optional — attitude shifts propagate to faction
respawn_secs = 90 # optional — respawn timer after death
[dialogue]
greeting = "Move along."
[combat] # optional — omit for weak default stats (20hp/4atk/2def/5xp)
max_hp = 60
attack = 10
defense = 8
xp_reward = 25
```
### Object
```toml
name = "Rusty Sword"
description = "A battered iron blade."
room = "town:cellar"
kind = "weapon" # weapon, armor, consumable, treasure, or omit
takeable = true
[stats]
damage = 5 # for weapons
# armor = 4 # for armor
# heal_amount = 30 # for consumables
```
### Race
```toml
name = "Dwarf"
description = "Stout and unyielding."
[stats]
strength = 1
dexterity = -1
constitution = 2
```
### Class
```toml
name = "Warrior"
description = "Masters of arms and armor."
[base_stats]
max_hp = 120
attack = 14
defense = 12
[growth]
hp_per_level = 15
attack_per_level = 3
defense_per_level = 2
```
## Game Mechanics ## Game Mechanics