Manual:GMCP Extensions - Revision history

Tamarindo: Client.Map before Client.GUI

2025-08-10T21:54:39Z

Client.Map before Client.GUI

2024-01-03T00:21:56Z

2024-01-03T00:20:34Z

2024-01-03T00:20:15Z

2023-02-21T17:48:49Z

Added additional explanation to filename=package name requirement. Removed version number from filename in sample JSON block, which was misleading.

2021-12-28T20:05:59Z

Automatic map download

2021-10-31T08:56:23Z

Prefer GMCP variant

2021-06-16T06:52:30Z

updating: explicitly mention allowed version formats

2021-06-14T17:57:16Z

Layout

2019-09-16T03:55:18Z

← Older revision		Revision as of 21:54, 10 August 2025
Line 51:		Line 51:

	The map can be either in the [[Standards:MMP\|MMP standard]] (indicated by .xml at end of file name) or one [[Manual:Mapper_Functions#saveMap\|exported from Mudlet]].		The map can be either in the [[Standards:MMP\|MMP standard]] (indicated by .xml at end of file name) or one [[Manual:Mapper_Functions#saveMap\|exported from Mudlet]].
		+
		+	{{Note}} Recommend sending Client.Map before Client.GUI for best results.

	== setup ==		== setup ==

@@ Line 25: / Line 25: @@
+}
 </syntaxhighlight>
-{{Note}} The JSON ''version'' may also be an integer value with Mudlet 4.18+
+{{Note}} Mudlet 4.18+ The JSON "''version"'' parameter may also be an integer value
 {{Note}} there is an older, not preferred but still supported way is to send a message via GMCP with:

@@ Line 26: / Line 26: @@
 </syntaxhighlight>
 {{Note}} The JSON ''version'' may also be an integer value with Mudlet 4.18+
 {{Note}} there is an older, not preferred but still supported way is to send a message via GMCP with:

@@ Line 25: / Line 25: @@
+}
 </syntaxhighlight>
+{{Note}} The JSON ''version'' may also be an integer value with Mudlet 4.18+
 {{Note}} there is an older, not preferred but still supported way is to send a message via GMCP with:

@@ Line 13: / Line 13: @@
 </syntaxhighlight>
-When Mudlet receives the message, will make do everything necessary to make the latest UI appear: if the user does not have a package, it will be downloaded and installed from the ''<url>'', and if they do, but of an older version - it'll be upgraded. If they're already on the latest, nothing happens. Ensure that the zip name is the same as the package name.
+When Mudlet receives the message, it will do everything necessary to make the latest UI appear: if the user does not have a package, it will be downloaded and installed from the ''<url>'', and if they do, but of an older version - it'll be upgraded. If they're already on the latest, nothing happens.
 For example:
@@ Line 20: / Line 22: @@
 Client.GUI {
    "version": "39",
-   "url": "http://www.stickmud.com/mudwww/StickMUDv39.mpackage"
+   "url": "http://www.stickmud.com/mudwww/StickMUD.mpackage"
+}
 </syntaxhighlight>

@@ Line 47: / Line 47: @@
 [[File:Start own map.png|center]]
-The map can be either in the [[Standards:MMP|MMP standard]] or one [[Manual:Mapper_Functions#saveMap|exported from Mudlet]].
+The map can be either in the [[Standards:MMP|MMP standard]] (indicated by .xml at end of file name) or one [[Manual:Mapper_Functions#saveMap|exported from Mudlet]].
 == setup ==

@@ Line 4: / Line 4: @@
 == setup ==
-After GMCP is negotiated, the server should send a string with raw telnet in the format of:
+After GMCP is negotiated, the server should send a message via GMCP with:
 <syntaxhighlight lang="json">
@@ Line 17: / Line 13: @@
 </syntaxhighlight>
-And Mudlet will make it happen. If the user does not have a package, it will be downloaded and installed from the ''<url>'', and if they do, but of an older version - it'll be upgraded. If they're already on the latest, nothing happens. Ensure that the zip name is the same as the package name.
+When Mudlet receives the message, will make do everything necessary to make the latest UI appear: if the user does not have a package, it will be downloaded and installed from the ''<url>'', and if they do, but of an older version - it'll be upgraded. If they're already on the latest, nothing happens. Ensure that the zip name is the same as the package name.
 For example:
 <syntaxhighlight lang="json">
@@ Line 33: / Line 23: @@
+}
 </syntaxhighlight>
 == demonstration ==
 Enable GMCP in settings, connect to Midnight Sun 2 (''midnightsun2.org'' on port ''3000'') and create a character. A GUI will automatically install over GMCP once you finish character creation, and an overview of it is [http://midnightsun2.org/gateways/gui.html?show=overview available here] - a good idea to consider to make your MUD more visually appealing.

@@ Line 44: / Line 44: @@
 == updating ==
 If you change the package version to any other text than what it previously was, Mudlet will consider it an update - it'll uninstall the old package and install the new package. This happens without prompting the user (since it can be kind of tricky if they decline), thus any modifications they would have done would be wiped - encourage users to make any modifications outside of the package and provide hooks for doing so.
 = Automatic map download =

← Older revision		Revision as of 17:57, 14 June 2021
Line 1:		Line 1:
		+	{{TOC right}}
	= Automatic package installation =		= Automatic package installation =
	Mudlet supports automatic download and setup of [[Mudlet_Packages\|Mudlet packages]] should the MUD server offer it. These packages could consist of graphical additions to your game or anything else you'd like your players to have loaded on their Mudlet profiles by default. This setup is automatic and carefree on part of the user, and handles package updates in a transparent manner as well.		Mudlet supports automatic download and setup of [[Mudlet_Packages\|Mudlet packages]] should the MUD server offer it. These packages could consist of graphical additions to your game or anything else you'd like your players to have loaded on their Mudlet profiles by default. This setup is automatic and carefree on part of the user, and handles package updates in a transparent manner as well.