diff options
Diffstat (limited to 'internal/config')
| -rw-r--r-- | internal/config/doc.go | 10 |
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 |