szutilpack-cd2025/szutil_chatsocket
Aaron Suen d32a2c856c Build mod summary list automatically
Instead of maintaining the short description of each sub-mod
manually in a giant README file, distribute the short descriptions
into each relevant mod, and then build the README listings
automatically at deploy time.

This should:
- Make it harder to forget to add/remove mods in the list
- Prevent them from being out of alphabetical order
- Ensure each mod has a description for in-menu use
2023-06-20 07:30:35 -04:00
..
2023-06-12 20:40:14 -04:00
2023-06-20 07:30:35 -04:00

------------------------------------------------------------------------

This mod exposes a UNIX-domain socket for integrating arbitrary external
chat relay systems.  You can use OpenBSD's netcat (nc -U) to connect to
the console from a regular command line, though the preferred way is to
connect a bridge program to act as a client for both this socket and the
external chat system.

The communication protocol is simple: all in-game chat (including emote,
player join/leave, etc) messages will be broadcast to all connected
socket clients.  Each line of input text received (newline-terminated)
from any socket client will be displayed in-game and broadcast to all
other connected socket clients.

 *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *

WARNING: For this mod to work, LuaSockets must be installed, and this
mod must be listed in the "secure.trusted_mods" setting.

------------------------------------------------------------------------