Template:Equipment page

Template page
Revision as of 07:10, 17 February 2023 by Majesstic (talk | contribs)

This template generates entire pages for individual pieces of equipment in the game, such as Studded Leather Armour +1 or Amulet of Misty Step.

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 -->
| armourclass = 12 <!-- Leave EMPTY for non-Armour, otherwise: the Armour Class value displayed on the Armour's tooltip. -->
| armourclassbonus = <!-- 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

Note that the template even adds the page to the correct categories. And for the same reason, it shouldn't be invoked here for the purpose of showing how the results look; that would result in this template page being added to the categories to which equipment pages are added.

This template generates entire pages for individual pieces of equipment in the game, such as [[Studded Leather Armour +1]] or [[Amulet of Misty Step]]. 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.

Template parameters

ParameterDescriptionTypeStatus
imageimage

Image to display prominently (typically the item's icon)

Example
Amulet of Misty Step Icon.png
Filesuggested
descriptiondescription

no description

Unknownoptional
quotequote

no description

Unknownoptional
where to findwhere to find

no description

Unknownoptional
typetype

no description

Unknownoptional
proficiencyproficiency

no description

Unknownoptional
armourclassarmourclass

no description

Unknownoptional
armourclassbonusarmourclassbonus

no description

Unknownoptional
stealth disadvantagestealth disadvantage

no description

Unknownoptional
rarityrarity

no description

Unknownoptional
enchantmentenchantment

no description

Unknownoptional
weight kgweight kg

no description

Unknownoptional
weight lbweight lb

no description

Unknownoptional
priceprice

no description

Unknownoptional
specialspecial

no description

Unknownoptional
nocategoriesnocategories

no description

Unknownoptional