LegendMUD - User contributions [en]

GMCP Packages

2021-01-18T18:37:36Z

Stolve:

The following packages are available via [[GMCP]]. Some packages may only be requested from the MUD, others may only be broadcast from the MUD, and others may be requested or broadcast.

== Char ==
=== char.prompt ===
'''''Request and broadcast'''''

The char.prompt message includes all values available in the prompt.
This list can be seen in the PROMPT CODES help file.

The char.prompt package does not require any parameters and can
be sent an empty object as the request message.

Example: <code>{}</code>

=== char.status ===
'''''Request only'''''

The char.status message includes all values visible from the STATUS
command. This includes conditions, affects, and timers. If only one of
these sets of values is needed, consider using one of the char.status
sub packages.

The char.status package does not require any parameters and can
be sent an empty object as the request message.

Example: <code>{}</code>

=== char.status.conditions ===
'''''Request only'''''

The char.status.conditions message includes all of the conditions
as seen in the STATUS command.

The char.status.conditions package does not require any parameters and can
be sent an empty object as the request message.

Example: <code>{}</code>

=== char.status.affectedby ===
'''''Request only'''''

The char.status.affectedby message includes all of the affects
as seen in the STATUS command.

The char.status.affectedby package does not require any parameters and can
be sent an empty object as the request message.

Example: <code>{}</code>

=== char.status.timers ===
'''''Request only'''''

The char.status.timers message includes all of the timers
as seen in the STATUS command.

The char.status.timers package does not require any parameters and can
be sent an empty object as the request message.

Example: <code>{}</code>

=== char.offer ===
'''''Request only'''''

The char.offer message includes a list of all items as they would appear
in the OFFER command. This list includes the name of each item, as well as
their weight and rent.

In addition to the list of items, the message will also include the
total count, the total weight, and the total rent of items.

The char.offer package does not require any parameters and can
be sent an empty object as the request message.

Example: <code>{}</code>

== Room ==
=== room.info ===
'''''Request and broadcast'''''

The room.info messsage includes the name and description of the character's
current room. If the character is in the dark or can otherwise not see the
room name and description, the message will not contain the accurate name
and description. This message also includes the name of the area for the
current room.

The room.info package does not require any parameters and can be sent
an empty object as the request message.

Example: <code>{}</code>

== Group ==
=== group.info ===
'''''Request only'''''

The group.info message includes the information as seen in the GROUP
command. If the character is not in a group, it will not include any
information.

The group.info package does not require any parameters and can be sent
an empty object as the request message.

Example: <code>{}</code>

== Logging ==
=== logging.error ===
'''''Broadcast only'''''

The logging.error message includes information about the error that was
encountered while processing the GMCP request or broadcast.

GMCP

2021-01-18T18:36:39Z

Stolve:

== What is GMCP? ==
LegendMUD supports the Generic Mud Communication Protocol, or GMCP, to pass easily parsable information to your mudclient. GMCP gives clients and servers the ability to send messages that are invisible to the player. This allows for easy access to certain data from within scripts without the use of cumbersome or unreliable triggers.

While GMCP provides a quality of life improvement for players writing scripts, it will not provide players with any distinct advantage. Any information provided through GMCP will have the same precision and visibility as through the normal interface.

== Which Clients Support GMCP? ==
At the moment of writing, the following clients support GMCP:
* CMUD v3.22 and higher
* Mudlet v2.0 and higher
* TinTin++ v2.00.3 and higher
* Mushclient v4.59 and higher
* Tinyfugue - when compiled with --enable-gmcp flag

There may be other clients that support GMCP.

== How do I use GMCP? ==
The clients only provide the ability to ''use'' GMCP messaging. It is up to the player, however, to add triggers and other scripts to consume and request the information.

GMCP messages are formed of a package name and an optional JSON payload separated by a space. A list of the available packages can be found [[GMCP Packages|here]].

Normally, the mud client will handle the parsing and will provide the information in its native format to the scripts.
For exact details, you will need to look into the documentation of your mud client.

The following tutorials have been written for popular MUD clients:
* [[GMCP CMUD Tutorial]]
* [[GMCP Mudlet Tutorial]]
* [[GMCP TinTin++ Tutorial]]

These tutorials give examples specific to LegendMUD, if you are using a client that is not listed here, it might still be beneficial to view one or more of these tutorials to gain an understanding of how Legend sends GMCP messages.

== What GMCP Packages Does Legend Support? ==
The list of all available GMCP packages can be [[GMCP Packages|found here]].

GMCP Packages

2021-01-08T15:43:59Z

Stolve:

The following packages are available via [[GMCP]]. Some packages may only be requested from the MUD, others may only be broadcast from the MUD, and others may be requested or broadcast.

== Char ==
=== char.prompt ===
'''''Request and broadcast'''''

The char.prompt message includes all values available in the prompt.
This list can be seen in the PROMPT CODES help file.

The char.prompt package does not require any parameters and can
be sent an empty object as the request message.

Example: <code>{}</code>

=== char.status ===
'''''Request only'''''

The char.status message includes all values visible from the STATUS
command. This includes conditions, affects, and timers. If only one of
these sets of values is needed, consider using one of the char.status
sub packages.

The char.status package does not require any parameters and can
be sent an empty object as the request message.

Example: <code>{}</code>

=== char.status.conditions ===
'''''Request only'''''

The char.status.conditions message includes all of the conditions
as seen in the STATUS command.

The char.status.conditions package does not require any parameters and can
be sent an empty object as the request message.

Example: <code>{}</code>

=== char.status.affectedby ===
'''''Request only'''''

The char.status.affectedby message includes all of the affects
as seen in the STATUS command.

The char.status.affectedby package does not require any parameters and can
be sent an empty object as the request message.

Example: <code>{}</code>

=== char.status.timers ===
'''''Request only'''''

The char.status.timers message includes all of the timers
as seen in the STATUS command.

The char.status.timers package does not require any parameters and can
be sent an empty object as the request message.

Example: <code>{}</code>

== Room ==
=== room.info ===
'''''Request and broadcast'''''

The room.info messsage includes the name and description of the character's
current room. If the character is in the dark or can otherwise not see the
room name and description, the message will not contain the accurate name
and description. This message also includes the name of the area for the
current room.

The room.info package does not require any parameters and can be sent
an empty object as the request message.

Example: <code>{}</code>

== Group ==
=== group.info ===
'''''Request only'''''

The group.info message includes the information as seen in the GROUP
command. If the character is not in a group, it will not include any
information.

The group.info package does not require any parameters and can be sent
an empty object as the request message.

Example: <code>{}</code>

== Logging ==
=== logging.error ===
'''''Broadcast only'''''

The logging.error message includes information about the error that was
encountered while processing the GMCP request or broadcast.

GMCP CMUD Tutorial

2021-01-07T15:59:45Z

Stolve:

== Enabling GMCP ==
In CMUD you can enable [[GMCP]] via the preferences for your session.
Once a session is opened, open the preferences:

[[File:Gmcp-cmud-open-prefs.jpg|How to open preferences]]

In the preferences, open the Protocols tab and ensure the <code>GMCP Emulation</code> checkbox is checked. Additionally, list the LegendMUD packages you want to receive in the textbox below. A list of packages can be found [[GMCP Packages|here]].

[[File:Gmcp-cmud-enable.jpg|How to enable GMCP]]

== Receiving a GMCP message ==
Once GMCP is enabled, the MUD will begin sending GMCP messages.

There are two types of GMCP messages, broadcasts and requested messages.
Broadcast messages will happen automatically, while requested messages will only be sent by the MUD if the client requests them.
The full list of packages and their message types can be found [[GMCP Packages|here]].

CMUD automatically saves all data from GMCP messages in a global <code>%gmcp</code> variable.
For example, if you wanted to read the area name from the prompt, you can do this at any time, from anywhere via the following zScript:
%gmcp.char.prompt.an

Sometimes you need to be able to trigger off of a GMCP message. This can be done by creating a GMCP trigger.

Create a new trigger and use the package name in the pattern field.
Additionally, change the trigger type (noted in the screenshot below) to GMCP. The number field to the right of this dropdown can be ignored.

[[File:Gmcp-cmud-trigger.jpg|Creating a GMCP trigger in CMUD]]

You can also use pattern matching to trigger on multiple GMCP messages.
For example, you can set the pattern to <code>char.*</code> to trigger on ''any'' character related GMCP message.

== Sending a GMCP message ==
The MUD will not broadcast every message that is available. Some messages must be manually requested. Additionally, some broadcasted messages can also be requested if you need to refresh the data before the MUD would broadcast again.

The following script can be used to send a request to the MUD:
#SENDGMCP "Package.Subpackage" @Table

Where @Table is a normal CMUD database variable or string list with the data you want to send.
// As a database variable
$response = " "
#addkey $response client "CMUD"
#addkey $response version "3.22"
#SENDGMCP "core.hello" $response

// As a string list
$list = {core 1|char 1|room 1|comm 1}
#SENDGMCP "core.supports.set" $list

// With no data
#SENDGMCP "char.status" ""

GMCP Mudlet Tutorial

2021-01-07T15:59:43Z

Stolve:

== Enabling GMCP ==
In Mudlet you can enable [[GMCP]] via the Settings for your session.
Once a session is opened, open the Settings:

[[File:Gmcp-mudlet-open-prefs.jpg|How to open settings]]

In the settings, under the <code>Game Protocols</code> section, ensure the <code>Enable GMCP</code> checkbox is checked.

[[File:Gmcp-mudlet-enable.jpg|How to enable GMCP]]

== Receiving a GMCP message ==
Once GMCP is enabled, the MUD will begin sending GMCP messages.

There are two types of GMCP messages, broadcasts and requested messages.
Broadcast messages will happen automatically, while requested messages will only be sent by the MUD if the client requests them.
The full list of packages and their message types can be found [[GMCP Packages|here]].

Mudlet automatically saves all data from GMCP messages in a global <code>gmcp</code> variable.
For example, if you wanted to read the area name from the prompt, you can do this at any time, from anywhere via the following variable:
gmcp.char.prompt.an

For debugging purposes, please note that the ''echo'' function will not work with objects, only strings. If you try to ''echo(gmcp.char.prompt.an)'', it will work because that is a string for the Area Name.
If you try to ''echo(gmcp.char.prompt)'' however, it will not work because that is an object containing all of the prompt code values.
Instead, it is recommended to use the ''display'' function to print objects to the screen.

Sometimes you need to be able to trigger off of a GMCP message. This can be done by creating a GMCP script.

Create a new script (not a trigger) and give it a name. Enter the package name in the <code>Add User Defined Event Handler</code> field and hit the "plus" sign to add it. This package name must be prepended by <code>gmcp.</code>. For example, the <code>char.status</code> package would be added to the event handlers as <code>gmcp.char.status</code>. A full list of available packages can be found [[GMCP Packages|here]].

[[File:Gmcp-mudlet-trigger.jpg|Creating a GMCP trigger in Mudlet]]

You can also match partial packages to trigger on multiple GMCP messages.
For example, you can set the pattern to <code>gmcp.char</code> to trigger on ''any'' character related GMCP message.

== Sending a GMCP message ==
The MUD will not broadcast every message that is available. Some messages must be manually requested. Additionally, some broadcasted messages can also be requested if you need to refresh the data before the MUD would broadcast again.

The following script can be used to send a request to the MUD:
sendGMCP("char.prompt")

If you need to send additional parameters for the requested package, you can do so:
sendGMCP([[char.prompt {"additional": 1, "parameters": "hello"}]])

You can also use the following syntax:
sendGMCP("char.prompt"..yajl.to_string({"additional": 1, "parameters": "hello"})

Note that as of writing, none of the Legend packages take any parameters, required or optional.

GMCP TinTin++ Tutorial

2021-01-07T15:59:41Z

Stolve:

== Enabling GMCP ==
In order to enable [[GMCP]], you need to send a message to the MUD to let it know that the client supports it.
This is done by sending an <code>IAC DO GMCP</code> message when the MUD sends <code>IAC WILL GMCP</code>.

In TinTin++, this is done via the following script:
#EVENT {IAC WILL GMCP}
{
#SEND {\xFF\xFD\xC9};
}

Alternatively, it can be useful to store the hex codes as variables:
#VAR telnet[iac] \xFF;
#VAR telnet[do] \xFD;
#VAR telnet[sb] \xFA;
#VAR telnet[se] \xF0;
#VAR telnet[gmcp] \xC9;

#EVENT {IAC WILL GMCP}
{
#SEND {$gmcp[iac]$telnet[do]$telnet[gmcp]};
}

The other scripts in this tutorial will use those variables. Note that anywhere these variables are used, you can replace them with the hex code instead.

== Receiving a GMCP message ==
Once GMCP is enabled, the MUD will begin broadcasting GMCP messages.

There are two types of GMCP messages, broadcasts and requested messages.
Broadcast messages will happen automatically, while requested messages will only be sent by the MUD if the client requests them.
The full list of packages and their message types can be found [[GMCP Packages|here]].

To receive these messages, you must subscribe to GMCP events. This must be done for each package you want to receive messages for. A list of available packages can be found [[GMCP Packages|here]].

For example, if you wanted to receive the <code>room.info</code> messages, you would use the following script:
#EVENT {IAC SB GMCP room.info IAC SE}
{
#VAR roominfo {%0};
}

The <code>%0</code> parameter contains the data sent by the MUD. For convenience, it is recommended that you save this data in a <code>#VARIABLE</code> or <code>#LOCAL</code>.

== Sending a GMCP message ==
The MUD will not broadcast every message that is available. Some messages must be manually requested. Additionally, some broadcasted messages can also be requested if you need to refresh the data before the MUD would broadcast again.

The following script can be used to send a request to the MUD:
#SEND {$telnet[iac]$telnet[sb]$telnet[gmcp]<package_name> <message_data>$telnet[iac]$telnet[se]};

It may be easier to create an alias to make this task easier. Aliases can later be used from the input line as well as from other scripts.
#ALIAS {gmcp %1 %*}
{
#SEND {$telnet[iac]$telnet[sb]$telnet[gmcp]%1 %2$telnet[iac]$telnet[se];};
}

Usage: <code>gmcp room.info {}</code>

The following alias might also be useful if the package does not need any parameters provided:
#ALIAS {gmcp %1}
{
#SEND {$telnet[iac]$telnet[sb]$telnet[gmcp]%1$telnet[iac]$telnet[se];};
}

Usage: <code>gmcp room.info</code>

GMCP Mudlet Tutorial

2021-01-06T16:09:23Z

Stolve: Created page with "== Enabling GMCP == In Mudlet you can enable GMCP via the Settings for your session. Once a session is opened, open the Settings: File:Gmcp-mudlet-open-prefs.jpg|How to..."

== Enabling GMCP ==
In Mudlet you can enable [[GMCP]] via the Settings for your session.
Once a session is opened, open the Settings:

[[File:Gmcp-mudlet-open-prefs.jpg|How to open settings]]

In the settings, under the <code>Game Protocols</code> section, ensure the <code>Enable GMCP</code> checkbox is checked.

[[File:Gmcp-mudlet-enable.jpg|How to enable GMCP]]

== Receiving a GMCP message ==
Once GMCP is enabled, the MUD will begin broadcasting GMCP messages.
Mudlet automatically saves all data from GMCP messages in a global <code>gmcp</code> variable.

For example, if you wanted to read the area name from the prompt, you can do this at any time, from anywhere via the following variable:
gmcp.char.prompt.an

Sometimes you need to be able to trigger off of a GMCP message. This can be done by creating a GMCP script.

Create a new script (not a trigger) and give it a name. Enter the package name in the <code>Add User Defined Event Handler</code> field and hit the "plus" sign to add it. This package name must be prepended by <code>gmcp.</code>. For example, the <code>char.status</code> package would be added to the event handlers as <code>gmcp.char.status</code>. A full list of available packages can be found [[GMCP Packages|here]].

[[File:Gmcp-mudlet-trigger.jpg|Creating a GMCP trigger in Mudlet]]

You can also match partial packages to trigger on multiple GMCP messages.
For example, you can set the pattern to <code>gmcp.char</code> to trigger on ''any'' character related GMCP message.

== Sending a GMCP message ==
The MUD will not broadcast every message that is available. Some messages must be manually requested. Additionally, some broadcasted messages can also be requested if you need to refresh the data before the MUD would broadcast again.

The following script can be used to send a request to the MUD:
SendGMCP("char.prompt")

If you need to send additional parameters for the requested package, you can do so:
SendGMCP([[char.prompt {"additional": 1, "parameters": "hello"}]])

You can also use the following syntax:
SendGMCP("char.prompt"..yajl.to_string({"additional": 1, "parameters": "hello"})

Note that as of writing, none of the Legend packages take any parameters, required or optional.

File:Gmcp-mudlet-trigger.jpg

2021-01-06T16:02:23Z

Stolve: Screenshot showing how to create a GMCP trigger in Mudlet

Screenshot showing how to create a GMCP trigger in Mudlet

File:Gmcp-mudlet-open-prefs.jpg

2021-01-06T16:01:57Z

Stolve: Screenshot showing how to open settings in Mudlet

Screenshot showing how to open settings in Mudlet

File:Gmcp-mudlet-enable.jpg

2021-01-06T16:01:24Z

Stolve: Screenshot showing how to enable GMCP in Mudlet

Screenshot showing how to enable GMCP in Mudlet

GMCP

2021-01-06T15:34:31Z

Stolve: /* How do I use GMCP? */

GMCP Packages

2021-01-06T15:33:10Z

Stolve:

The following packages are available via [[GMCP]]. Some packages may only be requested from the MUD, others may only be broadcast from the MUD, and others may be requested or broadcast.

== Char ==
=== char.prompt ===
'''''Request and broadcast'''''

The char.prompt message includes all values available in the prompt.
This list can be seen in the PROMPT CODES help file.

The char.prompt package does not require any parameters and can
be sent an empty object as the request message.

Example: <code>{}</code>

=== char.offer ===
'''''Request only'''''

The char.offer message includes a list of all items as they would appear
in the OFFER command. This list includes the name of each item, as well as
their weight and rent.

In addition to the list of items, the message will also include the
total count, the total weight, and the total rent of items.

The char.offer package does not require any parameters and can
be sent an empty object as the request message.

Example: <code>{}</code>

=== char.status ===
'''''Request only'''''

The char.status message includes all values visible from the STATUS
command. This includes conditions, affects, and timers. If only one of
these sets of values is needed, consider using one of the char.status
sub packages.

The char.status package does not require any parameters and can
be sent an empty object as the request message.

Example: <code>{}</code>

=== char.status.conditions ===
'''''Request only'''''

The char.status.conditions message includes all of the conditions
as seen in the STATUS command.

The char.status.conditions package does not require any parameters and can
be sent an empty object as the request message.

Example: <code>{}</code>

=== char.status.affectedby ===
'''''Request only'''''

The char.status.affectedby message includes all of the affects
as seen in the STATUS command.

The char.status.affectedby package does not require any parameters and can
be sent an empty object as the request message.

Example: <code>{}</code>

=== char.status.timers ===
'''''Request only'''''

The char.status.timers message includes all of the timers
as seen in the STATUS command.

The char.status.timers package does not require any parameters and can
be sent an empty object as the request message.

Example: <code>{}</code>

== Room ==
=== room.info ===
'''''Request and broadcast'''''

The room.info messsage includes the name and description of the character's
current room. If the character is in the dark or can otherwise not see the
room name and description, the message will not contain the accurate name
and description. This message also includes the name of the area for the
current room.

The room.info package does not require any parameters and can be sent
an empty object as the request message.

Example: <code>{}</code>

== Group ==
=== group.info ===
'''''Request only'''''

The group.info message includes the information as seen in the GROUP
command. If the character is not in a group, it will not include any
information.

The group.info package does not require any parameters and can be sent
an empty object as the request message.

Example: <code>{}</code>

== Logging ==
=== logging.error ===
'''''Broadcast only'''''

The logging.error message includes information about the error that was
encountered while processing the GMCP request or broadcast.

GMCP Packages

2021-01-06T15:32:25Z

Stolve:

The following packages are available via GMCP. Some packages may only be requested from the MUD, others may only be broadcast from the MUD, and others may be requested or broadcast.

== Char ==
=== char.prompt ===
'''''Request and broadcast'''''

The char.prompt message includes all values available in the prompt.
This list can be seen in the PROMPT CODES help file.

The char.prompt package does not require any parameters and can
be sent an empty object as the request message.

Example: <code>{}</code>

=== char.offer ===
'''''Request only'''''

The char.offer message includes a list of all items as they would appear
in the OFFER command. This list includes the name of each item, as well as
their weight and rent.

In addition to the list of items, the message will also include the
total count, the total weight, and the total rent of items.

The char.offer package does not require any parameters and can
be sent an empty object as the request message.

Example: <code>{}</code>

=== char.status ===
'''''Request only'''''

The char.status message includes all values visible from the STATUS
command. This includes conditions, affects, and timers. If only one of
these sets of values is needed, consider using one of the char.status
sub packages.

The char.status package does not require any parameters and can
be sent an empty object as the request message.

Example: <code>{}</code>

=== char.status.conditions ===
'''''Request only'''''

The char.status.conditions message includes all of the conditions
as seen in the STATUS command.

The char.status.conditions package does not require any parameters and can
be sent an empty object as the request message.

Example: <code>{}</code>

=== char.status.affectedby ===
'''''Request only'''''

The char.status.affectedby message includes all of the affects
as seen in the STATUS command.

The char.status.affectedby package does not require any parameters and can
be sent an empty object as the request message.

Example: <code>{}</code>

=== char.status.timers ===
'''''Request only'''''

The char.status.timers message includes all of the timers
as seen in the STATUS command.

The char.status.timers package does not require any parameters and can
be sent an empty object as the request message.

Example: <code>{}</code>

== Room ==
=== room.info ===
'''''Request and broadcast'''''

The room.info messsage includes the name and description of the character's
current room. If the character is in the dark or can otherwise not see the
room name and description, the message will not contain the accurate name
and description. This message also includes the name of the area for the
current room.

The room.info package does not require any parameters and can be sent
an empty object as the request message.

Example: <code>{}</code>

== Group ==
=== group.info ===
'''''Request only'''''

The group.info message includes the information as seen in the GROUP
command. If the character is not in a group, it will not include any
information.

The group.info package does not require any parameters and can be sent
an empty object as the request message.

Example: <code>{}</code>

== Logging ==
=== logging.error ===
'''''Broadcast only'''''

The logging.error message includes information about the error that was
encountered while processing the GMCP request or broadcast.

GMCP TinTin++ Tutorial

2021-01-06T15:20:39Z

Stolve: /* Receiving a GMCP message */

== Enabling GMCP ==
In order to enable [[GMCP]], you need to send a message to the MUD to let it know that the client supports it.
This is done by sending an <code>IAC DO GMCP</code> message when the MUD sends <code>IAC WILL GMCP</code>.

In TinTin++, this is done via the following script:
#EVENT {IAC WILL GMCP}
{
#SEND {\xFF\xFD\xC9};
}

Alternatively, it can be useful to store the hex codes as variables:
#VAR telnet[iac] \xFF;
#VAR telnet[do] \xFD;
#VAR telnet[sb] \xFA;
#VAR telnet[se] \xF0;
#VAR telnet[gmcp] \xC9;

#EVENT {IAC WILL GMCP}
{
#SEND {$gmcp[iac]$telnet[do]$telnet[gmcp]};
}

The other scripts in this tutorial will use those variables. Note that anywhere these variables are used, you can replace them with the hex code instead.

== Receiving a GMCP message ==
Once GMCP is enabled, the MUD will begin broadcasting GMCP messages. To receive these messages, you must subscribe to GMCP events. This must be done for each package you want to receive messages for. A list of available packages can be found [[GMCP Packages|here]].

For example, if you wanted to receive the <code>room.info</code> messages, you would use the following script:
#EVENT {IAC SB GMCP room.info IAC SE}
{
#VAR roominfo {%0};
}

The <code>%0</code> parameter contains the data sent by the MUD. For convenience, it is recommended that you save this data in a <code>#VARIABLE</code> or <code>#LOCAL</code>.

== Sending a GMCP message ==
The MUD will not broadcast every message that is available. Some messages must be manually requested. Additionally, some broadcasted messages can also be requested if you need to refresh the data before the MUD would broadcast again.

The following script can be used to send a request to the MUD:
#SEND {$telnet[iac]$telnet[sb]$telnet[gmcp]<package_name> <message_data>$telnet[iac]$telnet[se]};

It may be easier to create an alias to make this task easier. Aliases can later be used from the input line as well as from other scripts.
#ALIAS {gmcp %1 %*}
{
#SEND {$telnet[iac]$telnet[sb]$telnet[gmcp]%1 %2$telnet[iac]$telnet[se];};
}

Usage: <code>gmcp room.info {}</code>

The following alias might also be useful if the package does not need any parameters provided:
#ALIAS {gmcp %1}
{
#SEND {$telnet[iac]$telnet[sb]$telnet[gmcp]%1$telnet[iac]$telnet[se];};
}

Usage: <code>gmcp room.info</code>

GMCP TinTin++ Tutorial

2021-01-06T15:20:07Z

Stolve: /* Enabling GMCP */

== Enabling GMCP ==
In order to enable [[GMCP]], you need to send a message to the MUD to let it know that the client supports it.
This is done by sending an <code>IAC DO GMCP</code> message when the MUD sends <code>IAC WILL GMCP</code>.

In TinTin++, this is done via the following script:
#EVENT {IAC WILL GMCP}
{
#SEND {\xFF\xFD\xC9};
}

Alternatively, it can be useful to store the hex codes as variables:
#VAR telnet[iac] \xFF;
#VAR telnet[do] \xFD;
#VAR telnet[sb] \xFA;
#VAR telnet[se] \xF0;
#VAR telnet[gmcp] \xC9;

#EVENT {IAC WILL GMCP}
{
#SEND {$gmcp[iac]$telnet[do]$telnet[gmcp]};
}

The other scripts in this tutorial will use those variables. Note that anywhere these variables are used, you can replace them with the hex code instead.

== Receiving a GMCP message ==
Once GMCP is enabled, the MUD will begin broadcasting GMCP messages. To receive these messages, you must subscribe to GMCP events. This must be done for each package you want to receive messages for.

For example, if you wanted to receive the <code>room.info</code> messages, you would use the following script:
#EVENT {IAC SB GMCP room.info IAC SE}
{
#VAR roominfo {%0};
}

The <code>%0</code> parameter contains the data sent by the MUD. For convenience, it is recommended that you save this data in a <code>#VARIABLE</code> or <code>#LOCAL</code>.

== Sending a GMCP message ==
The MUD will not broadcast every message that is available. Some messages must be manually requested. Additionally, some broadcasted messages can also be requested if you need to refresh the data before the MUD would broadcast again.

The following script can be used to send a request to the MUD:
#SEND {$telnet[iac]$telnet[sb]$telnet[gmcp]<package_name> <message_data>$telnet[iac]$telnet[se]};

It may be easier to create an alias to make this task easier. Aliases can later be used from the input line as well as from other scripts.
#ALIAS {gmcp %1 %*}
{
#SEND {$telnet[iac]$telnet[sb]$telnet[gmcp]%1 %2$telnet[iac]$telnet[se];};
}

Usage: <code>gmcp room.info {}</code>

The following alias might also be useful if the package does not need any parameters provided:
#ALIAS {gmcp %1}
{
#SEND {$telnet[iac]$telnet[sb]$telnet[gmcp]%1$telnet[iac]$telnet[se];};
}

Usage: <code>gmcp room.info</code>

GMCP CMUD Tutorial

2021-01-06T15:19:35Z

Stolve: /* Enabling GMCP */

== Enabling GMCP ==
In CMUD you can enable [[GMCP]] via the preferences for your session.
Once a session is opened, open the preferences:

[[File:Gmcp-cmud-open-prefs.jpg|How to open preferences]]

In the preferences, open the Protocols tab and ensure the <code>GMCP Emulation</code> checkbox is checked. Additionally, list the LegendMUD packages you want to receive in the textbox below. A list of packages can be found [[GMCP Packages|here]].

[[File:Gmcp-cmud-enable.jpg|How to enable GMCP]]

== Receiving a GMCP message ==
Once GMCP is enabled, the MUD will begin broadcasting GMCP messages.
CMUD automatically saves all data from GMCP messages in a global <code>%gmcp</code> variable.

For example, if you wanted to read the area name from the prompt, you can do this at any time, from anywhere via the following zScript:
%gmcp.char.prompt.an

Sometimes you need to be able to trigger off of a GMCP message. This can be done by creating a GMCP trigger.

Create a new trigger and use the package name in the pattern field.
Additionally, change the trigger type (noted in the screenshot below) to GMCP. The number field to the right of this dropdown can be ignored.

[[File:Gmcp-cmud-trigger.jpg|Creating a GMCP trigger in CMUD]]

You can also use pattern matching to trigger on multiple GMCP messages.
For example, you can set the pattern to <code>char.*</code> to trigger on ''any'' character related GMCP message.

== Sending a GMCP message ==
The MUD will not broadcast every message that is available. Some messages must be manually requested. Additionally, some broadcasted messages can also be requested if you need to refresh the data before the MUD would broadcast again.

The following script can be used to send a request to the MUD:
#SENDGMCP "Package.Subpackage" @Table

Where @Table is a normal CMUD database variable or string list with the data you want to send.
// As a database variable
$response = " "
#addkey $response client "CMUD"
#addkey $response version "3.22"
#SENDGMCP "core.hello" $response

// As a string list
$list = {core 1|char 1|room 1|comm 1}
#SENDGMCP "core.supports.set" $list

// With no data
#SENDGMCP "char.status" ""

GMCP CMUD Tutorial

2021-01-06T15:19:13Z

Stolve:

== Enabling GMCP ==
In CMUD you can enable GMCP via the preferences for your session.
Once a session is opened, open the preferences:

[[File:Gmcp-cmud-open-prefs.jpg|How to open preferences]]

In the preferences, open the Protocols tab and ensure the <code>GMCP Emulation</code> checkbox is checked. Additionally, list the LegendMUD packages you want to receive in the textbox below. A list of packages can be found [[GMCP Packages|here]].

[[File:Gmcp-cmud-enable.jpg|How to enable GMCP]]

== Receiving a GMCP message ==
Once GMCP is enabled, the MUD will begin broadcasting GMCP messages.
CMUD automatically saves all data from GMCP messages in a global <code>%gmcp</code> variable.

For example, if you wanted to read the area name from the prompt, you can do this at any time, from anywhere via the following zScript:
%gmcp.char.prompt.an

Sometimes you need to be able to trigger off of a GMCP message. This can be done by creating a GMCP trigger.

Create a new trigger and use the package name in the pattern field.
Additionally, change the trigger type (noted in the screenshot below) to GMCP. The number field to the right of this dropdown can be ignored.

[[File:Gmcp-cmud-trigger.jpg|Creating a GMCP trigger in CMUD]]

You can also use pattern matching to trigger on multiple GMCP messages.
For example, you can set the pattern to <code>char.*</code> to trigger on ''any'' character related GMCP message.

== Sending a GMCP message ==
The MUD will not broadcast every message that is available. Some messages must be manually requested. Additionally, some broadcasted messages can also be requested if you need to refresh the data before the MUD would broadcast again.

The following script can be used to send a request to the MUD:
#SENDGMCP "Package.Subpackage" @Table

Where @Table is a normal CMUD database variable or string list with the data you want to send.
// As a database variable
$response = " "
#addkey $response client "CMUD"
#addkey $response version "3.22"
#SENDGMCP "core.hello" $response

// As a string list
$list = {core 1|char 1|room 1|comm 1}
#SENDGMCP "core.supports.set" $list

// With no data
#SENDGMCP "char.status" ""

GMCP Packages

2021-01-06T15:17:53Z

Stolve: Created page with "The following packages are available via GMCP. Some packages may only be requested from the MUD, others may only be broadcast from the MUD, and others may be requested or broa..."

The following packages are available via GMCP. Some packages may only be
requested from the MUD, others may only be broadcast from the MUD, and
others may be requested or broadcast.

char.prompt - request and broadcast

The char.prompt message includes all values available in the prompt.
This list can be seen in the PROMPT CODES help file.

The char.prompt package does not require any parameters and can
be sent an empty object as the request message.

Example: {}

char.offer - request only

The char.offer message includes a list of all items as they would appear
in the OFFER command. This list includes the name of each item, as well as
their weight and rent.

In addition to the list of items, the message will also include the
total count, the total weight, and the total rent of items.

The char.offer package does not require any parameters and can
be sent an empty object as the request message.

Example: {}

char.status - request only

The char.status message includes all values visible from the STATUS
command. This includes conditions, affects, and timers. If only one of
these sets of values is needed, consider using one of the char.status
sub packages.

The char.status package does not require any parameters and can
be sent an empty object as the request message.

Example: {}

char.status.conditions - request only

The char.status.conditions message includes all of the conditions
as seen in the STATUS command.

The char.status.conditions package does not require any parameters and can
be sent an empty object as the request message.

Example: {}

char.status.affectedby - request only

The char.status.affectedby message includes all of the affects
as seen in the STATUS command.

The char.status.affectedby package does not require any parameters and can
be sent an empty object as the request message.

Example: {}

char.status.timers - request only

The char.status.timers message includes all of the timers
as seen in the STATUS command.

The char.status.timers package does not require any parameters and can
be sent an empty object as the request message.

Example: {}

room.info - request and broadcast

The room.info messsage includes the name and description of the character's
current room. If the character is in the dark or can otherwise not see the
room name and description, the message will not contain the accurate name
and description. This message also includes the name of the area for the
current room.

The room.info package does not require any parameters and can be sent
an empty object as the request message.

Example: {}

group.info - request only

The group.info message includes the information as seen in the GROUP
command. If the character is not in a group, it will not include any
information.

The group.info package does not require any parameters and can be sent
an empty object as the request message.

Example: {}

logging.error - broadcast only

The logging.error message includes information about the error that was
encountered while processing the GMCP request or broadcast.

See also: HELP GMCP, HELP PROMPT CODES

GMCP CMUD Tutorial

2021-01-06T15:10:56Z

Stolve: Created page with "== Enabling GMCP == In CMUD you can enable GMCP via the preferences for your session. Once a session is opened, open the preferences: File:Gmcp-cmud-open-prefs.jpg|How to o..."

== Enabling GMCP ==
In CMUD you can enable GMCP via the preferences for your session.
Once a session is opened, open the preferences:

[[File:Gmcp-cmud-open-prefs.jpg|How to open preferences]]

In the preferences, open the Protocols tab and ensure the <code>GMCP Emulation</code> checkbox is checked. Additionally, list the LegendMUD packages you want to receive in the textbox below.

[[File:Gmcp-cmud-enable.jpg|How to enable GMCP]]

== Receiving a GMCP message ==
Once GMCP is enabled, the MUD will begin broadcasting GMCP messages.
CMUD automatically saves all data from GMCP messages in a global <code>%gmcp</code> variable.

For example, if you wanted to read the area name from the prompt, you can do this at any time, from anywhere via the following zScript:
%gmcp.char.prompt.an

Sometimes you need to be able to trigger off of a GMCP message. This can be done by creating a GMCP trigger.

Create a new trigger and use the package name in the pattern field.
Additionally, change the trigger type (noted in the screenshot below) to GMCP. The number field to the right of this dropdown can be ignored.

[[File:Gmcp-cmud-trigger.jpg|Creating a GMCP trigger in CMUD]]

You can also use pattern matching to trigger on multiple GMCP messages.
For example, you can set the pattern to <code>char.*</code> to trigger on ''any'' character related GMCP message.

== Sending a GMCP message ==
The MUD will not broadcast every message that is available. Some messages must be manually requested. Additionally, some broadcasted messages can also be requested if you need to refresh the data before the MUD would broadcast again.

The following script can be used to send a request to the MUD:
#SENDGMCP "Package.Subpackage" @Table

Where @Table is a normal CMUD database variable or string list with the data you want to send.
// As a database variable
$response = " "
#addkey $response client "CMUD"
#addkey $response version "3.22"
#SENDGMCP "core.hello" $response

// As a string list
$list = {core 1|char 1|room 1|comm 1}
#SENDGMCP "core.supports.set" $list

// With no data
#SENDGMCP "char.status" ""

File:Gmcp-cmud-trigger.jpg

2021-01-06T14:53:39Z

Stolve: Screenshot for setting up a GMCP trigger in CMUD

Screenshot for setting up a GMCP trigger in CMUD

File:Gmcp-cmud-open-prefs.jpg

2021-01-06T14:53:01Z

Stolve: Screenshot for opening preferences in CMUD

Screenshot for opening preferences in CMUD

File:Gmcp-cmud-enable.jpg

2021-01-06T14:52:23Z

Stolve: Screenshot for enabling GMCP in CMUD

Screenshot for enabling GMCP in CMUD

GMCP TinTin++ Tutorial

2021-01-06T14:28:17Z

Stolve: Added TinTin++ GMCP tutorial

== Enabling GMCP ==
In order to enable GMCP, you need to send a message to the MUD to let it know that the client supports it.
This is done by sending an <code>IAC DO GMCP</code> message when the MUD sends <code>IAC WILL GMCP</code>.

In TinTin++, this is done via the following script:
#EVENT {IAC WILL GMCP}
{
#SEND {\xFF\xFD\xC9};
}

Alternatively, it can be useful to store the hex codes as variables:
#VAR telnet[iac] \xFF;
#VAR telnet[do] \xFD;
#VAR telnet[sb] \xFA;
#VAR telnet[se] \xF0;
#VAR telnet[gmcp] \xC9;

#EVENT {IAC WILL GMCP}
{
#SEND {$gmcp[iac]$telnet[do]$telnet[gmcp]};
}

The other scripts in this tutorial will use those variables. Note that anywhere these variables are used, you can replace them with the hex code instead.

== Receiving a GMCP message ==
Once GMCP is enabled, the MUD will begin broadcasting GMCP messages. To receive these messages, you must subscribe to GMCP events. This must be done for each package you want to receive messages for.

For example, if you wanted to receive the <code>room.info</code> messages, you would use the following script:
#EVENT {IAC SB GMCP room.info IAC SE}
{
#VAR roominfo {%0};
}

The <code>%0</code> parameter contains the data sent by the MUD. For convenience, it is recommended that you save this data in a <code>#VARIABLE</code> or <code>#LOCAL</code>.

== Sending a GMCP message ==
The MUD will not broadcast every message that is available. Some messages must be manually requested. Additionally, some broadcasted messages can also be requested if you need to refresh the data before the MUD would broadcast again.

The following script can be used to send a request to the MUD:
#SEND {$telnet[iac]$telnet[sb]$telnet[gmcp]<package_name> <message_data>$telnet[iac]$telnet[se]};

It may be easier to create an alias to make this task easier. Aliases can later be used from the input line as well as from other scripts.
#ALIAS {gmcp %1 %*}
{
#SEND {$telnet[iac]$telnet[sb]$telnet[gmcp]%1 %2$telnet[iac]$telnet[se];};
}

Usage: <code>gmcp room.info {}</code>

The following alias might also be useful if the package does not need any parameters provided:
#ALIAS {gmcp %1}
{
#SEND {$telnet[iac]$telnet[sb]$telnet[gmcp]%1$telnet[iac]$telnet[se];};
}

Usage: <code>gmcp room.info</code>

GMCP

2021-01-06T14:00:51Z

Stolve: Added basic GMCP summary

== What is GMCP? ==
LegendMUD supports the Generic Mud Communication Protocol, or GMCP, to pass easily parsable information to your mudclient. GMCP gives clients and servers the ability to send messages that are invisible to the player. This allows for easy access to certain data from within scripts without the use of cumbersome or unreliable triggers.

While GMCP provides a quality of life improvement for players writing scripts, it will not provide players with any distinct advantage. Any information provided through GMCP will have the same precision and visibility as through the normal interface.

== Which Clients Support GMCP? ==
At the moment of writing, the following clients support GMCP:
* CMUD v3.22 and higher
* Mudlet v2.0 and higher
* TinTin++ v2.00.3 and higher
* Mushclient v4.59 and higher
* Tinyfugue - when compiled with --enable-gmcp flag

There may be other clients that support GMCP.

== How do I use GMCP? ==
The clients only provide the ability to ''use'' GMCP messaging. It is up to the player, however, to add triggers and other scripts to consume and request the information.

GMCP messages are formed of a package name and an optional JSON payload separated by a space.
Normally, the mud client will handle the parsing and will provide the information in its native format to the scripts.
For exact details, you will need to look into the documentation of your mud client.

The following tutorials have been written for popular MUD clients:
* [[GMCP CMUD Tutorial]]
* [[GMCP Mudlet Tutorial]]
* [[GMCP TinTin++ Tutorial]]

These tutorials give examples specific to LegendMUD, if you are using a client that is not listed here, it might still be beneficial to view one or more of these tutorials to gain an understanding of how Legend sends GMCP messages.