aboutsummaryrefslogtreecommitdiff
path: root/internal/engine/doc.go
diff options
context:
space:
mode:
authorhistoria <[not public]>2026-06-14 21:07:26 -0400
committerhistoria <[not public]>2026-06-14 21:07:26 -0400
commit1aba2bdd23aebed4032333e74aa553c40a31fcbd (patch)
treec004f4c2a139df5c3cf4029b2611bdfa09b40f86 /internal/engine/doc.go
parenta19e6b6ab01670a5932308c7bd0e0e5eed8cbcad (diff)
downloadthehouseoficarus-1aba2bdd23aebed4032333e74aa553c40a31fcbd.tar.gz
refactor: added docs, split up some components in game package
Diffstat (limited to 'internal/engine/doc.go')
-rw-r--r--internal/engine/doc.go11
1 files changed, 11 insertions, 0 deletions
diff --git a/internal/engine/doc.go b/internal/engine/doc.go
new file mode 100644
index 0000000..0ce25bd
--- /dev/null
+++ b/internal/engine/doc.go
@@ -0,0 +1,11 @@
+// Package engine provides a tick scheduler that drives all time-based
+// world simulation.
+//
+// The Engine runs on a 600ms interval. Subscribers register callbacks with
+// a tick interval (1 = every tick, N = every Nth tick). Callbacks return
+// true to remain subscribed or false to auto-unsubscribe.
+//
+// The main game loop subscribes a single callback that advances combat,
+// regeneration, wandering, woodcutting depletion, fire decay, and player
+// actions all on the same tick beat.
+package engine