armor.xml

Modified on 2013/06/12 19:17 by Keith Rudolph — Categorized as: Chummer SR5 - Data Files

armor.xml (and custom_armor.xml, see Custom Data Files) contains all of the information for Armor and Armor Modifications.

Structure

<chummer>
   <categories>
      <category />
   </categories>
   <armors>
      <armor />
   </armors>
   <mods>
      <mod />
   </mods>
</chummer>

categories describe the different Categories of Armor.

armor nodes describe the individual pieces of Armor.

mod nodes describe the individual pieces of Armor Modification.

categories Node

<categories>
   <category />
</categories>

category (required): the name of the Armor Category. This list populates the Category list found in the Select Armor window. Categories are used to group Armor into groups such as Armor, Clothing, and Military Grade Armor.

armor Node

<armor>
   <id />
   <name />
   <category />
   <addoncategory />
   <armorvalue />
   <armorcapacity />
   <avail />
   <cost />
   <bonus />
   <addmodcategory />
   <mods />
   <gears />
   <source />
   <page />
</armor>

id (required): a unique identifier (GUID) for the Armor.

name (required): the name of the piece of Armor.

category (required): the Category that this Armor belongs to. This must match one of the Categories defined in the categories Node.

addoncategory (optional): additional Gear categories that can be added to the Armor as plugins. This must match one of the Categories defined in gear.xml.

armorvalue (required): the Armor's Armor Rating.

armorcapacity (required): the Armor's Capacity.

avail (required): the Armor's Availability.

cost (required): the Armor's Cost in Nuyen. May contain a variable value such as Variable(20-100) or Variable(10000+) to give the item a variable cost.

bonus (optional): a bonus node that describes any bonuses this entry grants. Values may contain the Rating keyword if Ratings are enabled. See Improvement Manager for more information.

addmodcategory (optional): when present, Armor Modifications in this special Category will be added to the list of available Armor Modifications. This is used when certain Armor Modifications is specific to certain pieces of Armor. See mod Node for more information.

mods (optional): lists the Armor Modifications that come pre-installed with the Armor. See mods Node for more information.

gears (optional): used to define Gear that comes pre-installed with the Armor. See gears Node for more information.

source (required): the code for the Sourcebook that this entry comes from. See books.xml.

page (required): the page number this item can be found on in the Sourcebook.

mods Node

<mods>
   <name />
</mods>

name (required): specifies an Armor Modification that comes pre-installed with the Armor. This node may appear multiple times. The value entered here must match the name of an Armor Modification. See mod Node for more information. This node may also have the rating attribute which specifies the Rating of the Armor Modification installed. (<name rating="4">My Armor Mod</name>)

gears Node

<gears>
   <usegear />
</gears>

usegear (required): used to directly reference an existing Gear item as being a part of this Armor. This node may appear multiple times. Attribute rating may be provided to specify the Gear's Rating. Attribute select may be provided to select a particular value.

mod Node

<mod>
   <name />
   <category />
   <armorvalue />
   <maxrating />
   <armorcapacity />
   <avail />
   <addweapon />
   <cost />
   <bonus />
   <source />
   <page />
</mod>

name (required): the name of the Armor Modification.

category (required): the Category that this Armor Modification belongs to. This should be set to General if the Armor Modification can be added to any piece of Armor. If this Armor Modification is exclusive one or more particular pieces of Armor, category can be set to a value of your choosing, such as Bunker Gear Helmet. This category can then be used by addmocategory in the armor Node.

armorvalue (required): the Armor Modification's Armor Rating. This value is added to the base Armor's Rating.

maxrating (required): the maximum Rating for this Armor Modification.

armorcapacity (required): the Capacity this Armor Modification consumes. Pieces that consume Capacity should be enclosed in square brackets, identical to the style found in the Shadowrun 4 sourcebook. This Capacity amount only applies to Armor Suits as standard Armor instead uses the item's Rating to determine the Capacity consumed (see Maximum Armor Modifications and Armor Suit Capacity found on AR 44).

avail (required): the Armor Modification's Availability. avail can start with + to indicate that it increases the base Armor's Availability instead. avail starting with + can also include R or F to change its Availability. For example +3R would add 3 to the parent item's Availability and make it Restricted if it was not already. This will not downgrade an item from Forbidden to Restricted - this highest restriction is always kept.

addweapon (optional): when this piece of Cyberware is added, Chummer looks for a Weapon in weapons.xml and adds it to the character. The value must match the name of a Weapon exactly. This is used to add Cyberweapons to a character through an Armor Modification.

cost (required): the Armor Modification's Cost in Nuyen. This value is added to the base Armor's Cost. May contain the Rating keyword.

bonus (optional): a bonus node that describes any bonuses this entry grants. Values may contain the Rating keyword if Ratings are enabled. See Improvement Manager for more information.

source (required): the code for the Sourcebook that this entry comes from. See books.xml.

page (required): the page number this item can be found on in the Sourcebook.