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

---
 internal/world/doc.go | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 internal/world/doc.go

(limited to 'internal/world/doc.go')

diff --git a/internal/world/doc.go b/internal/world/doc.go
new file mode 100644
index 0000000..cc11535
--- /dev/null
+++ b/internal/world/doc.go
@@ -0,0 +1,18 @@
+// Package world manages rooms, exits, ground items, mob instances,
+// and object instance state for the game world.
+//
+// Rooms are loaded from YAML files on every access (live-editable). Exits
+// support conditional blocking via the action.Condition system. Ground
+// items have independent despawn timers and combat-loot reservations.
+//
+// Object instance state (ObjState) tracks per-instance properties:
+// depletion with regen timers, shared depletion for trees with countdown,
+// quality for fire objects, and wandering for fishing spots.
+//
+// MobDef and MobInstance cover mob definitions and runtime instances.
+// The MobStore manages YAML loading, instance seeding, and per-room
+// mob lists. Mobs wander via legal (unconditioned) room exits.
+//
+// WordPrefixMatch provides bidirectional prefix matching used by
+// commands and object lookups.
+package world
-- 
cgit v1.2.3