aboutsummaryrefslogtreecommitdiff
path: root/internal/engine
diff options
context:
space:
mode:
Diffstat (limited to 'internal/engine')
-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