evennia.server.portal.wire_formats.gmcp_standard

GMCP MUD Standards wire format (gmcp.mudstandards.org).

This implements the GMCP subprotocol from the MUD Standards WebSocket proposal (https://mudstandards.org/websocket/).

Per the standard:

  • BINARY frames contain regular ANSI in- and output (UTF-8 encoded)

  • TEXT frames contain UTF-8 encoded GMCP commands in the standard format: “Package.Name json_payload”

This is a good match for MUD clients that natively speak GMCP, such as Mudlet, as it maps directly to their existing GMCP handling without the extra JSON envelope layer.

class evennia.server.portal.wire_formats.gmcp_standard.GmcpStandardFormat[source]

Bases: WireFormat

GMCP-native wire format over WebSocket.

Wire format:

BINARY frames: Raw ANSI text (UTF-8), used for game text I/O. TEXT frames: GMCP commands in standard format

“Package.Name json_payload”

Text handling:

Outgoing text retains ANSI escape codes (no HTML conversion). Text is sent as BINARY frames.

OOB:

Supported via TEXT frames carrying GMCP messages. The GMCP format is: “Package.Name optional_json_payload”

name = 'gmcp.mudstandards.org'
supports_oob = True
decode_incoming(payload, is_binary, protocol_flags=None)[source]

Decode incoming WebSocket message.

BINARY frames are raw text input. TEXT frames are GMCP messages.

Parameters:

  • payload (bytes) – The raw frame payload.

  • is_binary (bool) – True for BINARY frames, False for TEXT.

  • protocol_flags (dict, optional) – Not used.

Returns:

dict or None – kwargs for data_in().

encode_default(cmdname, *args, protocol_flags=None, **kwargs)[source]

Encode an OOB command as a GMCP message in a TEXT frame.

Parameters:

  • cmdname (str) – The OOB command name.

  • *args – Command arguments.

  • protocol_flags (dict, optional) – Not used.

  • **kwargs – Command keyword arguments.

Returns:

tuple or None –

(gmcp_bytes, False) for TEXT frame, or None

if cmdname is “options”.