Template:Equipment page

From Baldur's Gate 3 Wiki
Revision as of 04:46, 11 February 2023 by Majesstic (talk | contribs) (testing - WIP)
Jump to navigation Jump to search

WORK IN PROGRESS - DO NOT USE. This template generates entire pages for individual pieces of equipment in the game, such as Studded Leather Armor +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 Armor with 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 Armor PlusOne Icon.png
| description = '''Cool Armor''' is an uncommon [[Armor#Light Armor|Light Armor]]. <!-- 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 Armor <!-- Item type. Choose one of: Clothing, Light Armor, Medium Armor, Heavy Armor, Shields, Amulets, Belts, Boots, Cloaks, Gloves, Helmets, Rings -->
| proficiency = Light Armor <!-- Leave EMPTY if no proficiency needed, otherwise choose from: Light Armor, Medium Armor, Heavy Armor, Shields -->
| <!-- Following are Armor- and Shield-related properties -->
| armorclass = 12 <!-- Leave EMPTY for non-Armor, otherwise: the Armor Class value displayed on the armor's tooltip. -->
| armorclassbonus = <!-- Leave EMPTY for non-Shields, otherwise: the bonus to AC granted by wearing this item, e.g.: +2, +3, +4 -->
| enchantment = <!-- Leave EMPTY for none, otherwise: +1, +2, +3, +4, +5 -->
| <!-- Following are general properties, which should be filled in for ALL types of equipment. -->
| rarity = uncommon <!-- Leave EMPTY for common, otherwise: uncommon, rare, veryrare, legendary -->
| weight kg = 1.35
| weight lb = 2.7
| price = 75
| 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.