Skip to content

Latest commit

 

History

History
18 lines (14 loc) · 927 Bytes

chatwire-protocol.md

File metadata and controls

18 lines (14 loc) · 927 Bytes

ChatWire protocol

SoftMod exposes one system-only command, /chatwire, and emits all custom machine data with one [CHATWIRE] tag. The payload following either is JSON encoded with Factorio's helpers.encode_string, which deflates and base64 encodes it.

The version 1 JSON envelope uses request IDs and distinguishes responses from events. Supported requests are hello, status, config, online, chat, whisper, player-level, and supporter.

Player names in whisper, player-level, and supporter are matched case-insensitively. Responses and events that include player names preserve their in-game capitalization. These requests still require an online player.

The existing player and moderator commands remain player-facing. In particular, /online still opens or prints the in-game player list and retains its moderator actions; only ChatWire's machine-side player-list transport uses /chatwire.