Formats are XML files that instruct the Events plugin to do a specific tournament format, i.e. having a Bo3 of CTW maps, or having several "rounds" of different maps and gamemodes.
Every format XML file must contain the base <format> module.
The format module can also be a round and therefore can be used to create a nested rounds.
| Format Element | Description | Value/Children |
|---|
<format> </format> | The main format node containing all the modules used in this format. It can also represent a round and be nested inside other elements. | XML Modules |
| Attribute | Description | Value | Default |
|---|
best-of | What the match should be out of. | Number | 1 |
name | Only if nested in <options>The name of the round. Useful for vetoing. | String | |
| Element | Description | Attributes | Value/Children |
|---|
<match> | The name of the map. | id=""
(defaults to map name) | String |
<veto> | Represents a round with a veto mechanism to choose play order. | id="" | Veto Modules |
Veto
Every format can have a veto element to choose play order between rounds, and each round can have a veto mechanism to choose play order between maps.
Veto Sub-elements
| Element | Description | Children |
|---|
<decider> | A veto decider. Decides which team vetoes first. | Match<result-from /> |
<options> | Map options for that round. | Match |
<order> | The veto order (ban, pick, etc.). The last element is enacted by the system. | Match |
<decider>
Decider Sub-elements
| Element | Description | Attribute |
|---|
<result-from /> | Uses the result from a round with a matching id, let it be a veto decider, match or round. Useful to stop repeating veto deciders. | id="map-name" |
<order>
Order Attributes
| Attribute | Description | Value | Default |
|---|
ban-until | The number of maps that will remain after banning maps. | Number | 1 |
starting-team | Which team starts choosing/banning maps first. | Number | 1 |
time | The time in seconds that each team has to veto. | Number | 30 |
Order Sub-elements
If <order> has no attributes present, it will look for these sub-elements.
| Element | Description | Attributes | Value |
|---|
<pick> | A pick in the veto process. | team="" - the team that gets to pick the map.
insert="back" - whether the map should be added to the front or back of the maps to be played. | NumberString |
<ban> | A ban in the veto process. | team="" - the team that gets to pick the map.
insert="back"- whether the map should be added to the front or back of the maps to be played. | NumberString |