MUME Help
MPI, MUME CLIENT PROTOCOL, PDU
The MUME client protocol is what
clients use to communicates
with MUME.
The protocol builds on Telnet (RFC 854) over TCP (or, optionally, TLS over TCP), with the following Telnet options supported:
- Echo RFC 857
- Suppress Go Ahead RFC 858
- Window Size RFC 1073
- Terminal Type RFC 1091
- Charset RFC 2066
- Mud Server Status Protocol — https://tintin.mudhalla.net/protocols/mssp/
<start> <command> <length>
<newline> <data>
.
<start> is the MPI
(MUME Protocol Isomething) start
sequence ~$#E
. The MPI must
follow a newline.
<command>
is one of the following letters:
-
I
identify for remote editing and viewing (from client) -
E
edit (to/from client) -
V
view (to client) -
P
prompt settings (from client) -
X
XML settings (from client)
<newline> is a single newline, ASCII 10.
The I command
The I command takes no arguments:
~$#EI
The E command
The E command involves several different messages. One of these is sent by the server, and the other two are sent by the client.
The E command sent by the server
When requesting that the client begin a new editing session, the server sends the following:
- MPI init string.
-
The character
E
. - The length of the remainder of the message in bytes.
- A newline character.
-
The character
M
. - A session identifier, consisting of a string of digits.
- A newline character.
- The description of the session. (This is free-form text, terminated by exactly one newline).
- The initial contents of the editing session (which may or may not end with a newline).
The E command sent by the client
The client may end an active editing session in one of two ways: by uploading the text generated by the editor, or by canceling the message.Here's what the "cancel" message looks like:
- MPI init string.
-
The character
E
. - The length of the message.
- A newline character.
-
The character
C
- The session identifier, represented by a string of digits.
- A newline character.
- MPI init string.
-
The character
E
. - The length of the message.
- A newline character.
-
The character
E
. - The session identifier.
- A newline character.
- The edited text.
The V command
TheV
(or view)
command is even simpler. It consists of one message, from server to
client:
- MPI init string.
-
The character
V
. - Length in bytes.
- A newline character.
- Text to be displayed with the pager.
Remote editing (E & V commands) in the protocol stack
MUME processes the Telnet IAC sequences before the received MUME Protocol data and escapes them in the sent data. In other words, the MUME protocol stands on top of the Telnet layer and not the other way around.
The P command
TheP
command accepts a number of prompt-related flags:
-
G
makes MUME send the Telnet IAC GA (go ahead) sequence after each prompt. Enable this if your MUD client is slow to display prompts. -
U
prevents MUME from sending repeated prompts. -
A
makes MUME send all prompts
G
and the final newline.
~$#EP2 G
The X command
TheX
command enables or disables
XML mode. It is a
variable-length command, with a mode for the first character and options as
following characters.
Modes:
-
0
disables XML mode -
1
enables XML mode -
2
disables XML mode without sending</xml>
-
3
enables XML mode without sending<xml>
-
G
enables gratuitous output until disconnected. In this mode, descriptions are sent without regard for brief/spam mode, but those that would have been hidden by brief/spam are wrapped in an extra<gratuitous>
tag.
~$#EX2 1GExample 2:
~$#EX1 3Credits: The documentation of the E and V commands was contributed by Kron.
See also: | XML, "LOCAL EDITOR", TLS |
Generated on Tue Apr 13 06:56:29 2021