diff options
Diffstat (limited to 'building_guide/courses.md')
| -rw-r--r-- | building_guide/courses.md | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/building_guide/courses.md b/building_guide/courses.md index 3f571e0..eecfb00 100644 --- a/building_guide/courses.md +++ b/building_guide/courses.md @@ -4,7 +4,7 @@ Agility courses are defined in `data/courses/<id>.yaml`. Each course defines a s **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. -> Editing courses is done from the **Map screen** in the admin web GUI: select an obstacle room and use its **Course** side-panel tab to create a course, add the room as a step, edit all of its parameters, or remove it. The legacy standalone "Courses" editor tab has been removed. +> Editing courses is done from the **Map screen** in the admin web GUI: select an obstacle room and use its **Course** side-panel tab to create a course, add the room as a step, edit all of its parameters, or remove it. > > When a room is added as a course step, the admin GUI auto-creates **always-blocked one-way exits** between consecutive obstacle rooms so the in-game map can lay them out correctly. The direction of these exits is chosen by the builder. Always-blocked exits are blocked to players (movement is refused with the standard "blocked" message and they show "(blocked)" in `look`) but visible on the map — they exist solely for map rendering. On the map, course links appear as blue dashed one-way arrows (colored via the `map_agility` theme token). @@ -66,7 +66,7 @@ obstacles: | Field | Type | Description | | ------------ | -------- | -------------------------------------------------------------------------- | | `message` | string | Text printed when this phase advances | -| `delay` | float64 | Ticks to wait before printing this phase (supports fractional via `engine.ToTicks`) | +| `delay` | float64 | Ticks to wait before printing this phase (fractional values allowed) | | `fail_check` | bool | If true, the obstacle's failure roll happens on this phase (set on at most one phase) | ### Phase Advancement @@ -128,4 +128,5 @@ exits: | `leap` | leaping | | `slide` | sliding | -Obstacle verbs are auto-registered at startup from all course YAML files. No changes to `cmd_registry.go` needed when adding new courses — any verb in a `data/courses/` file will work.
\ No newline at end of file +Obstacle verbs are auto-registered at startup from all course YAML files — any verb in a +`data/courses/` file will work without additional configuration. |