aboutsummaryrefslogtreecommitdiff
path: root/internal/net
diff options
context:
space:
mode:
Diffstat (limited to 'internal/net')
-rw-r--r--internal/net/doc.go15
1 files changed, 15 insertions, 0 deletions
diff --git a/internal/net/doc.go b/internal/net/doc.go
new file mode 100644
index 0000000..13e7f71
--- /dev/null
+++ b/internal/net/doc.go
@@ -0,0 +1,15 @@
+// Package net provides transport-agnostic network connections, session
+// management, and a multi-listener server.
+//
+// The Conn interface abstracts TCP (telnet) and WebSocket connections,
+// handling IAC echo control for password suppression. The Session type
+// tracks connection state through the login flow (account name, password,
+// menu navigation, character selection, and in-game play).
+//
+// The Hub tracks which sessions are in which rooms, enabling room-scoped
+// messaging. The Server manages telnet, HTTP, and HTTPS listeners and
+// dispatches incoming input to the game handler.
+//
+// Session I/O helpers (Write, WriteLine, WriteLines) handle CRLF line
+// endings required by telnet clients.
+package net