aboutsummaryrefslogtreecommitdiff
path: root/internal/config/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/config/doc.go
parenta19e6b6ab01670a5932308c7bd0e0e5eed8cbcad (diff)
downloadthehouseoficarus-1aba2bdd23aebed4032333e74aa553c40a31fcbd.tar.gz
refactor: added docs, split up some components in game package
Diffstat (limited to 'internal/config/doc.go')
-rw-r--r--internal/config/doc.go10
1 files changed, 10 insertions, 0 deletions
diff --git a/internal/config/doc.go b/internal/config/doc.go
new file mode 100644
index 0000000..f35aad3
--- /dev/null
+++ b/internal/config/doc.go
@@ -0,0 +1,10 @@
+// Package config loads YAML server configuration and provides sensible
+// defaults when no config file is present.
+//
+// Configuration covers three listener types: telnet (raw TCP), HTTP + WebSocket,
+// and HTTPS + WebSocket. Each has an enabled flag and port. The game section
+// controls display settings like max terminal width.
+//
+// Call Load(path) to read a YAML file merged with defaults, or Default()
+// for a configuration suitable for running with telnet on :4000.
+package config