Home
  • Home
  • About
    • Features
    • History
  • PlayPlay
  • Community
    • Discord
    • Elvenrunes
    • Links
    • Interviews
    • Wiki
  • News
    • War
    • Game News
    • Web News
  • Resources
    • Newcomers
    • Help
    • Rules
    • Dictionary
    • Boards
    • Download
    • Restricted
  • Search

MUME Help

Index: A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

GMCP MUME.CLIENT


These are the messages in the GMCP MUME.Client module.

Sent by server

MUME.Client.CancelEdit

  • Sent in response to a client's MUME.Client.CancelEdit message.
  • Message body is an object with these keys:
    id (optional) If the client's MUME.Client.CancelEdit contained a non-negative id, this is that identifier.
    result Either true on a successful cancel; or an error string on error.

MUME.Client.Edit

  • Sent as the player wants to edit a text message.
  • The body is an object with these keys:
    id a number identifying this edit session
    title (optional) a string with the description of the text
    text a string containing the text that should be edited
  • The client is expected to (at some point) respond using one of MUME.Client.Write or MUME.Client.CancelEdit (see below).

MUME.Client.Error

  • Sent on (some) protocol errors.
  • Message body is an object with a single message key whose value is a string containing an error message.

MUME.Client.View

  • Sent as the player wants to view a text message.
  • The body is an object with these keys:
    title (optional) a string with the description of the text
    text a string containing the text that should be viewed

MUME.Client.Write

  • Sent in response to a client's MUME.Client.Write message.
  • Message body is an object with these keys:
    id (optional) If the client's MUME.Client.Write contained a non-negative id, this is that identifier.
    result Either true on a successful write; or an error string on error.

Sent by client

MUME.Client.CancelEdit

  • This message is used to cancel an edit session initiated from a server's MUME.Client.Edit message.
  • Message body is an object with a single id, which must match that of the MUME.Client.Edit message.

MUME.Client.Write

  • This message is used to finalize an edit session initiated from a server's MUME.Client.Edit message.
  • Message body is an object with these keys:
    id the number from the MUME.Client.Edit message
    text a string containing the new text
  • The text string can only contain a subset of all Unicode characters.
    • Today, only those in the ISO 8859-1 character set, except NUL, are allowed.
    • This is subject to change.
  • The text may not be arbitrariliy long.
    • The entire GMCP message may at most contain 200 kB of data (subject to change).
    • Trying to exceed this message size will generate a MUME.Client.Error response.
  • Unless a MUME.Client.Error message was triggered, the server will response with a MUME.Client.Write of its own; see above.

MUME.Client.XML

  • Sent to change XML settings.
  • Message body is an object with these optional keys:
    enable true or false to enable or disable XML mode
    silent true or false to make XML mode change without sending an <xml> or </xml> message
    gratuitous-output true or false to enable or disable always sending descriptions regardless of change spam settings; in that case, encloses output in a <gratuitous> XML tag

Generated on Fri Apr 25 14:34:51 2025

What is MUME?

MUME, Multi-Users in Middle-earth, is a multiplayer text-based online game based upon J. R. R. Tolkien’s Middle-earth during the epic wars of the late Third Age between the forces of the Dark Lord and the armies of the Free peoples. MUME is completely at no cost and has been continuously running, expanded, and remastered by a community of volunteers since 1991.

Ready to explore?
Play Now