aboutsummaryrefslogtreecommitdiff
path: root/internal/player/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/player/doc.go
parenta19e6b6ab01670a5932308c7bd0e0e5eed8cbcad (diff)
downloadthehouseoficarus-1aba2bdd23aebed4032333e74aa553c40a31fcbd.tar.gz
refactor: added docs, split up some components in game package
Diffstat (limited to 'internal/player/doc.go')
-rw-r--r--internal/player/doc.go14
1 files changed, 14 insertions, 0 deletions
diff --git a/internal/player/doc.go b/internal/player/doc.go
new file mode 100644
index 0000000..a163bd7
--- /dev/null
+++ b/internal/player/doc.go
@@ -0,0 +1,14 @@
+// Package player defines character data, skills, equipment, inventory,
+// and account management for the game.
+//
+// The Player struct is the full character sheet: 23 skills with RSC-style
+// XP progression, 28-slot inventory, 11-slot equipment, combat level
+// calculation, and death mechanics.
+//
+// Accounts store authentication (salted sha256 passwords), character lists,
+// and command aliases. Validation functions enforce name and password rules.
+// The AccountStore manages persistence to YAML files under data/players/.
+//
+// Player options (15 settings) support bool, string, and int types with
+// defined defaults and valid values.
+package player