View source for GMCP

GMCP, or Generic Mud Communication Protocol, is a method of sending [https://www.json.org/json-en.html JSON]-encoded data between a server and mud client outside the normal flow of test that is supported by many modern clients. It can be used for things such as sending a player's stats to the client so that it can include the data in some kind of GUI.

Flexible Survival does not yet have full native integration of GMCP, but has a pseudo implementation that can send data from the server to client, but not back again. It was also written with [[BeipMU]] in mind, so is currently tailored to that. Further changes may occur as the code develops.


== Supported packages ==

Currently, only a single package is supported, <code>beip.stats</code>. This can contain three blocks of data for different groups of stats. Note that in order to reduce network traffic, the protocol is designed to allow updating either a single stat or multiple stats at a time, so not all data will be provided with every update.

The general format of a block is:

<syntaxhighlight lang="json">
"<Group name>": {
    "background-color": <color string>,
    "values": {
        <data for value>
    }
}
</syntaxhighlight>

Values can contain numeric, string, or range data. Their format is:

<syntaxhighlight lang="json">
"<name of stat>": {
    "<type of value>": <value data>,
    "prefix-length": <numeric value>,
    "value-color": <color string>,
    "name-color": <color string>,
    "name-alignment": "[left|right|center]"
}
</syntaxhighlight>

The <code>prefix length</code> field is used to specify how many characters to ignore at the beginning of the name of the stat - this allows controlling the order that fields are displayed in by adding a prefix such as "10_" and setting the <code>prefix length</code> field to 3.

<code>value-color</code> and <code>name-color</code> can be used to specify the color in which to display the relevant field. Color strings may be an RGB hex code such as "#00ff00" for green, or an [https://i.stack.imgur.com/KTSQa.png ANSI colour code] in the form "ansi256(<number>)".

The <code>type of value</code> should be one of "int", "string", or "range". For "int" and "string" types, the <code>value data</code> field should be the number or string to be displayed. For "range" types, a block will be provided of the form:

<syntaxhighlight lang="json">
{
    "value": <numeric value>
    "min": <numeric value>
    "max": <numeric value>
    "bar-fill": <color string>
}
</syntaxhighlight>

All fields have a <code>prefix-length</code> of 3.


=== beip.stats player stats ===

* <code>00_Name</code>: String value, contains the character's name and a value-color corresponding to the character's gender.
* <code>10_Hit Points</code>: Range value, character's current health.
* <code>30_Level"</code>: String value, character's true level.
* <code>35_Mentored to</code>: String value, character's effective level.
* <code>40_Current XP</code>: String value, character's current experience points.
* <code>50_Rested XP</code>: String value, character's rested experience point value.
* <code>60_Cred Energy</code>: String value.
* <code>70_Hero Points</code>: String value.
* <code>80_Wounds</code>: String value.
* <code>90_Unread Notices</code>: String value, number of unread notices on the website.


=== beip.stats resources stats ===

* <code>10_Freecred</code>: String value.
* <code>20_Mako</code>: String value.
* <code>30_Reward Tokens</code>: String value.
* <code>40_Builder Nanites</code>: String value.
* <code>40_Patrol Points</code>: String value.
* <code>50_Battery Charge</code>: String value.


=== beip.stats combat stats ===

* <code>10_Difficulty Level</code>: String value.
* <code>20_Difficulty Quantity</code>: String value.
* <code>30_Primary Class</code>: String value, character's primary class.
* <code>40_Secondary Class</code>: String value, character's secondary class if in possession of a dual soul pendant.