aboutsummaryrefslogtreecommitdiff
path: root/building_guide/courses.md
diff options
context:
space:
mode:
Diffstat (limited to 'building_guide/courses.md')
-rw-r--r--building_guide/courses.md5
1 files changed, 2 insertions, 3 deletions
diff --git a/building_guide/courses.md b/building_guide/courses.md
index 491e2bd..e11f909 100644
--- a/building_guide/courses.md
+++ b/building_guide/courses.md
@@ -2,10 +2,11 @@
Agility courses are defined in `data/courses/<id>.yaml`. Each course defines a sequence of obstacle rooms, each with a specific verb the player must type to advance. Obstacle rooms themselves are standard room YAML files (typically in `data/rooms/agility/`).
+**The filename is the ID** (`vent_shaft.yaml` → `vent_shaft`); the loader derives it from the filename. Do not put an `id:` field in the file — it is ignored.
+
### Course YAML
```yaml
-id: "vent_shaft"
name: "Ventilation Shaft Course"
required_level: 1
start_room: 200
@@ -79,7 +80,6 @@ Completing all obstacles in a course increments a lap counter stored as a player
Each obstacle room should have an `on_enter` message telling the player which verb to use, and a `down` exit back to the course hub:
```yaml
-id: 201
name: "Ventilation Shaft - Corroded Wall"
description: "A towering wall of corroded ventilation panels..."
on_enter:
@@ -93,7 +93,6 @@ exits:
The hub room (e.g. room 200) links to the first obstacle of each course:
```yaml
-id: 200
name: "Agility Training Grounds"
exits:
south: 17