Template:Weapon page
This template generates entire pages for individual weapons in the game, such as Longsword (not to be confused with Longswords) or Worgfang. Note that the template adds the page to the correct categories automatically.
Following is an example of usage with all possible template parameters shown and explained with HTML comments. This describes a made up Longsword which for some reason deals an extra 1d4 Fire damage and is Heavy (longswords normally aren't). If you're ever unsure what to type, simply leave the parameter empty.
Please don't copy-paste this example code into any actual page you create. There's examples for copy-pasting further below.
{{WeaponPage <!-- A high-res image of the item. --> | image = Longsword Icon.png <!-- A smaller image of the item, to be used as an icon. Falls back to the value of "image" if not provided --> | icon = <!-- Optional description. Nonmagical and +1/+2/etc. will be auto-generated, so leave empty for those. Others will also have a sensible default description generated, so strictly speaking you can always leave this empty, but for weapons with special properties, you might want to instead provide a short description of what makes the weapon noteworthy. --> | description = <!-- In-game tooltip quote. --> | quote = The in-game flavor text in the item's tooltip. <!-- "martial" or "simple" --> | category = martial <!-- "melee" or "ranged" --> | melee or ranged = melee <!-- "one-handed", "versatile", or "two-handed" --> | handedness = versatile <!-- One of [[Category:Weapon Types]]. Always plural! --> | type = Longswords <!-- Leave EMPTY for common, otherwise: uncommon, rare, very rare, legendary, story --> | rarity = <!-- Leave EMPTY for none, otherwise: +1, +2, +3, +4, +5 --> | enchantment = <!-- Must follow the strict format "XdY + Z", with the "+ Z" only needed if the weapon has an enchantment. --> | damage = 1d8 + 1 <!-- Accepts any of [[Damage Types]], but usually: Slashing, Piercing, or Bludgeoning --> | damage type = Slashing <!-- Same format as regular damage, or leave EMPTY if this isn't a Versatile weapon. --> | versatile damage = 1d10 + 2 <!-- Same format as regular damage, but with damage type directly on the same line. --> | extra damage = 1d4 Fire <!-- Same format as regular damage, but with damage type directly on the same line. --> | extra damage 2 = 1d6 Acid <!-- Leave EMPTY if melee, otherwise this can be "normal", "short" (e.g. Hand Crossbow), or "special" --> | range = <!-- Leave EMPTY if "range" is NOT "special", otherwise provide the range in meters and in feet. --> | range m = | range ft = <!-- Following are yes/no properties, which MUST BE EMPTY if you mean "no"! Never actually type "no"! --> | finesse = | heavy = | light = | reach = | thrown = | can't dual wield = | dippable = yes <!-- The weight in kg and in lb. --> | weight kg = 1.35 | weight lb = 2.7 <!-- The price in gp as shown in the normal tooltip (NOT while buying or selling). --> | price = 75 <!-- The uid for the item, usually in format "MAG_SomeDescription_Something". --> | uid = OBJ_Longsword <!-- The uid or Root Template for the item. --> | uuid = 3d99b0ae-4e96-438a-8029-cce11109f415 <!-- Actions you get when you have proficiency and wield the weapon in your main-hand. --> | weapon actions = Pommel Strike, Lacerate, Rush Attack <!-- List of special features or abilities granted by the weapon. --> | special = * '''Super Cool Ability:''' Once per [[Long Rest]] you can use this awesome ability of this weapon. <!-- Describe where and how to obtain the weapon, if it's a special one. --> | where to find = This is a made-up weapon. You cannot obtain it anywhere in the game. }}
Following is a blank starting point for using this template that you can copy-paste. You can also view the source of this page and copy-paste one of the actual examples further below.
{{WeaponPage <!-- See here for tips on how to use this template: https://bg3.wiki/wiki/Template:WeaponPage --> | image = | description = | quote = | category = | melee or ranged = | handedness = | type = | rarity = | enchantment = | damage = | damage type = | versatile damage = | extra damage = | extra damage 2 = | range = | range m = | range ft = | finesse = | heavy = | light = | reach = | thrown = | can't dual wield = | dippable = | weight kg = | weight lb = | price = | uid = | uuid = | weapon actions = | special = | where to find = }}
Live examples of this template's usage follow. Feel free to view this page's source and copy-paste one of them as a starting point.
Longsword
Weapon page is a special variant of the Longswords family of weapons. It is a martial melee weapon that can be wielded in one hand, or with both hands for extra damage.
The in-game flavor text in the item's tooltip.
Properties
- One-handed damage:
- 1d8 + 1 (2~9) + Strength modifier Slashing
- Two-handed damage:
- 1d10 + 2 (3~12) + Strength modifier Slashing
- Extra damage:
- 1d4 (1~4) Fire
- 1d6 (1~6) Acid
- Details:
- Rarity: Common
- Enchantment: None
- Versatile
- Dippable
- Melee: 1.5 m / 5 ft
- Weight: 1.35 kg / 2.7 lb
- Price: 75 gp
UID
OBJ_Longsword
Special
The holder of this item gains:
- Super Cool Ability: Once per Long Rest you can use this awesome ability of this weapon.
Weapon Actions
If you have proficiency, equip in main hand to gain:
- Pommel Strike ()
Make a non-lethal attack against an enemy and possibly them.
- Lacerate ()
Slash at your target's vital points to make it .
- Rush Attack ()
Charge forward and attack the first enemy in your way, possibly pushing them .
Where to find
This is a made-up weapon. You cannot obtain it anywhere in the game.
Dagger
Weapon page is a special variant of the Longswords family of weapons. It is a simple melee weapon wielded in one hand. As a finesse weapon, it can benefit from the wielder's Dexterity and not just their Strength. It's a light weapon that anyone can dual-wield without special training. Its design lends itself well to be thrown at enemies as a projectile.
The in-game flavor text in the item's tooltip.
Properties
- Damage:
- 1d4 + 1 (2~5) + Strength or Dexterity modifier Piercing
- Details:
- Rarity: Common
- Enchantment: None
- One-Handed
- Finesse
- Light
- Thrown
- Dippable
- Melee: 1.5 m / 5 ft
- Weight: 1.35 kg / 2.7 lb
- Price: 75 gp
Special
The holder of this item gains:
- Super Cool Ability: Once per Long Rest you can use this awesome ability of this weapon.
Weapon Actions
If you have proficiency, equip in main hand to gain:
- Piercing Strike ()
Stab an enemy and possibly inflict .
Where to find
This is a made-up weapon. You cannot obtain it anywhere in the game.
This template defines the table "weapons". View table.
(Auto-generated TemplateData follows.)
This template generates entire pages for individual weapons in the game. (For other Equipment, use Template:EquipmentPage. For Consumables and other miscellaneous items, use Template:MiscItemPage.)
Parameter | Description | Type | Status | |
---|---|---|---|---|
name | name | The name of the item -- can be left out to use the page name automatically.
| String | suggested |
image | image | The filename of the image/icon associated with this item.
| File | required |
icon | icon | The icon of this item. Defaults to the value of image= if not provided. | Unknown | optional |
category | category | The weapon's overall proficiency category (martial or simple)
| String | required |
description | description | Optional, BRIEF description of what is notable about this weapon. If left empty, a basic description will be auto-generated for you based on the other information you've entered in the template.
| Content | suggested |
quote | quote | The in-game flavour text in the weapon's tooltip. | String | suggested |
where to find | where to find | Describe where and how to obtain the weapon (can leave empty if it's super commonly obtainable).
| Content | suggested |
type | type | The weapon's specific type. Always plural.
| String | required |
rarity | rarity | The rarity level of the weapon (common, uncommon, rare, very rare, legendary, story)
| String | required |
melee or ranged | melee or ranged | no description
| String | required |
handedness | handedness | no description
| String | required |
damage | damage | The damage of the weapon (the one-handed damage, in the case of Versatile weapons). Must follow the strict format XdY + Z, with the "+ Z" only needed if the weapon has an enchantment.
| String | required |
versatile damage | versatile damage | Same format as regular damage. Leave EMPTY if this weapon is not Versatile.
| String | suggested |
damage type | damage type | The damage type of the weapon
| String | required |
extra damage | extra damage | Any extra damage granted by this weapon. Leave EMPTY if this weapon does not receive a damage bonus aside from its enchantment. Otherwise, same format as regular damage, but with damage type directly on the same line.
| String | suggested |
extra damage 2 | extra damage 2 | Additional extra damage, like if the weapon deals and extra 1d4 Fire AND an extra 1d4 Acid or something.
| String | suggested |
enchantment | enchantment | The value of the enchantment on the weapon. Leave blank if no enchantment.
| String | suggested |
range | range | This is for ranged weapons only. Leave EMPTY if melee; otherwise choose one of the suggested values. "short" in this context refers to the shorter range of Hand Crossbows.
| String | suggested |
special range m | range m | Leave EMPTY unless range is "special." Special range of the weapon in meters.
| Number | suggested |
special range ft | range ft | Leave EMPTY unless range is "special." Special range of the weapon in feet.
| Number | suggested |
finesse | finesse | Does this weapon have the Finesse property? (Leave BLANK if no!)
| String | suggested |
heavy | heavy | Does this weapon have the Heavy property? (Leave BLANK if no!)
| String | suggested |
light | light | Does this weapon have the Light property? (Leave BLANK if no!)
| String | suggested |
reach | reach | Does this weapon have the Extra Reach property? (Leave BLANK if no!)
| String | suggested |
thrown | thrown | Does this weapon have the Thrown property? (Leave BLANK if no!)
| String | suggested |
can't dual wield | can't dual wield | Does this weapon have the Can't Dual Wield property? (Leave BLANK if no!)
| String | suggested |
dippable | dippable | Does this weapon have the Dippable property? (Leave BLANK if no!)
| String | suggested |
weight kg | weight kg | Weight of the weapon in kilograms
| Number | required |
weight lb | weight lb | Weight of the weapon in pounds
| Number | required |
price | price | 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.
| Number | required |
uid | uid | Unique id for the item. Often in format OBJ_Blabla_Whatever | Unknown | optional |
uuid | uuid | UUID or Root Template for the item. In a uuid format like " 3d99b0ae-4e96-438a-8029-cce11109f415" | Unknown | optional |
special | special | Any special features granted to the wielder of the weapon. Separate multiple special features with bullets.
| Content | suggested |
weapon actions | weapon actions | List of Weapon Actions gained by wielding this weapon in the main hand. Be sure to separate multiple actions with a comma.
| Content | suggested |