The XML configuration file is the backbone of each map, allowing Stratus’ custom plugins to interpret and load custom match facets in order to run the map. From the map’s spawns, to kits, and even the objective, almost everything can be configured through the map’s XML file.
This documentation is intended to list all currently available XML modules, their attributes and 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.
Before you begin creating your first XML, you need to have the right tools for the job. Any text editor would be sufficient, and paid software is no where near a requirement. However, the following text editors are tried and recommended by the Stratus Map Developers:
Each of these are free, open source, and have a range of community made plugins to tailor your experience with them. Use the one you feel most comfortable with, or, if you have something else you like more, use that instead.
Reading the Docs
The documentation is divided up into the following sections:
- Facets (main facet documentation and examples)
- References (attribute data types and enumerations)
- Examples (advanced examples and extended templates)
Majority of the facets are documented in tables similar to the following. Some features of this facet have been omitted for the sake of this example.
||Element containing all wool objectives.||Wools Sub-elements|
||A single wool objective.|
||Unique identifier used to reference cores from other places in the XML.||Unique ID|
||Required The monument where the wool has to be placed.||Bounded Region|
||Specify if this wool can be crafted with wool and dye.||Boolean||true|
Attribute table columns tell you what the thing is, while the
Description column tells you its purpose. Sometimes in the description, things will have the Required badge. This means that this thing is required in order for the XML to load with that facet.
Element Text column inform you what the element accepts as a child or what data types attributes need. The Gray Badge represents a set of facet specific sub-elements, the Blue Badge represents a specific attribute data type, and a Link represents a reference to the ID or a set of sub-elements of the specified type, depending on the context. Some attributes have default values if nothing is specified, and these are shown in the
Default column of the table.
If you find yourself going back to certain pages or sections often for reference, you can bookmark them for quick access later by clicking on the bookmark icon next to any heading when you hover over it. You can then access these bookmarks in your bookmarks menu here or by clicking the
Bookmarks link in the site navigation at any time. You can remove bookmarks by clicking the cross in the bookmarks menu, or by clicking the bookmark icon again.
The documentation site offers various preference settings which you can customize in order to best suit the site to your working experience. You can access your preferences by clicking here or by clicking the
Preferences link in the site navigation at any time. These preferences are stored in your browser as cookies, so they are only accessible by you.
If at any point you feel as though you need some extra assistance with understanding something or realizing a concept, feel free to create a discussion thread in the Mapmaking Subforum or chat with us in the #mapmaking channel in our Discord.