Template:Equipment page

From Baldur's Gate 3 Wiki
Revision as of 17:11, 15 July 2023 by Taylan (talk | contribs)
Jump to navigation Jump to search

This template generates entire pages for individual pieces of equipment in the game, such as Studded Leather Armour +1 or Amulet of Misty Step. Supported Equipment types: Clothing, Light Armour, Medium Armour, Heavy Armour, Shields, Amulets, Belts, Boots, Cloaks, Gloves, Helmets, Rings. For Weapons, use Template:WeaponPage. For Consumables and other miscellaneous items, use Template:MiscItemPage.

Following is an example of usage with all possible template parameters shown. This describes a completely made-up uncommon Leather Armour with an AC of 12 and a couple special properties.

Copy example values exactly as listed, including capitalization and plurals, if any. If you're ever unsure what to type, simply leave the parameter empty.

{{EquipmentPage
| <!-- See here for tips on how to use this template: https://bg3.wiki/wiki/Template:EquipmentPage -->
| image = Leather Armour PlusOne Icon.png
| description = '''Cool Armour''' is an uncommon [[Armour#Light Armour|Light Armour]] that increases [[Strength]] [[Saving Throw]]s and allows the wearer to cast a neat spell. <!-- This is the first text that will appear on the page. Briefly describe what the item is and what makes it noteworthy. -->
| quote = The in-game flavor text in the item's tooltip.
| type = Light Armour <!-- Item type. Choose one of: Clothing, Light Armour, Medium Armour, Heavy Armour, Shields, Amulets, Belts, Boots, Cloaks, Gloves, Helmets, Rings -->
| proficiency = Light Armour <!-- Leave EMPTY if no proficiency needed, otherwise choose from: Light Armour, Medium Armour, Heavy Armour, Shields -->
| armour class = 12 <!-- Leave EMPTY for non-Armour/non-Clothing, otherwise: the Armour Class value displayed on the Armour's tooltip. -->
| armour class bonus = <!-- Leave EMPTY for non-Shields, otherwise: the bonus to AC granted by wearing this item, e.g.: +2, +3, +4 -->
| stealth disadvantage = <!-- Does this item grant disadvantage on stealth checks? LEAVE EMPTY if no! -->
| enchantment = <!-- Leave EMPTY for none, otherwise: +1, +2, +3, +4, +5 -->
| rarity = uncommon <!-- Choose from: common, uncommon, rare, very rare, legendary, story -->
| weight kg = 4.5
| weight lb = 9.9
| price = 600
| special = <!-- List of special features, bonuses, or abilities granted by the item. -->
* '''[[Strength]] [[Saving Throw]]s:''' +1
* '''Super Cool Ability:''' Once per [[Long Rest]] you can use this awesome ability of this item.
| where to find = <!-- Describe where and how to obtain the item. -->
This is a made-up piece of equipment.  You cannot obtain it anywhere in the game.
}}

See here for the result of the above: Template:EquipmentPage/Example

This template defines the table "equipment". View table.


Auto-generated TemplateData follows from this point on.


This template generates entire pages for individual pieces of equipment in the game. Supported Equipment types: Clothing, Light Armour, Medium Armour, Heavy Armour, Shields, Amulets, Belts, Boots, Cloaks, Gloves, Helmets, Rings. (For Weapons, use Template:WeaponPage. For Consumables and other miscellaneous items, use Template:MiscItemPage.) Copy example values exactly as listed, including capitalization and plurals, if any. If you're ever unsure what to type, simply leave the parameter empty.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
imageimage

The filename of the image/icon associated with this item.

Example
Amulet of Misty Step Icon.png
Filesuggested
descriptiondescription

The first text that will appear on the page. Briefly describe what the item is and what makes it noteworthy.

Example
{{uncommon|Amulet of Misty Step}} is an uncommon [[Amulets|Amulet]] that allows the wearer to cast [[Misty Step]].
Contentrequired
quotequote

The in-game flavour text in the item's tooltip.

Contentsuggested
where to findwhere to find

Describe where and how to obtain the item.

Example
Looted from [[NPC Name]] in [[Location]].
Contentsuggested
typetype

Item type. Choose one of: Clothing, Light Armour, Medium Armour, Heavy Armour, Shields, Amulets, Belts, Boots, Cloaks, Gloves, Helmets, Rings

Suggested values
Clothing Light Armour Medium Armour Heavy Armour Shields Amulets Belts Boots Cloaks Gloves Helmets Rings
Stringrequired
proficiencyproficiency

Leave EMPTY if no proficiency required, otherwise choose from: Light Armour, Medium Armour, Heavy Armour, Shields

Suggested values
Light Armour Medium Armour Heavy Armour Shields
Stringsuggested
armour classarmour class

Leave EMPTY for non-Armour/non-Clothing, otherwise: the Armour Class value displayed on the Armour's tooltip.

Example
12
Numbersuggested
armour class bonusarmour class bonus

Leave EMPTY for non-Shields, otherwise: the bonus to AC granted by wearing this item, e.g.: +2, +3, +4

Example
+2
Stringsuggested
stealth disadvantagestealth disadvantage

Does this item grant disadvantage on stealth checks? LEAVE EMPTY if no!

Suggested values
yes
Stringsuggested
rarityrarity

Choose from: common, uncommon, rare, very rare, legendary, story

Suggested values
common uncommon rare very rare legendary story
Stringrequired
enchantmentenchantment

The enchantment value on the item. Leave EMPTY for none, otherwise: +1, +2, +3, +4, +5

Example
+1
Stringsuggested
weight kgweight kg

Weight of the item in kilograms

Numberrequired
weight lbweight lb

Weight of the item in pounds

Numberrequired
priceprice

Price/value of the item. When two values are listed on the tooltip, use the crossed out "true" value, not the adjusted buy/sell price.

Numberrequired
specialspecial

List of special features, bonuses, or abilities granted by the item.

Example
* '''Super Cool Ability:''' Once per [[Long Rest]] you can use this awesome ability of this item.
Contentsuggested