View source for Standards:MUD Client Media Protocol

<languages/>
<translate>
= MUD Client Media Protocol (MCMP) =


== A Standard for Loading, Playing and Stopping Media Files with MUD Clients over GMCP ==


== Status of this Memo ==

This memo describes the addition of a standardized namespace of the Generic Mud Communication Protocol (GMCP) telnet sub-negotiation protocol (201) that provides syntax and usage guidance for sending JSON formatted messages from game servers to text-based game clients to load, play and stop media files.


== Overview and Rationale ==

With renewed interest in the MUD genre of gaming, expectations are high to provide sight and sound content that competes for audience with other gaming platforms. The purpose of the MUD Client Media Protocol (MCMP) is to establish a method of delivering media, such as game sounds, background music and video snippets, to text-based game clients via their widely accepted messaging platform, GMCP, which uses JSON as its data-interchange format. The intended return for introducing this protocol is to improve the MUD gaming experience and accessibility through standardized messaging between game servers and game clients. MUD Client Media Protocol (MCMP) is inspired by its predecessor [https://www.zuggsoft.com/zmud/msp.htm Mud Sound Protocol] (MSP).


== Overview of the GMCP (201) Sub-negotiation Protocol ==

To recap, the GMCP protocol is a bidirectional telnet sub-negotiation protocol (See RFC 854) which fulfills the following conditions:

* GMCP is separated into several ‘namespaces’, which may be enabled or disabled by the client at any time. The ‘Core’ namespace is always enabled and may not be disabled. Namespaces should consist of case-insensitive alphabetical characters and stop characters (. - ASCII 46/0x2E), representable as [A-Za-z.].
* GMCP messages consist of the namespace and a command (case insensitive alpha characters) delineated by a stop character, and optionally a space character and JSON-encoded payload.
* GMCP messages may be sent by both the client or server at any time with no warning.


== Update to namespace: Client.* for Client.Media ==

We are proposing an addition to the Client.* meta-namespace for Client.Media. This serves the purpose of reserving this namespace for handling game client media operations and supporting future expansion and integration.


== Video Demonstration of Client.Media ==

[[File:MCMP_Background_Music_Demo_with_Mudlet.mp4]]

== Specification for Client.Media ==

The Client.Media family of GMCP packages provide a way for games to send sound, music and video events. GMCP media events are sent in one direction: from game server to to game client. Media files may be downloaded manually by the user and/or automatically via the game client. Game clients should advertise to servers that Client.Media is supported with a Core.Supports message from game client to server.

<syntaxhighlight lang="json">
Core.Supports.Set ["Client.Media 1", ...]
</syntaxhighlight>

</translate>
{{note}}
<translate> Presenting game ''sound'' and ''music'' media content is the current focus. Presenting ''video'' content was also successfully tested with this specification.

=== Commands - Server ===

Due to the limitations for legacy gaming platforms supporting all JSON data types, such as boolean (''true'' and ''false''), game clients should support parsing of values within the Client.Media namespace also as strings (surrounded by quotes). 

==== Client.Media.Default ====

* Package: Client.Media.Default
* Purpose: Identify to the game client a default URL directory to load media files from an external resource.
* Guidance: For games that automatically download media files, perform a Client.Media.Default GMCP event once upon player login. 

Syntax:
<syntaxhighlight lang="json">Client.Media.Default {"url": "hxxps://www.example.com/media/"}</syntaxhighlight>

Usage:
{| class="wikitable"
! Required
! Key
! Value
! style="text-align:left;"| Purpose
|- style="color: green;"
| style="text-align:center;"| Yes
| "url"
| <url>
| style="text-align:left;"|
* Resource location where the media file may be downloaded.
* Last character must be a / (slash). 
|-
|}

</translate>
{{note}}
<translate> Some examples are shown [[Special:MyLanguage/Manual:Scripting#Loading_Media|here]].

</translate>
{{note}}
<translate> Client.Media.Default was previously named Client.Media. Revised in February 2020 for GMCP specification conformance.

</translate>
{{note}}
<translate> Requirement to make last character of "url" a / (slash). Revised in July 2020 per request from BeipMU team.

==== Client.Media.Load ====

* Package: Client.Media.Load
* Purpose: Load media files from an external source.
* Guidance: For games that automatically download media files and have the capability to cache with the game client.

Syntax:

<syntaxhighlight lang="json">Client.Media.Load {
  "name": "sword1.mp3",
  "url": "hxxps://www.example.com/media/"
}</syntaxhighlight>

Usage:
{| class="wikitable"
! Required
! Key
! Value
! style="text-align:left;"| Purpose
|- style="color: green;"
| style="text-align:center;"| Yes
| "name"
| <file name>
| style="text-align:left;"|
* Name of the media file.
* May contain directory information (i.e. weather/lightning.mp3).
|- style="color: blue;"
| style="text-align:center;"| Maybe
| "url"
| <url>
| style="text-align:left;"|
* Resource location where the media file may be downloaded.
* Last character must be a / (slash).
* Only required if a url was not set with Client.Media.Default.
|-
|}

</translate>
{{note}}
<translate> Some examples are shown [[Special:MyLanguage/Manual:Scripting#Loading_Media|here]].


==== Client.Media.Play ====

* Package: Client.Media.Play
* Purpose: Play media files.
* Guidance: Game clients could choose whether to play only one media file at one time or multiple files at one time.

Syntax:
<syntaxhighlight lang="json">Client.Media.Play {
  "name": "city.mp3",
  "url": "hxxps://www.example.com/media/",
  "type": "music",
  "tag": "environment",
  "volume": 25,
  "loops": 3,
  "priority": 60,
  "continue": true,
  "key": "area-background-music"
}</syntaxhighlight>

Usage:
{| class="wikitable"
! Required
! Key
! Value
! Default
! style="text-align:left;"| Purpose
|- style="color: green;"
| style="text-align:center;"| Yes
| "name"
| <file name>
| &nbsp;
| style="text-align:left;"|
* Name of the media file.
* May contain directory information (i.e. weather/lightning.mp3).
|- style="color: blue;"
| style="text-align:center;"| Maybe
| "url"
| <url>
| &nbsp;
| style="text-align:left;"|
* Resource location where the media file may be downloaded.
* Last character must be a / (slash).
* Only required if the file is to be downloaded remotely and a url was not set above with Client.Media.Default or Client.Media.Load.
|-
| style="text-align:center;"| No
| "type"
| "sound", "music" or "video"
| "sound"
| style="text-align:left;"|
* Identifies the type of media.
|-
| style="text-align:center;"| No
| "tag"
| <tag>
| &nbsp;
| style="text-align:left;"|
* Helps categorize media.
|-
| style="text-align:center;"| No
| "volume"
| 1 to 100
| 50
| style="text-align:left;"|
* Relative to the volume set on the player's client.
|-
| style="text-align:center;"| No
| "loops"
| -1, or >= 1
| 1
| style="text-align:left;"|
* Number of iterations that the media plays.
* A value of -1 allows the sound or music to loop indefinitely.
|-
| style="text-align:center;"| No
| "priority"
| 1 to 100
| &nbsp;
| style="text-align:left;"|
* Halts the play of current or future played media files with a lower priority while this media plays.
|-
| style="text-align:center;"| No
| "continue"
| true or false
| true
| style="text-align:left;"|
* Only valid for media files with a "type" of "music".
* Continues playing matching new music files when true.
* Restarts matching new music files when false. 
|-
| style="text-align:center;"| No
| "key"
| <key>
| &nbsp;
| style="text-align:left;"|
* Uniquely identifies media files with a "key" that is bound to their "name" or "url".
* Halts the play of current media files with the same "key" that have a different "name" or "url" while this media plays.
|-
|}

</translate>

{{note}}
<translate> Some examples are shown [[Special:MyLanguage/Manual:Scripting#Playing_Media|here]].

==== Client.Media.Stop ====

* Package: Client.Media.Stop
* Purpose: Stop playing media files.
* Guidance: An empty body will stop all media.

Syntax:
<syntaxhighlight lang="json">Client.Media.Stop {
  "name": "city.mp3",
  "type": "music",
  "tag": "environment",
  "priority": 60,
  "key": "area-background-music"
}</syntaxhighlight>

Usage:
{| class="wikitable"
! Required
! Key
! Value
! style="text-align:left;"| Purpose
|-
| style="text-align:center;"| No
| "name"
| <file name>
| style="text-align:left;"|
* Stops playing media by name matching the value specified.
|-
| style="text-align:center;"| No
| "type"
| "sound", "music" or "video"
| style="text-align:left;"|
* Stops playing media by type matching the value specified.
|-
| style="text-align:center;"| No
| "tag"
| <tag>
| style="text-align:left;"|
* Stops playing media by tag matching the value specified.
|-
| style="text-align:center;"| No
| "priority"
| 1 to 100
| style="text-align:left;"|
* Stops playing media with priority less than or equal to the value.
|-
| style="text-align:center;"| No
| "key"
| <key>
| style="text-align:left;"|
* Stops playing media by key matching the value specified.
|-
|}

</translate>
{{note}}
<translate> Some examples are shown [[Special:MyLanguage/Manual:Scripting#Stopping_Media|here]].


== Authors ==

* Mike Conley (Tamarindo, Co-Administrator at StickMUD and Mudlet contributor) sousesider[at]gmail.com
* Eric Oestrich (Developer of ExVenture and Grapevine) eric[at]oestrich.org


== Notes ==

* Known clients implementing this specification:
** Mudlet version 4.4+. See [[Special:MyLanguage/Manual:Scripting#MUD_Client_Media_Protocol|documentation]].
</translate>