aboutsummaryrefslogtreecommitdiff
path: root/internal/object/doc.go
diff options
context:
space:
mode:
Diffstat (limited to 'internal/object/doc.go')
-rw-r--r--internal/object/doc.go14
1 files changed, 14 insertions, 0 deletions
diff --git a/internal/object/doc.go b/internal/object/doc.go
new file mode 100644
index 0000000..89f6db9
--- /dev/null
+++ b/internal/object/doc.go
@@ -0,0 +1,14 @@
+// Package object defines item and object definitions with their YAML-backed
+// loading stores.
+//
+// ItemDef covers all game items: equipment stats, weapon types, tool
+// properties (tool_type, tool_speed for gathering/firemaking), firemaking
+// fields (burn_ticks, fire_level, fire_xp), and stackable/quality metadata.
+//
+// ObjectDef covers interactive world objects: their behavior reference,
+// hidden flag for unlisted-but-interactable objects, in-room description
+// overrides, removal items, and arbitrary props.
+//
+// ItemStore and ObjectStore load definitions from YAML files in the
+// data/items/ and data/objects/ directories, caching results in memory.
+package object