.: Help for gmcp

GMCP (Generic MUD Communication Protocol) is a telnet sub-negotiation protocol that allows the server to send structured JSON data to your client alongside normal text output. Clients that support GMCP can use this data to build custom UIs, maps, and status displays.

The server sends GMCP data automatically as game state changes. Clients may also request specific payloads by name.

Top-Level Payloads:

  Char         - Character information, stats, inventory, and status
                 See help gmcp-char

  Comm.Channel - In-game communication messages (say, party, broadcast, whisper)
                 See help gmcp-comm

  Game         - Server information and online player list
                 See help gmcp-game

  Gametime     - In-game calendar and time-of-day data
                 See help gmcp-gametime

  Party        - Party membership, roles, and member vitals
                 See help gmcp-party

  Room.Info    - Current room details, exits, and contents
                 See help gmcp-room

  World.Map    - Snapshot of all rooms the player has visited
                 See help gmcp-world

  Help         - Help content delivered over GMCP (used by the web client)
                 See help gmcp-help

  Client.GUI   - Mudlet UI package installation and update instructions
  Client.Map   - Mudlet mapper package URL
  External.Discord.Info   - Discord Rich Presence application identity
  External.Discord.Status - Discord Rich Presence status update

Notes:
- GMCP is negotiated automatically over telnet. Web client connections have GMCP enabled by default.
- Clients declare which modules they support via Core.Supports.Set.
- All payloads are JSON objects unless otherwise noted.

See also: help client, help gmcp-char, help gmcp-room, help gmcp-party