aboutsummaryrefslogtreecommitdiff
path: root/building_guide/README.md
blob: de70acd968a7cfcfc08df62420a5a17b50dff30b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# About this directory

These guides are for **human world builders** working on the game's content:
rooms, objects, mobs, items, drops, triggers, quests, hazards, casino table
configuration, and similar data-driven world YAML.

**Do not put engine documentation here.** Anything about Go internals,
architecture, concurrency, testing, TODOs, roadmaps, or implementation
assessments belongs in [`../dev_guide/`](../dev_guide/README.md) or in code
comments next to the code it describes. Keeping the split clean matters:
builders should be able to read this directory top to bottom without
knowing the source layout.

| Guide | Covers |
|---|---|
| [admin.md](admin.md) | In-game admin commands and the web admin panel |
| [bank.md](bank.md) | Bank booths and player banking commands |
| [behaviors.md](behaviors.md) | Gather, talk and shop behaviors |
| [construction.md](construction.md) | Player-owned housing and furniture |
| [courses.md](courses.md) | Agility courses |
| [drops.md](drops.md) | Shared drop tables |
| [hazards.md](hazards.md) | Environmental hazards |
| [items.md](items.md) | Items, equipment, food, combinations |
| [mobs.md](mobs.md) | Mobs, combat stats, shops, task mobs |
| [objects.md](objects.md) | Objects, interactions, safespots |
| [pai_gow.md](pai_gow.md) | Pai Gow Poker table configuration |
| [quests.md](quests.md) | Quest walkthrough example |
| [recipes.md](recipes.md) | Crafting and recipes |
| [rooms.md](rooms.md) | Rooms, exits, casino tables, triggers |
| [tips.md](tips.md) | Building tips |
| [triggers.md](triggers.md) | Trigger scenarios |
| [video_poker.md](video_poker.md) | Video poker cabinet configuration |