https://www.legendmud.org/index.php?title=GMCP_CMUD_Tutorial&feed=atom&action=history
GMCP CMUD Tutorial - Revision history
2024-03-28T11:02:42Z
Revision history for this page on the wiki
MediaWiki 1.35.2
https://www.legendmud.org/index.php?title=GMCP_CMUD_Tutorial&diff=767&oldid=prev
Stolve at 15:59, 7 January 2021
2021-01-07T15:59:45Z
<p></p>
<table class="diff diff-contentalign-left diff-editfont-monospace" data-mw="interface">
<col class="diff-marker" />
<col class="diff-content" />
<col class="diff-marker" />
<col class="diff-content" />
<tr class="diff-title" lang="en">
<td colspan="2" style="background-color: #fff; color: #202122; text-align: center;">← Older revision</td>
<td colspan="2" style="background-color: #fff; color: #202122; text-align: center;">Revision as of 15:59, 7 January 2021</td>
</tr><tr><td colspan="2" class="diff-lineno" id="mw-diff-left-l10" >Line 10:</td>
<td colspan="2" class="diff-lineno">Line 10:</td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>== Receiving a GMCP message ==</div></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>== Receiving a GMCP message ==</div></td></tr>
<tr><td class='diff-marker'>−</td><td style="color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>Once GMCP is enabled, the MUD will begin <del class="diffchange diffchange-inline">broadcasting </del>GMCP messages<del class="diffchange diffchange-inline">.</del></div></td><td class='diff-marker'>+</td><td style="color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div>Once GMCP is enabled, the MUD will begin <ins class="diffchange diffchange-inline">sending </ins>GMCP messages.</div></td></tr>
<tr><td class='diff-marker'>−</td><td style="color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline">CMUD automatically saves all data from GMCP messages in a global <code>%gmcp</code> variable</del>. </div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;">There are two types of GMCP messages, broadcasts and requested messages.</ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;">Broadcast messages will happen automatically, while requested messages will only be sent by the MUD if the client requests them.</ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;">The full list of packages and their message types can be found [[GMCP Packages|here]].</ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;"></ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;">CMUD automatically saves all data from GMCP messages in a global <code>%gmcp</code> variable.</ins></div></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>For example, if you wanted to read the area name from the prompt, you can do this at any time, from anywhere via the following zScript:</div></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>For example, if you wanted to read the area name from the prompt, you can do this at any time, from anywhere via the following zScript:</div></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div> %gmcp.char.prompt.an</div></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div> %gmcp.char.prompt.an</div></td></tr>
</table>
Stolve
https://www.legendmud.org/index.php?title=GMCP_CMUD_Tutorial&diff=755&oldid=prev
Stolve: /* Enabling GMCP */
2021-01-06T15:19:35Z
<p><span dir="auto"><span class="autocomment">Enabling GMCP</span></span></p>
<table class="diff diff-contentalign-left diff-editfont-monospace" data-mw="interface">
<col class="diff-marker" />
<col class="diff-content" />
<col class="diff-marker" />
<col class="diff-content" />
<tr class="diff-title" lang="en">
<td colspan="2" style="background-color: #fff; color: #202122; text-align: center;">← Older revision</td>
<td colspan="2" style="background-color: #fff; color: #202122; text-align: center;">Revision as of 15:19, 6 January 2021</td>
</tr><tr><td colspan="2" class="diff-lineno" id="mw-diff-left-l1" >Line 1:</td>
<td colspan="2" class="diff-lineno">Line 1:</td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>== Enabling GMCP ==</div></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>== Enabling GMCP ==</div></td></tr>
<tr><td class='diff-marker'>−</td><td style="color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>In CMUD you can enable GMCP via the preferences for your session.</div></td><td class='diff-marker'>+</td><td style="color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div>In CMUD you can enable <ins class="diffchange diffchange-inline">[[</ins>GMCP<ins class="diffchange diffchange-inline">]] </ins>via the preferences for your session.</div></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>Once a session is opened, open the preferences:</div></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>Once a session is opened, open the preferences:</div></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"></td></tr>
</table>
Stolve
https://www.legendmud.org/index.php?title=GMCP_CMUD_Tutorial&diff=754&oldid=prev
Stolve at 15:19, 6 January 2021
2021-01-06T15:19:13Z
<p></p>
<table class="diff diff-contentalign-left diff-editfont-monospace" data-mw="interface">
<col class="diff-marker" />
<col class="diff-content" />
<col class="diff-marker" />
<col class="diff-content" />
<tr class="diff-title" lang="en">
<td colspan="2" style="background-color: #fff; color: #202122; text-align: center;">← Older revision</td>
<td colspan="2" style="background-color: #fff; color: #202122; text-align: center;">Revision as of 15:19, 6 January 2021</td>
</tr><tr><td colspan="2" class="diff-lineno" id="mw-diff-left-l5" >Line 5:</td>
<td colspan="2" class="diff-lineno">Line 5:</td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>[[File:Gmcp-cmud-open-prefs.jpg|How to open preferences]] </div></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>[[File:Gmcp-cmud-open-prefs.jpg|How to open preferences]] </div></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"></td></tr>
<tr><td class='diff-marker'>−</td><td style="color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>In the preferences, open the Protocols tab and ensure the <code>GMCP Emulation</code> checkbox is checked. Additionally, list the LegendMUD packages you want to receive in the textbox below.</div></td><td class='diff-marker'>+</td><td style="color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div>In the preferences, open the Protocols tab and ensure the <code>GMCP Emulation</code> checkbox is checked. Additionally, list the LegendMUD packages you want to receive in the textbox below<ins class="diffchange diffchange-inline">. A list of packages can be found [[GMCP Packages|here]]</ins>.</div></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>[[File:Gmcp-cmud-enable.jpg|How to enable GMCP]]</div></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>[[File:Gmcp-cmud-enable.jpg|How to enable GMCP]]</div></td></tr>
</table>
Stolve
https://www.legendmud.org/index.php?title=GMCP_CMUD_Tutorial&diff=752&oldid=prev
Stolve: Created page with "== Enabling GMCP == In CMUD you can enable GMCP via the preferences for your session. Once a session is opened, open the preferences: File:Gmcp-cmud-open-prefs.jpg|How to o..."
2021-01-06T15:10:56Z
<p>Created page with "== Enabling GMCP == In CMUD you can enable GMCP via the preferences for your session. Once a session is opened, open the preferences: File:Gmcp-cmud-open-prefs.jpg|How to o..."</p>
<p><b>New page</b></p><div>== Enabling GMCP ==<br />
In CMUD you can enable GMCP via the preferences for your session.<br />
Once a session is opened, open the preferences:<br />
<br />
[[File:Gmcp-cmud-open-prefs.jpg|How to open preferences]] <br />
<br />
In the preferences, open the Protocols tab and ensure the <code>GMCP Emulation</code> checkbox is checked. Additionally, list the LegendMUD packages you want to receive in the textbox below.<br />
<br />
[[File:Gmcp-cmud-enable.jpg|How to enable GMCP]]<br />
<br />
== Receiving a GMCP message ==<br />
Once GMCP is enabled, the MUD will begin broadcasting GMCP messages.<br />
CMUD automatically saves all data from GMCP messages in a global <code>%gmcp</code> variable. <br />
<br />
For example, if you wanted to read the area name from the prompt, you can do this at any time, from anywhere via the following zScript:<br />
%gmcp.char.prompt.an<br />
<br />
Sometimes you need to be able to trigger off of a GMCP message. This can be done by creating a GMCP trigger.<br />
<br />
Create a new trigger and use the package name in the pattern field. <br />
Additionally, change the trigger type (noted in the screenshot below) to GMCP. The number field to the right of this dropdown can be ignored.<br />
<br />
[[File:Gmcp-cmud-trigger.jpg|Creating a GMCP trigger in CMUD]]<br />
<br />
You can also use pattern matching to trigger on multiple GMCP messages.<br />
For example, you can set the pattern to <code>char.*</code> to trigger on ''any'' character related GMCP message.<br />
<br />
== Sending a GMCP message ==<br />
The MUD will not broadcast every message that is available. Some messages must be manually requested. Additionally, some broadcasted messages can also be requested if you need to refresh the data before the MUD would broadcast again.<br />
<br />
The following script can be used to send a request to the MUD:<br />
#SENDGMCP "Package.Subpackage" @Table<br />
<br />
Where @Table is a normal CMUD database variable or string list with the data you want to send. <br />
// As a database variable<br />
$response = " "<br />
#addkey $response client "CMUD"<br />
#addkey $response version "3.22"<br />
#SENDGMCP "core.hello" $response<br />
<br />
// As a string list<br />
$list = {core 1|char 1|room 1|comm 1}<br />
#SENDGMCP "core.supports.set" $list<br />
<br />
// With no data<br />
#SENDGMCP "char.status" ""</div>
Stolve