Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
gmcp:start [2023/05/22 00:39] – More content. paradox | gmcp:start [2024/04/26 23:19] (current) – Add link to speakers page lytol | ||
---|---|---|---|
Line 16: | Line 16: | ||
| Char | Character information | | | Char | Character information | | ||
| Room | Room information | | | Room | Room information | | ||
- | | Comm.Channel | Channel information | + | | Comm.Channel | Channel information | |
| Guild | Guild specific information ((Enabled automatically for all GMCP clients.)) | | | Guild | Guild specific information ((Enabled automatically for all GMCP clients.)) | | ||
==== Supported Messages by Module ==== | ==== Supported Messages by Module ==== | ||
- | === Char === | + | Messages marked as type " |
- | TODO | + | === 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 === | === Room === | ||
- | TODO | + | ^ Message Name ^ Sent When ^ Type ^ Notes ^ |
+ | |'' | ||
- | === Comm.Channel === | + | ^Data Field ^ Description ^ Example ^ |
+ | | '' | ||
+ | | " | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
- | TODO | + | 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 === | ||
- | TODO | + | 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 ===== |