From 1aba2bdd23aebed4032333e74aa553c40a31fcbd Mon Sep 17 00:00:00 2001
From: historia <[not public]>
Date: Sun, 14 Jun 2026 21:07:26 -0400
Subject: refactor: added docs, split up some components in game package

---
 WORLDBUILDING.md | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)

(limited to 'WORLDBUILDING.md')

diff --git a/WORLDBUILDING.md b/WORLDBUILDING.md
index 9585c32..93fa16d 100644
--- a/WORLDBUILDING.md
+++ b/WORLDBUILDING.md
@@ -292,7 +292,7 @@ drops:
     weight: 10
     depletes: false            # gem drops don't deplete the rock
     message: "You spot a glint of something valuable!"
-deplete_delay: 50              # ticks until rock respawns
+respawn_timer: 50              # ticks until rock respawns
 respawn_message: "You see more ore in the rock."
 respawn_broadcast: "A glint of copper catches your eye from some {name}."
 ```
@@ -337,10 +337,10 @@ fail_message: "You swing but get no logs."
 drops:
   - item_id: oak_logs
     weight: 100
-    depletes: false            # depletion is timer-based (shared_deplete)
+    depletes: false            # depletion is timer-based (deplete_timer)
     message: "You get some oak logs."
-deplete_delay: 14              # ticks until tree respawns after being cut down
-shared_deplete: 45             # max ticks before next gather depletes (counts down while chopping)
+respawn_timer: 14              # ticks until tree respawns after being cut down
+deplete_timer: 45             # max ticks before next gather depletes (counts down while chopping)
 nest_chance: 256               # 1/256 chance for a bird's nest on each successful gather
 respawn_message: "A new oak sapling grows in its place."
 respawn_broadcast: "An {name} grows back."
@@ -366,21 +366,21 @@ drops:
     weight: 100
     depletes: true             # regular tree depletes on first successful gather
     message: "You get some logs."
-deplete_delay: 80
+respawn_timer: 80
 respawn_message: "A new tree grows in its place."
 respawn_broadcast: "A {name} grows back."
 ```
 
 #### Shared depletion explained
 
-When `shared_deplete > 0`, the tree has a shared despawn timer:
-- The timer starts at `shared_deplete` max when the first player begins chopping.
+When `deplete_timer > 0`, the tree has a shared despawn timer:
+- The timer starts at `deplete_timer` max when the first player begins chopping.
 - Each tick, if anyone is chopping, the timer counts down.
 - When the timer reaches 0, the NEXT successful gather depletes the tree.
 - If no one is chopping and the tree isn't depleted, the timer ticks back UP.
 - All players chopping the same tree are interrupted when it depletes.
 
-Use `shared_deplete` for trees. Use `depletes: true` on individual drops for rocks.
+Use `deplete_timer` for trees. Use `depletes: true` on individual drops for rocks.
 
 #### Bird's nests
 
@@ -970,6 +970,6 @@ description: "A dusty corridor. One of the wall stones looks slightly out of pla
 
 8. **Live editing works.** Room, item, mob, object, and behavior YAML files are read from disk on each access. Change a room description or dialog and it takes effect immediately — no restart needed.
 
-9. **Shared depletion vs per-drop depletion.** Use `shared_deplete` for trees — the timer counts down while being chopped and regens when left alone. Use `depletes: true` on individual drops for rocks — they deplete on first successful gather.
+9. **Shared depletion vs per-drop depletion.** Use `deplete_timer` for trees — the timer counts down while being chopped and regens when left alone. Use `depletes: true` on individual drops for rocks — they deplete on first successful gather.
 
 10. **Mob wander config goes in the room YAML**, not the mob definition. This lets the same `man` wander differently in different rooms.
-- 
cgit v1.2.3