Every map XML file must contain the base
<map> module. It contains modules that specify the map name, version, objective, authors, contributors and all other map settings. The objective is the text that players see when they join the match, and so it's important for this to be very clear, concise, and informative.
proto="" attribute specifies what PGM version the XML file was created for. If this value is higher than the version of PGM that is running, the map won't load. If it's lower, the map will load but the XML may be interpreted in an outdated way. Mapmakers should always use the latest supported XML version, and this may be required of new maps that are to be added to any map compilation projects, such as ResourcePile.
The maps version should follow the versioning schema
|The main map node containing all the modules used in this match.||XML Modules|
|RequiredThe maps XML protocol version.|
|Prevent compass teleports above Y 255||true/false||false|
|RequiredThe name of the map.||String|
|The map's slug, usually auto generated from the maps name. This should only be used when a map is renamed to retain the map's ratings, etc.|
Valid slugs are lowercase and only contain the characters:
|RequiredThe map's semantic version string.|
|RequiredThe map's objective, shown at the start of the match.||String|
|RequiredThe authors of the map, at least one author is required.|
|Contributors to the map.|
|Phase of this map. Only maps with phase:`production` and edition:`standard` show up on the website.|
|Edition of this map, describes which servers it is run on.|
|A custom title for this match's gamemode.||String|
|The gamemode(s) of this map, if this is not specified the map will set the gamemode(s) to whatever modules are used.||Gamemode ID|
Authors & Contributors
The authors and contributers elements provide information about who created and helped create the map. There can be multiple authors and contributors to a map. The contribution attribute should be used to specify what their contribution to the map was.
A players name should not be used to credit them, instead their UUID should be used. A UUID is a unique user identifier that is used to keep track of players even if they change their name. You can check player UUID's at mcuuid.net. If an author or contributor is defined without a UUID that player will not get any mapmaker perks on the map.
Author or Contributor Sub-elements
|A major author of the map, used in||String|
|A contributor to the map, used in||String|
Author & Contributor Attributes
|The contribution this author or contributor made to the map.||String|
|UUID used to identify a player.||String|
The gamemode element is used to specify the gamemode(s) of the map.
This mainly affects how the map is categorized and displayed.
<gamemode> tags are specified the map will set the gamemode(s) to whatever modules are used.
This means that a map that uses destroyables and flags would be listed as a "DTM & CTF" unless specified otherwise.
|The gamemode(s) of this map.||Gamemode ID|
|Team Deathmatch||Capture the Wool|
|Capture the Flag||Destroy the Core|
|Destroy the Monument||Attack/Defend|
|King of the Hill||Blitz|