index.md

layout	default

XML Documentation

Documentation on XML files that are required for each map to be added to the servers

Welcome

### What Do XML Files Do? XML files configure how the PGM plug-in controls the map during a match. Any map released on Stratus requires an XML file to function. The XML defines aspects of the game such as spawn points, teams, kits and more. Each file is unique to its map, however the components and modules are generic and are used on many different maps.

Writing XML Files

Almost every text editor can create and edit XML files, however editors designed for XML can automatically indent and syntax your code to help spot mistakes.

We recommend that you use Atom to create and edit XML files.

To keep your XML file clean, consistent, & readable you should follow the XML Conventions and only specify elements or attributes you intend to use.

Releasing Your Map

Before releasing your map for testing, you must package your map following these guidelines. This will speed up the time it takes to get your map ready for testing.

### Using These Docs This documentation is intended to list all currently available XML modules, their attributes & sub-elements; and describe how the modules work and interact with the player. It is designed to be used as a reference when coding the XML files accompanying a map to ensure that the XML is valid and works as intended.

All attributes or sub-elements for a element or module are listed in a table and required attributes or sub-elements are marked in red. In the following example the color attribute is required but id is not. The attribute or elements default value is also listed if there is one.

Table Example

Attribute	Description	Value	Default
id	Unique identifier used to reference this element.	String
color	Required This example's color.	Dye Color Name
cow	This example has a pet cow.	true/false	false