Differences
This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
gmcp:start [2023/05/22 00:08] – created, sketching outline paradox | gmcp:start [2024/04/26 23:19] (current) – Add link to speakers page lytol | ||
---|---|---|---|
Line 5: | Line 5: | ||
===== GMCP Messages ===== | ===== GMCP Messages ===== | ||
- | TODO. | + | Presently Dune only supports sending you GMCP messages as **output**. We do not support any GMCP **input** commands. |
+ | |||
+ | Some messages are sent whenever data changes, and will only contain the parts of the data that has changed since the last message. If you want to maintain a full picture of this kind of message' | ||
+ | |||
+ | ==== Supported Modules ==== | ||
+ | |||
+ | Dune supports opting in to different categories of GMCP messages by telling the game which your client supports. Some clients (like Mudlet) will do this automatically for some packages. Others (like Blightmud) require you to opt-in explicitly. | ||
+ | |||
+ | ^ Name ^ Description | ||
+ | | Char | Character information | | ||
+ | | Room | Room information | | ||
+ | | Comm.Channel | Channel information | | ||
+ | | Guild | Guild specific information ((Enabled automatically for all GMCP clients.)) | | ||
+ | |||
+ | ==== Supported Messages by Module ==== | ||
+ | |||
+ | Messages marked as type " | ||
+ | |||
+ | === Char.Name === | ||
+ | |||
+ | ^ Message Name ^ Sent When ^ Type ^ Notes ^ | ||
+ | |'' | ||
+ | |||
+ | ^Data Field ^ Description ^ Example ^ | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | |||
+ | The guild field will be one of the following values (**case sensitive!**((yes, | ||
+ | |||
+ | === Char.Vitals === | ||
+ | |||
+ | ^ Message Name ^ Sent When ^ Type ^ Notes ^ | ||
+ | |'' | ||
+ | |||
+ | ^Data Field ^ Description ^ Example ^ | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | |||
+ | === Char.Stats === | ||
+ | |||
+ | ^ Message Name ^ Sent When ^ Type ^ Notes ^ | ||
+ | |'' | ||
+ | |||
+ | ^Data Field ^ Description ^ Example ^ | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | |||
+ | === Char.MaxStats === | ||
+ | |||
+ | ^ Message Name ^ Sent When ^ Type ^ Notes ^ | ||
+ | |'' | ||
+ | |||
+ | ^Data Field ^ Description ^ Example ^ | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | |||
+ | === Char.Status and Char.StatusVars === | ||
+ | |||
+ | ^ Message Name ^ Sent When ^ Type ^ Notes ^ | ||
+ | |'' | ||
+ | | '' | ||
+ | |||
+ | ^Data Field ^ Description ^ | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | |||
+ | === Room === | ||
+ | |||
+ | ^ Message Name ^ Sent When ^ Type ^ Notes ^ | ||
+ | |'' | ||
+ | |||
+ | ^Data Field ^ Description ^ Example ^ | ||
+ | | '' | ||
+ | | " | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | |||
+ | Example room info: | ||
+ | <code javascript> | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | **Note**: A few select areas that are highly custom may be missing exit information. This is a known issue and will hopefully be addressed in the future. The majority of areas will send correct GMCP data. | ||
+ | |||
+ | |||
+ | === Comm.Channel.List === | ||
+ | |||
+ | ^ Message Name ^ Sent When ^ Type ^ Notes ^ | ||
+ | |'' | ||
+ | |||
+ | ^Data Field ^ Description ^ | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | |||
+ | Channel list information is sent only at login, and as an array. Each each array value is a dict with the data fields listed above. | ||
+ | |||
+ | Example: | ||
+ | <code javascript> | ||
+ | [ | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | ] | ||
+ | </ | ||
+ | |||
+ | === Comm.Channel.Text === | ||
+ | |||
+ | ^ Message Name ^ Sent When ^ Type ^ Notes ^ | ||
+ | |'' | ||
+ | |||
+ | ^Data Field ^ Description ^ | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | |||
+ | Example: | ||
+ | <code javascript> | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | By default channel messages will be sent both in-game and over GMCP for clients that opt-in to the '' | ||
+ | |||
+ | === Guild === | ||
+ | |||
+ | Guild data varies widely by guild. See each page for more information. | ||
+ | * [[atreides|House Atreides]] | ||
+ | * [[gesserit|Bene Gesserit]] | ||
+ | * [[tleilax|Bene Tleilax]] | ||
+ | * [[warriors|Bene Gesserit Warriors]] | ||
+ | * [[fremen|Fremen]] | ||
+ | * [[harkonnen|House Harkonnen]] | ||
+ | * [[matres|Honored Matres]] | ||
+ | * [[sardaukar|Imperial Sardaukar]] | ||
+ | * [[img|Ixian Machine Guild]] | ||
+ | * [[speakers|Fish Speakers]] | ||
===== Client Setup ===== | ===== Client Setup ===== | ||
Line 13: | Line 215: | ||
==== Mudlet ==== | ==== Mudlet ==== | ||
- | TODO. | + | You can use '' |
+ | |||
+ | By default Mudlet enables '' | ||
See [[https:// | See [[https:// | ||
Line 20: | Line 224: | ||
To use Dune's GMCP data in [[https:// | To use Dune's GMCP data in [[https:// | ||
+ | |||
+ | You can use '' | ||
Example: | Example: |