GMCP - Revision history

Gesslar: moving TOC to right right

2024-02-19T04:14:25Z

moving TOC to right right

Gesslar: /* Vitals */ fixing values for Char.Vitals

2024-02-19T04:11:17Z

Vitals: fixing values for Char.Vitals

Gesslar: /* Status */ fixing to be json instead of lua

2023-02-21T19:25:53Z

Status: fixing to be json instead of lua

Gesslar: /* StatusVars */ fixing to be json instead of Lua

2023-02-21T19:25:14Z

StatusVars: fixing to be json instead of Lua

Gesslar: /* Buffs */ updates to buffs and debuffs GMCP messages

2023-01-04T00:33:47Z

Buffs: updates to buffs and debuffs GMCP messages

Gesslar: Protected "GMCP": This spec is official and not subject to player revision. ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

2022-10-10T20:32:13Z

Protected "GMCP": This spec is official and not subject to player revision. ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

Gesslar: adding buffs/debuffs information

2022-10-10T20:25:28Z

adding buffs/debuffs information

Gesslar: Update to Char.StatusVars and Char.Status messages.

2022-04-26T22:48:33Z

Update to Char.StatusVars and Char.Status messages.

Gesslar: /* Status */ clarifying when Char.Status is sent

2021-11-25T03:57:59Z

Status: clarifying when Char.Status is sent

Gesslar: Updating values for Char.StatusVars and Char.Status

2021-11-25T03:56:44Z

Updating values for Char.StatusVars and Char.Status

@@ Line 1: / Line 1: @@
-== Client ==
+{{TOC right}}
-=== Char ===
+===Char===
-==== Buffs ====
+====Buffs====
-===== List =====
+===== List=====
-* Requests a list of buffs currently applied to a character
+*Requests a list of buffs currently applied to a character
-* No accompanying message payload
+*No accompanying message payload
 Example:<pre>
@@ Line 14: / Line 15: @@
 </pre>
-==== Debuffs ====
+====Debuffs====
-===== List =====
+===== List=====
-* Requests a list of debuffs currently applied to a character
+*Requests a list of debuffs currently applied to a character
-* No accompanying message payload
+*No accompanying message payload
 Example:<pre>
@@ Line 25: / Line 26: @@
 </pre>
-=== Core ===
+===Core===
 ==== Hello ====
-* Sends information about the MUD client and its version.
+*Sends information about the MUD client and its version.
-* May only be sent before successful login.
+*May only be sent before successful login.
 Example:
@@ Line 37: / Line 38: @@
 </pre>
-==== Ping ====
+====Ping====
-* Ensures server is listening and GMCP is enabled.
+*Ensures server is listening and GMCP is enabled.
-* Message body is a number which indicates average ping time from previous requests, if available.
+*Message body is a number which indicates average ping time from previous requests, if available.
 * Causes server to reply with a Core.Ping message in response.
 Example:
@@ Line 46: / Line 47: @@
 </pre>
-==== Supports ====
+====Supports====
-===== Set =====
+=====Set=====
-* Notifies the server about packages supported by the client.
+*Notifies the server about packages supported by the client.
-* If another Core.Supports.* package has been received earlier, the list is deleted and replaced with the new one.
+*If another Core.Supports.* package has been received earlier, the list is deleted and replaced with the new one.
-* Message body is an array of strings, each consisting of the module name and version, separated by space.
+*Message body is an array of strings, each consisting of the module name and version, separated by space.
-* Module version is a positive non-zero integer.
+*Module version is a positive non-zero integer.
-* Most client implementations will only need to send Set once and won't need Add/Remove; exceptions are module implementations provided by plug-ins.
+*Most client implementations will only need to send Set once and won't need Add/Remove; exceptions are module implementations provided by plug-ins.
 Example:
 <pre>
 Core.Supports.Set [ "Char 1", "Char.Skills 1", "Char.Items 1" ]
 </pre>
-===== Add =====
+=====Add=====
-* Similar to Core.Supports.Set, but appends the supported module list to the one sent earlier.
+*Similar to Core.Supports.Set, but appends the supported module list to the one sent earlier.
-* If no list was sent yet, the behaviour is identical to Core.Supports.Set.
+*If no list was sent yet, the behaviour is identical to Core.Supports.Set.
-* If the list includes module names that were already included earlier, the new version number takes precedence over the previously sent one, even if the newly sent number is lower.
+*If the list includes module names that were already included earlier, the new version number takes precedence over the previously sent one, even if the newly sent number is lower.
-* Message body format is identical to that of Core.Supports.Set.
+*Message body format is identical to that of Core.Supports.Set.
 Example:
 <pre>
@@ Line 67: / Line 68: @@
 </pre>
-===== Remove =====
+=====Remove=====
-* Removes specified modules from the list of supported modules.
+*Removes specified modules from the list of supported modules.
-* Message body format is similar to Core.Supports.Set, except that module version numbers are optional and ignored if given.
+*Message body format is similar to Core.Supports.Set, except that module version numbers are optional and ignored if given.
 Example:
 <pre>
@@ Line 75: / Line 76: @@
 </pre>
-== Server ==
+==Server==
-=== Core ===
+===Core===
-==== Goodbye ====
+====Goodbye====
-* Sent by server immediately before terminating a connection.
+*Sent by server immediately before terminating a connection.
-* Message body is a string to be shown to the user - it can explain the reason for the disconnect.
+*Message body is a string to be shown to the user - it can explain the reason for the disconnect.
-−
+*
 Example:
 <pre>
@@ Line 89: / Line 90: @@
 </pre>
-==== Ping ====
+====Ping====
 * Sent in reply to Core.Ping from the client.
-* No message body.
+*No message body.
 Example:
 <pre>
@@ Line 97: / Line 98: @@
 </pre>
-=== Char ===
+===Char===
-==== Afflictions====
+====Afflictions====
 Supported afflictions:
 *blind
@@ Line 106: / Line 107: @@
 *mute
 * stun
-=====Add =====
+=====Add=====
 *Sent by the server when a new affliction is added to the character.
 *Message is a string that is the affliction which has been added.
@@ Line 124: / Line 125: @@
 ===Buffs===
-====Add====
+==== Add====
 *Sent by the server when a new temporary buff is applied to the character
@@ Line 138: / Line 139: @@
 </pre>
-==== Remove====
+====Remove====
 *Sent by the server when a temporary buff is removed from the character
@@ Line 168: / Line 169: @@
 ===Debuffs===
-====Add====
+==== Add====
 *Sent by the server when a new temporary debuff is applied to the character
@@ Line 182: / Line 183: @@
 </pre>
-==== Remove====
+====Remove====
 *Sent by the server when a temporary debuff is removed from the character
@@ Line 207: / Line 208: @@
 </pre>
-====StatusVars====
+====StatusVars ====
-*Sent by server after a successful login.
+* Sent by server after a successful login.
 *Contains a list of names of character status variables (level, race, etc) and their display captions.
 *Message body is an object with keys containing the names of the status variables and values containing the captions to be displayed to the user.
@@ Line 249: / Line 250: @@
 </pre>
-====Status ====
+====Status====
-* Sent by server immediately after the initial Char.StatusVars message and once every [[heartbeat]] thereafter.
+*Sent by server immediately after the initial Char.StatusVars message and once every [[heartbeat]] thereafter.
 *Contains the values of character status variables (level, race, etc).
 *The full list of variables is only sent with the initial message, subsequent messages only contain changed variables.
@@ Line 291: / Line 292: @@
 }</pre>
-====Vitals====
+====Vitals ====
-*Sent by server whenever a prompt is displayed to the player and whenever the character's vitals change.
+* Sent by server whenever a prompt is displayed to the player and whenever the character's vitals change.
-*Contains basic information about character's vitality (hp, sp, ep).
+* Contains basic information about character's vitality (hp, sp, ep).
 *Message body is an object containing key-value pairs corresponding to character attributes.
 *Each variable is also included in a string in the format name: cur/max.

@@ Line 299: / Line 299: @@
 <pre>
 Char.Vitals {
-     "hp" : 100,
+     "hp" : "100",
-     "sp" : 100,
+     "sp" : "100",
-     "ep" : 100,
+     "ep" : "100",
-     "maxhp" : 200,
+     "maxhp" : "200",
-     "maxsp" : 200,
+     "maxsp" : "200",
-     "maxep" : 200,
+     "maxep" : "200",
      "string" : "HP: 100/200 SP: 100/200 EP: 100/200"
+}
 </pre>

@@ Line 257: / Line 257: @@
 <pre>
 Char.Status {
-   age = "510",
+   "age": "510",
-   bank = "314660",
+   "bank": "314660",
-   capacity = "4792",
+   "capacity": "4792",
-   dead = "0",
+   "dead": "0",
-   expertise = "152287",
+   "expertise": "152287",
-   foe_foe_name = "none",
+   "foe_foe_name": "none",
-   foe_health = "0",
+   "foe_health": "0",
-   foe_max_health = "100",
+   "foe_max_health": "100",
-   foe_name = "none",
+   "foe_name": "none",
-   fullname = "Karahd the Magocrat",
+   "fullname": "Karahd the Magocrat",
-   gender = "female",
+   "gender": "female",
-   guild = "mage",
+   "guild": "mage",
-   guild_level = "12",
+   "guild_level": "12",
-   harmonic = "chaos",
+   "harmonic": "chaos",
-   hb = "0",
+   "hb": "0",
-   heritage = "scholar",
+   "heritage": "scholar",
-   hlevel = "0",
+   "hlevel": "0",
-   inactive = "0",
+   "inactive": "0",
-   inactive_type = "none",
+   "inactive_type": "none",
-   invis = "0",
+   "invis": "0",
-   level = "12",
+   "level": "12",
-   lodge = "otter",
+   "lodge": "otter",
-   lodge_level = "11",
+   "lodge_level": "11",
-   max_capacity = "5000",
+   "max_capacity": "5000",
-   morality = "good",
+   "morality": "good",
-   name = "Karahd",
+   "name": "Karahd",
-   primary_axis = "harmonic",
+   "primary_axis": "harmonic",
-   race = "elf",
+   "race": "elf",
-   session_login = "1651011752",
+   "session_login": "1651011752",
-   tnl = "100",
+   "tnl": "100",
-   tummy = "0",
+   "tummy": "0",
-   xp = "10056981"
+   "xp": "10056981"
 }</pre>
 ====Vitals====

@@ Line 214: / Line 214: @@
 <pre>
 Char.StatusVars {
-   age = "Age",
+   "age": "Age",
-   bank = "Bank balance",
+   "bank": "Bank balance",
-   capacity = "Capacity",
+   "capacity": "Capacity",
-   dead = "Dead",
+   "dead": "Dead",
-   expertise = "Expertise",
+   "expertise": "Expertise",
-   foe_foe_name = "Foe's target",
+   "foe_foe_name": "Foe's target",
-   foe_health = "Foe health",
+   "foe_health": "Foe health",
-   foe_max_health = "Foe max health",
+   "foe_max_health": "Foe max health",
-   foe_name = "Current foe",
+   "foe_name": "Current foe",
-   fullname = "Full name",
+   "fullname": "Full name",
-   gender = "Gender",
+   "gender": "Gender",
-   guild = "Guild",
+   "guild": "Guild",
-   guild_level = "Guild level",
+   "guild_level": "Guild level",
-   harmonic = "Harmonic",
+   "harmonic": "Harmonic",
-   hb = "Heal bank",
+   "hb": "Heal bank",
-   heritage = "Heritage",
+   "heritage": "Heritage",
-   hlevel = "Heritage level",
+   "hlevel": "Heritage level",
-   inactive = "Inactive",
+   "inactive": "Inactive",
-   inactive_type = "Inactive type",
+   "inactive_type": "Inactive type",
-   invis = "Invisible",
+   "invis": "Invisible",
-   level = "Level",
+   "level": "Level",
-   lodge = "Lodge",
+   "lodge": "Lodge",
-   lodge_level = "Lodge level",
+   "lodge_level": "Lodge level",
-   max_capacity = "Max capacity",
+   "max_capacity": "Max capacity",
-   morality = "Morality",
+   "morality": "Morality",
-   name = "Name",
+   "name": "Name",
-   primary_axis = "Primary axis",
+   "primary_axis": "Primary axis",
-   race = "Race",
+   "race": "Race",
-   session_login = "Logged in",
+   "session_login": "Logged in",
-   tnl = "To next level",
+   "tnl": "To next level",
-   tummy = "Fullness",
+   "tummy": "Fullness",
-   xp = "Experience"
+   "xp": "Experience"
+}
 </pre>

@@ Line 127: / Line 127: @@
 *Sent by the server when a new temporary buff is applied to the character
-*Message is an object that contains the buff name and the buff expiration timestamp
+*Message is an object that contains the unique buff id, the buff name, and the buff expiration timestamp
 Example:
 <pre>
-Char.Buffs.Add { expires: 1665432700, name: "Mystic Blink" }
+Char.Buffs.Add {
 </pre>
@@ Line 137: / Line 141: @@
 *Sent by the server when a temporary buff is removed from the character
-*Message is a string corresponding with the name of the buff that is being removed
+*Message is a string corresponding with the unique buff id of the buff that is being removed
 Example:
 <pre>
-Char.Buffs.Remove "Mystic Blink"
+Char.Buffs.Remove "buff_1672791803550808142"
 </pre>
@@ Line 147: / Line 151: @@
 *Sent by the server in response to a client message of Char.Buffs.List
-*Message is an object of string and number pairs representing the names and expirations of the buffs applied to the character
+*Message is an object of objects containing the expiration time and the name for each unique buff id
 Example:
 <pre>
-Char.Buffs.List { "Mystic Blink" : 1665433372, "Plucky Lucky" : 1665434073 }
+Char.Buffs.List {
 </pre>
 ===Debuffs===
@@ Line 158: / Line 171: @@
 *Sent by the server when a new temporary debuff is applied to the character
-*Message is an object that contains the buff name and the debuff expiration timestamp
+*Message is an object that contains the unique debuff id, the buff name, and the debuff expiration timestamp
 Example:
 <pre>
-Char.Debuffs.Add { expires: 1665432700, name: "Astral Sickness" }
+Char.Debuffs.Add {
 </pre>
@@ Line 168: / Line 185: @@
 *Sent by the server when a temporary debuff is removed from the character
-*Message is a string corresponding with the name of the debuff that is being removed
+*Message is a string corresponding with the unique debuff id of the debuff that is being removed
 Example:
 <pre>
-Char.Buffs.Remove "Astral Sickness"
+Char.Buffs.Remove "debuff_1672791803550889442"
 </pre>
@@ Line 178: / Line 195: @@
 *Sent by the server in response to a client message of Char.Debuffs.List
-*Message is an object of string and number pairs representing the names and expirations of the debuffs applied to the character
+*Message is an object of objects containing the expiration time and the name for each unique debuff id
 Example:
 <pre>
-Char.Debuffs.List { "Astral Sickness" : 1665432820 }
+Char.Debuffs.List {
 </pre>

← Older revision	Revision as of 20:32, 10 October 2022
(No difference)

@@ Line 108: / Line 108: @@
 ==== Status ====
-* Sent by server immediately after the initial Char.StatusVars message and whenever the value of a variable changes.
+* Sent by server immediately after the initial Char.StatusVars message and once every [[heartbeat]] thereafter.
 * Contains the values of character status variables (level, race, etc).
 * The full list of variables is only sent with the initial message, subsequent messages only contain changed variables.

@@ Line 82: / Line 82: @@
 <pre>
 Char.StatusVars {
-      "age" : "Age",
+  age = "Age",
-      "expertise" : "Expertise",
+  capacity = "Capacity",
-      "fullname" : "Full name",
+  expertise = "Expertise",
-      "guild" : "Guild",
+  foe_health = "Current foe's health",
-      "guild_level" : "Guild level",
+  foe_name = "Current foe",
-      "hb" : "Heal bank",
+  fullname = "Full name",
-      "level" : "Level",
+  guild = "Guild",
-      "name" : "Name",
+  guild_level = "Guild level",
-      "race" : "Race",
+  hb = "Heal Bank",
-      "session_login" : "Logged in",
+  heritage = "Heritage",
-      "tnl" : "To next level",
+  hlevel = "Heritage level",
-      "tummy" : "Fullness",
+  level = "Level",
-      "xp" : "Experience"
+  max_capacity = "Max capacity",
+}
 </pre>
@@ Line 106: / Line 115: @@
 <pre>
 Char.Status {
-    "age" : 500,
+  age = "505",
-    "expertise" : 258493,
+  capacity = "3036",
-    "fullname" : "Karahd the Magocrat",
+  expertise = "1586551",
-    "guild" : "mage",
+  foe_health = "0",
-    "guild_level" : 11,
+  foe_name = "none",
-    "level" : 11,
+  fullname = "Karahd the Magocrat",
-    "hb" : 40,
+  gender = "female",
-    "name" : "Karahd",
+  guild = "mage",
-    "race" : "elf",
+  guild_level = "15",
-    "session_login" : 1625955749,
+  hb = "0",
-    "tnl" : 54,
+  heritage = "scholar",
-    "tummy" : 25,
+  hlevel = "0",
-    "xp" : 372225
+  inactive = "0",
+}
 </pre>