Difference between revisions of "Info.xml"

Revision as of 17:03, 20 June 2017

This XML file describes a scenario. All tags listed below must be within an <info></info> block.

Tags

• name The name of the scenario that will show up in the scenario list.
• description The full description of the scenario that will show up when selecting the scenario in the scenario list.
• tag A short tagline description of the scenario, which is shown above the description.
• multiplayer Whether the scenario is multiplayer-only or not. Either true or false. (Default: false)
• saving The save mode to use. Either none where there are no saves at all, current where the current level is saved, or all which is like Hammerwatch, where you can go back to older levels without their progress getting reset. (Default: current)
• players min="X" max="X" The amount of players allowed to play in multiplayer. (Default: unlimited)
• modifiers A collection of switches for the scenario.
  • modifier forced="X" id="X" name="X" tooltip="X" locked-by="X" default-on="X" radio="X" multiplayer="X" A modifier.
    • The id attribute is the modifier ID. When the switch is turned on, in content, a preprocessor define called MOD_ID is defined. For more information, see Preprocessor.
    • The name attribute is the visible display name for the switch. It is displayed in the switches menu.
    • The tooltip attribute defines the text for an additional tooltip that should show when hovering over the switch in the switches menu. (Default: none)
    • The locked-by attribute defines which switches disable this one, separate by commas. (Default: none)
    • The default-on attribute sets this switch to be on by default. This value is either true or false. (Default: false)
    • The radio attribute sets whether this switch is part of a group. Setting this value together with multiple switches turns them into a "radiobox" instead of a checkbox, where only 1 switch of a group can be selected at a time. (Default: none)
    • The forced attribute defines whether this switch is always defined, and isn't listed in the switches menu. This value is either true or false. If you set this to true, the only other attribute you need to set is id. (Default: false)
    • The multiplayer attribute defines whether this switch is only available in multiplayer. This value is either true or false. (Default: false)
  • separator multiplayer="X" A separator line for the switch menu. The multiplayer attribute is the same as for the modifier tag.
  • header text="X" tooltip="X" multiplayer="X" A header text for the switch menu. The multiplayer attribute is the same as for the modifier tag.
• start A collection of levels that the player will be able to start from.
  • level name="X" lvl="X" A level that the player will be able to start from. The name attribute is the name displayed in the list of levels, and the lvl attribute is the filename to the level.
• classmaps
  • behavior from="X" to="X"
  • script from="X" to="X"
  • gamemode from="X" to="X"
• disable-include
• includes
  • include modifiers="X" levels="X" classmaps="X" final="X"

Example

Below is the info.xml file for the Payload gamemode on the Workshop:

<info>
  <name>Payload</name>
  <description>Bring the payload to the other side.</description>
  <multiplayer>true</multiplayer>

  <players min="2" max="12" />

  <start>
    <level name="Over the Mountain" lvl="levels/payload01.lvl" />
    <level name="That belongs in a Museum" lvl="levels/payload02.lvl" />
  </start>

  <modifiers>
    <modifier forced="true" id="VERSUS" />
    <modifier forced="true" id="PICKUP_RESPAWN" />
  </modifiers>
</info>