Rufus at 02:05, 29 July 2026

2026-07-29T02:05:28Z

Rufus at 16:48, 21 July 2026

2026-07-21T16:48:59Z

Show changes

Stolve at 18:36, 18 January 2021

2021-01-18T18:36:39Z

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

2021-01-06T15:34:31Z

How do I use GMCP?

Stolve: Added basic GMCP summary

2021-01-06T14:00:51Z

Added basic GMCP summary

New page

== 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.

@@ Line 39: / Line 39: @@
 * '''Package names are case-insensitive''' (<code>Char.Score</code> works), and must be dotted — at least <code>word.word</code>.
 * '''JSON keys are case-sensitive''', in both requests and replies.
-* Most packages take no arguments; any request body they receive is ignored. The exceptions are <code>object.info</code> and <code>char.inventory</code> (an <code>oid</code>), <code>help.topic</code> (<code>keywords</code>), and <code>char.journal.entry</code> (<code>vnum</code>).
+* Most packages take no arguments; any request body they receive is ignored. The exceptions are <code>object.info</code> and <code>char.inventory</code> (an <code>oid</code>), <code>help.topic</code> (<code>keywords</code>), <code>char.journal.entry</code> (<code>vnum</code>), and <code>char.skills.query</code> (a <code>slot</code>).
 * Requests are size-capped: package name up to 49 characters, JSON body up to 399 characters.
 * A malformed request, unknown package, or invalid JSON gets a '''<code>logging.error</code>''' reply (see §7) rather than silence.
@@ Line 416: / Line 416: @@
 <code>known</code> is the trained tier count, '''not''' a percentage.
 === 4.5 Magic: spells and words ===

← Older revision		Revision as of 18:36, 18 January 2021
Line 28:		Line 28:

	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.		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]].

@@ Line 17: / Line 17: @@
 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.
+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.

GMCP - Revision history

Rufus at 02:05, 29 July 2026

Rufus at 16:48, 21 July 2026

Stolve at 18:36, 18 January 2021

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

Stolve: Added basic GMCP summary