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/object/doc.go | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
 create mode 100644 internal/object/doc.go

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

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
-- 
cgit v1.2.3