# Equipment Files

The first field is the item's name and is required. This first list of tags is relevant to all equipment

*** Updated

Tag Name: BASEITEM:x

Variables Used (x): Text (name of base item)

What it does:

- Allows creation of a specific weapon based on another existing item.
- BASEITEM must be used in conjunction with an EQMOD tag.
- Other tags may be added, that will be applied after the EQMOD is applied to the BASEITEM.

Example:

`Davril's Longsword
BONUS:COMBAT|DAMAGE,TOHIT|2
BASEITEM:Longsword
EQMOD:Bane.Holy.Keen`

Creates a piece of equipment called "Davril's Longsword" that is a +2 weapon. The SPROPS and effects from the equipment modifiers "Bane", "Holy" and "Keen" (as seen in the item customeizer in PGen) will appear in the attack numbers and special properties as appropriate.

Tag Name: BASEQTY:x

Variables Used (x): Number (standard bundle quantity)

What it does:

The numeric value supplied is the number of items in this bundle. ie. Arrows (20) should have.

Example:

`BASEQTY:20`

20 items in a bundle (e.g. Arrows).

Tag Name: COST:x

Variables Used (x): Number (gold coin cost)

What it does:

The cost of the item.

Example:

`COST:5`

Item costs 5 gold peices.

*** Updated

Tag Name: CONTAINS:x|y

Variables Used (x): Number (quantity held)

Variables Used (y): Text (Type=<itemtype>)

Variables Used (y): Text (Total=<number>)

What it does:

- This tag is | (pipe) delimited and is used to define how much and what a container can hold.
- Any object with CONTAINS must also be TYPE:Container for the CONTAINS tag to be activated.
- The 1st number is the maximum weight the container can hold.
- A * (Asterisk) means that the weight added doesn't change the weight of the container (e.g. a Bag of Holding).
- A number followed by a percentage (%) symbol before the quantity will reduce the total encumbrance weight of items in the container by the percentage specified.
- A -1 means that the container has an unlimited weight allowance.
- The name of the weight unit is defined in the game mode system files in the miscinfo.lst file with the tag WEIGHTUNITABBREV. In most fantasy settings this is lbs.
- After the weight you can specify what types of Items the container may hold.
- If there are no type's specified the container may hold anything
- Specific tags (Potions, Rings, Armor, etc) can be specified with a limit to how many can be in the container (e.g. Scroll Case)
- If specific tags are used the container may only hold the listed object types.
- A limit to the total number of things contained can be specified by setting a Total=x tag.

Examples:

`CONTAINS:500`

500 units of weight can fit in this container.

`CONTAINS:*500`

500 units of weight can fit in this container and this is not added to the PCs carried weight.

`CONTAINS:50%50|Any=25`

Holds up to 25 items of up to 50 units of weight, but the total weight contained is reduced 50%.

`CONTAINS:25%-1|Any=100`

Holds up to 100 items no matter the weight, but total weight contained is reduced 25%.

`CONTAINS:500|Potions=100`

500 units of weight can fit in this container, but only 100 potions fit.

`CONTAINS:-1`

This container has an unlimited weight allowance.

`CONTAINS:-1|Any=100`

Holds 100 things, no matter what the weight.

`CONTAINS:-1|Total=10|Paper=10|Scroll=10`

Holds 10 papers or 10 scrolls, or any combination of these up to 10, no matter what the weight.

Tag Name: EQMOD:x|y|y.x|y|y

Variables Used (x): Text, period delimited (Equipment modifier name)

Variables Used (y): Text, pipe delimited (Modifiers applied to the equipment modifier name)

What it does:

- A period (.) delimited list of equipment modifiers.
- Each element is a pipe (|) delimited list of strings.
- It calls an equipment mod to be applied to the base item before looking at other tags.
- It will take the base item, and automatically apply the equipmod.
- EQMOD is used with BASEITEM. Without BASEITEM, no Equipmod will be applied.
- For an excellent example of the available variables usable with EQMOD see the srdequipmodsmagic.lst file.
- For each of these two files each line has a tag called KEY: this key is what is used with EQMOD to select each of the various mods.

Example:

`Davril's Longsword
BONUS:COMBAT|DAMAGE,TOHIT|2
BASEITEM:Longsword
EQMOD:Bane.Holy.Keen`

Creates a piece of equipment called "Davril's Longsword" that is a +2 weapon. The SPROPS and effects from the equipment modifiers "Bane", "Holy" and "Keen" (as seen in the item customeizer in PGen) will appear in the attack numbers and special properties as appropriate.

`EQMOD:KEEN.BANE|Undead` or `EQMOD:BANE|Undead.KEEN`

Creates a sword that is keen and also has Bane Undead.

`EQMOD:ABILITYPLUS|STR+2`

this applies a +2 STR bonus to the char when using the item.

*** Deprecated - Use the global OUTPUTNAME

Tag Name: LONGNAME:x

Variables Used (x): Text (Item Long Name)

What it does:

This name will be used in place of the default name (the first field).

Example:

`LONGNAME:+5 Bastard Sword of Flaming, Bursting, Holy, Man Smiting`

Item's Long Name.

Tag Name: MODS:x

Variables Used (x): Text (Y, N, or R)

What it does:

Is either Y(es), which means it can have equipment modifiers added to it, N(o), no equipment modifiers can be added, or R(equires) at least 1 equipment modifier in order to purchase the item.

Example:

`MODS:Y`

Item can have equipment modifiers added.

*** Updated 5.5.2

Tag Name: SIZE:x

Variables Used (x): Text (F,D,T,S,M,L,H,G,C)

What it does:

Determines the size of the Item. F=Fine, D=Diminutive, T=Tiny, S=Small, M=Medium, L=Large, H=Huge, G=Gargantuan, C=Colossal.

In third edition rules size of weapons is used in determining Proficiency qualifications and wielding abilities for weapons.

In 3.5 edition rules weapon size no longer determines the actual size of the weapon but instead determines the size of the creature the weapon was made for. WIELD tag is used in determining Proficiency qualifications and wielding abilities for weapons.

Example:

`SIZE:M`

Item is medium size.

Tag Name: SLOTS:x

Variables Used (x): Number (Number of slots it takes to equip an item)

What it does:

This tag is used in weapon lines to set the number of slots required to equip a character with the weapon. The default is one.

Example:

`SLOTS:2`

Weapon requires two hands to wield it.

*** Updated 5.7.1

Tag Name: SPROP:x

Variables Used (x): Text (Special property)

What it does:

- The special property is text that will appear on output sheets under the equipment it is assigned to.
- Variable substitution can be used in the same manor as the SA tag
- The "%" symbol will fill in a number from a variable listed after a "|" (pipe).
- This can be done numerous times, with each successive "%" relating to the next variable listed after another "|" (pipe).
- Each variable needs to be defined (via the global DEFINE tag.)
- SPROP tags can be qualified with PRExxx tags. SPROP tags qualified with PRExxx tags will not display unless the character meets the prerequisites.
- Variable substitution and PRExxx qualifying can be combined in one SPROP tag.

Examples:

`SPROP:Shines with an inner light`

Output sheet reads "Shines with an inner light" under the item.

`SPROP:Squash code bugs % times per day|TL`

For a 5th level character the output sheet would read "Squash code bugs 5 times per day" under the item.

`SPROP:+2 against undead|PRECLASS:Paladin=1`

Outputs the text if the character has at least 1 level of Paladin.

`SPROP:+% vs. code bugs|ColaIntake|PRESKILL:1,Programming=10`

If the character has the Programming skill of at least 10 and the variable "ColaIntake" is defined as equal to 4 then the output sheet reads "+4 vs. code bugs".

*** Updated

Tag Name: TYPE:x.x

Variables Used (x): Text (Item Type)

What it does:

- The TYPE tag is used for many filtering and PRExxx tags. Please follow the conventions used in the Players Rules for the TYPE tag.
- TYPE:Armor items should also have the type of SLOTS it uses. This is usually TYPE:Suit. See BONUS:SLOTS global tag entry for more information.
- TYPE:Container is a special type name. It activates the CONTAINS tag in the item.
- Every TYPE:Weapon item must be also have either TYPE:Melee or TYPE:Ranged (TYPE:Weapon.Melee.Foo)
- TYPE:Double is a special weapon tag. It activates the three ALTxxx tags for the second head statistics.

Example:

`TYPE:Weapon.Simple.Melee.Slashing.Metal`

Item is a Simple Melee Slashing Metal Weapon.

Tag Name: WT:x

Variables Used (x): Number (Item Weight)

What it does:

The weight of the item in question. You can specify any positive number weight or if no weight use a - (dash)

Example:

`WT:5`

Item weighs 5 coins.

## Weapon/Armor Tags

The following tags are for equipment with TYPE:Weapon, TYPE:Armor, or TYPE:Shield.

Notes:

- Every TYPE:Weapon item must be also have either TYPE:Melee or TYPE:Ranged.
- Armor items should also have the type of SLOTS it takes up. This is usually TYPE:Suit

Tag Name: ACCHECK:x

Variables Used (x): Number (Armor Check Penalty)

What it does:

The numeric value supplied is the Armor Check penalty applied to certain skills that have an Armor Check.

Example:

`ACCHECK:10`

Item has an armor check penalty of 10.

Tag Name: ALTCRITICAL:x

Variables Used (x): Number (Secondary attack's critical chance)

What it does:

- The secondary attack's critical chance.
- This is used for double weapons only.
- 1 = 20, 2 = 19 & 20, 3 = 18 - 20, etc

Example:

`ALTCRITICAL:2`

2nd head criticals on roll of 19 or 20.

Tag Name: ALTDAMAGE:x

Variables Used (x): Text (Secondary attack's damage)

What it does:

- The secondary attack's damage.
- This is used for double weapons only.

Example:

`ALTDAMAGE:1d6-1`

2nd head does 1d6-1 damage.

Tag Name: ALTTYPE:x

Variables Used (x): Number (Secondary attack's type)

What it does:

- The secondary attack's type.
- This is used for double weapons only.
- Since this is always in a weapon type, "weapon" should not be included.
- Melee or Ranged MUST be listed and may be different from the 1st head.

Example:

`ALTTYPE:Simple.Melee.Bludgeoning`

2nd head is Simple Melee Bludgeoning.

Tag Name: CRITMULT:x

Variables Used (x): Text (Critical Modifier)

What it does:

This is the weapons critical multiplier as outputted to the character sheet.

Example:

`CRITMULT:x2`

Item has a critical modifier of x2.

Tag Name: CRITRANGE:x

Variables Used (x): Number (Attack's critical chance)

What it does:

- This is the weapons critical threat range.
- 1 = 20, 2 = 19 & 20, 3 = 18 - 20, etc

Example:

`CRITRANGE:2`

Item criticals on roll of 19 or 20.

Tag Name: DAMAGE:x

Variables Used (x): Text (Item Damage)

What it does:

The damage that a weapon does, this is part of the character sheet output.

Example:

`DAMAGE:1d6`

Item damage is 1d6.

Tag Name: HANDS:x

Variables Used (x): Number (Hands required)

What it does:

The required number of hands to use this item. (e.g. a short sword will use HANDS:1, a buckler HANDS:0. The default is 1)

Example:

`HANDS:2`

Item is wielded with 2 hands.

Tag Name: MAXDEX:x

Variables Used (x): Number (Maximum Dexterity Bonus)

What it does:

The numeric value supplied is used for armor to determine the maximum dexterity bonus that can be had while wearing the armor.

Example:

`MAXDEX:3`

Item allow maximum deterity bonus of three when equipped.

Tag Name: PROFICIENCY:x

Variables Used (x): Text (Weapon Proficiency Name)

What it does:

This tells PCGen what Weapon Proficiency name to use from the weapprofs.lst file.

Example:

`PROFICIENCY:Sword (Long)`

Item uses the Longsword wepon proficiency.

*** New

Tag Name: RATEOFFIRE:x

Variables Used (x): Text (Rate of Fire Text)

What it does:

This is the weapon's rate of fire (given as text suitable for output). Most likely only useful in modern and futuristic games.

Example:

`RATEOFFIRE:1`

1 shot per round.

`RATEOFFIRE:0/10/20`

0 shots first round, 10 shots second round and 20 shots on the third.

`RATEOFFIRE:S,A`

Single or Automatic.

`RATEOFFIRE:Single`

Single shot only.

Tag Name: REACH:x

Variables Used (x): Number (Weapon Reach)

What it does:

The numerical value supplied is outputted to the character sheet to show the reach the wielder gains with the weapon.

Example:

`REACH:10`

Item reaches 10 foot.

Tag Name: SPELLFAILURE:x

Variables Used (x): Number (Spell Failure percentage)

What it does:

The numeric value supplied is to show the percentage chance of spell failure when casting a spell while wearing/wielding this item (when item is equipped).

Example:

`SPELLFAILURE:5`

Item causes 5% of arcane spells to fail.

*** New 5.5.2

Tag Name: WIELD:x

Variables Used (x): Light (Weapon is Light)

Variables Used (x): OneHanded (Weapon can be wielded in one hand)

Variables Used (x): TwoHanded (Weapon requires both hands to be wielded effectively)

What it does:

Sets the wield category of a weapon.

In 3.5 edition the rules for wielding a weapon are based on the size category of the weapon and the size category of the PC. Each size category difference between the weapon and PC changes the effective wield category by one step. Thus a Large sized Longsword, a 'OneHanded' weapon, is effectively wield category 'TwoHanded' for a Medium sized PC.

Example:

`WIELD:TwoHanded`

Weapon must be wielded with two hands.

Where it is used:

Equipment files in melee weapon lines.

## Negative Levels & Equipment Files

Items can now grant negative levels. It requires a VFEAT tag and a BONUS tag to be able to do so.

First, a special VFEAT tag must be in place.

Tag Name: VFEAT:x

Variables Used (x): Text ("Negative Levels")

What it does:

Activates the ability of items to bestow negative levels.

Example:

`VFEAT:Negative Levels`

Use "Negative Levels" virtual feat

Secondly, create the item as normal and append to it a special BONUS tag.

Tag Name: BONUS:VAR|NegLevels|x|PREy

Variables Used (x): Number (number of negative levels.)

Variables Used (y): Text (PRE condition for bestowing negative levels)

What it does:

- "NegLevels" is a special predefined variable made specifically for this purpose.
- Use '2', not -2, to bestow 2 negative levels.
- If the NegLevels Variable is 0 (no negative levels applied), then nothing will show, and it will be as if the Negative Levels feat was not even there. :)

Example:

`BONUS:VAR|NegLevels|1|PREALIGN:0,1,3,4,6,7`

Demon Armor bestows 1 negative level to all non-evil characters.