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

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

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