mux package
mux is the built-in server API available to every Lua module. It is supplied
by the game server rather than loaded with require.
Subpackages
| Package | Description |
|---|---|
mux.error | Structured errors, checked error codes, and error-handling helpers. |
mux.config | Read-only access to scalar server configuration. |
mux.comsys | Trusted communication-channel management. |
mux.telnet | Telnet protocol state and capabilities. |
mux.session | Interactive flows and active player-session information. |
mux.text | Styled-text validation, formatting, and measurement helpers. |
mux.world | Database objects and their persistent state. |
Functions
The root mux module provides functions for common in-game operations that do
not yet belong to a larger subpackage.
| Function | Description |
|---|---|
mux.check_db | Checks and repairs the game database without notifying a player. |
mux.log | Appends a message to a named file under game/logs/. |
Availability and limits
Runtime database operations are unavailable during @lua/check. The Lua
sandbox does not expose filesystem, operating-system, debugger, FFI, coroutine,
or dynamic code-loading APIs. VM memory and persistent-state limits still apply
while using these functions.