aboutsummaryrefslogtreecommitdiff
path: root/internal/config/doc.go
blob: f35aad30e3a27935ee9edec4cf0b2adee93e5271 (plain)
1
2
3
4
5
6
7
8
9
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