Template:Weapon page/doc

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 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 -->
| name =
| image =
| controller icon =
| icon = 
| 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 =
| passives = 
| passives main hand =
| passives off hand =
| special =
| weapon actions =
| special weapon actions = 
| condition =
| condition duration = 
| condition save =
| condition dc = 
| condition2 =
| condition2 duration = 
| condition2 save =
| condition2 dc =
| where to find =
| notes = 
}}

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. Prefer copy-pasting the completely blank template above.

{{WeaponPage

<!-- The name of the weapon as it is displayed in game, or the page name if not specified -->
| name = 

<!-- A high-res image of the item. -->
| image = Longsword Faded.png

<!-- A smaller, unfaded image of the item, used for the controller interface. Falls back to the value of "image" if not provided -->
| controller icon = Longsword Unfaded.png

<!-- An even smaller image of the item, to be used as an icon. Falls back to the value of "controller icon" if not provided -->
| icon = Longsword Unfaded Icon.png

<!-- 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

<!-- Passives you get when equipped. -->
| passives = 

<!-- Passives you get when equipped only in the main hand. -->
| passives main hand = 

<!-- Passives you get when equipped only in the off-hand. -->
| passives off hand = 

<!-- Actions you get when you have proficiency and wield the weapon in your main-hand. -->
| weapon actions = Pommel Strike, Lacerate, Rush Attack

<!-- Special actions that are found on specific weapons. -->
| special weapon actions = 

<!-- Conditions that this weapon may or may not inflict on every hit. -->
| condition = Dazed
| condition duration = 10
| condition save = WIS
| condition dc = 13
| condition2 = Prone
| condition2 duration = 1
| condition2 save =
| condition2 dc = 

<!-- List of other 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.

}}

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/doc 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

 Longswords

Rarity: Common / UncommonH^Honour

Enchantment: None

 Versatile

 Dippable

 Melee: 1.5 m / 5  ft

 Weight: 1.35 kg / 2.7 lb

Price: 75 gp / 500 gpH^Honour

UID

OBJ_Longsword

UUID

3d99b0ae-4e96-438a-8029-cce11109f415

Special

The holder of this item gains:

• Super Cool Ability: Once per Long Rest you can use this awesome ability of this weapon.

Chilling Counter

When a creature misses you with an attack, it becomes  Chilled for 2 turns.

Weapon actions

If you have proficiency, equip in main hand to gain:

Pommel Strike ()

Make a non-lethal attack against an enemy and possibly  Daze them.

Lacerate ()

Slash at your target's vital points to make it  Bleed.

Rush Attack ()

Charge forward and attack the first enemy in your way, possibly pushing them  Off Balance.

Special weapon actions

This weapon also grants the following:

Grand Slam ()

Slam your weapon into the ground, dealing additional Thunder damage equal to your proficiency bonus, thunderously impacting nearby foes and possibly pushing them away.

Mellow Harmony ()

You make a DC 15 Performance check, success granting all your melee weapon attacks additional damage equal to your Charisma Modifier (minimum 1 additional damage).

Condition: Bless

 Bless

Duration: 1 turn

• Gains a +1d4 bonus to Attack rolls and Saving throws.

Condition: Burning

 Burning

Duration: 3 turns

• Takes 1d4Fire damage per turn.
• Can be removed with the  Help action, using a Healing Potion or gaining  Wet.
• Immune from if  Wet.
•  Dip action can be used on Burning characters and/or objects.

Where to find

• This is a made-up weapon. You cannot obtain it anywhere in the game.

Dagger

Weapon page/doc 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

 Longswords

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.

Main Hand Only

Chilling Counter

When a creature misses you with an attack, it becomes  Chilled for 2 turns.

Off-Hand Only

Dazing Echo

When a creature with  Reverberation deals damage to the wearer, the creature needs to make a Constitution saving throw or become  Dazed.

Weapon actions

If you have proficiency, equip in main hand to gain:

Piercing Strike ()

Stab an enemy and possibly inflict  Gaping Wounds.

Where to find

• This is a made-up weapon. You cannot obtain it anywhere in the game.

Template data

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.)

Template parameters

This template prefers block formatting of parameters.

Parameter		Description	Type	Status
name	name	The name of the item -- can be left out to use the page name automatically. Example Merregon Halberd	String	suggested
image	image	The filename of the image/icon associated with this item. Example Merregon Halberd Icon.png	File	required
controller icon	controller icon	The unfaded controller icon of this item. Defaults to the value of image= if not provided.	File	suggested
icon	icon	The icon of this item. Defaults to the value of controller icon= if not provided.	File	required
category	category	The weapon's overall proficiency category (martial or simple) Suggested values martial 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. Example {{uncommon|Longsword of Slash-Slash}} is an uncommon [[Longsword]] that allows the wielder to slash a lot.	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). Example Looted from [[NPC Name]] in [[Location]].	Content	suggested
type	type	The weapon's specific type. Always plural. Suggested values Battleaxes Clubs Daggers Glaives Greataxes Greatclubs Greatswords Halberds Hand Crossbows Handaxes Heavy Crossbows Javelins Light Crossbows Light Hammers Longbows Longswords Maces Mauls Morningstars Pikes Quarterstaves Rapiers Scimitars Shortbows Shortswords Sickles Spears Tridents War Picks Warhammers Example Longswords	String	required
rarity	rarity	The rarity level of the weapon (common, uncommon, rare, very rare, legendary, story) Suggested values common uncommon rare very rare legendary story Example uncommon	String	required
melee or ranged	melee or ranged	no description Suggested values melee ranged Example melee	String	required
handedness	handedness	no description Suggested values one-handed versatile two-handed Example one-handed	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. Example 1d8 + 1	String	required
versatile damage	versatile damage	Same format as regular damage. Leave EMPTY if this weapon is not Versatile. Example 1d10 + 1	String	suggested
damage type	damage type	The damage type of the weapon Suggested values Slashing Bludgeoning Piercing Example Slashing	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. Example 1d4 Fire	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. Example 1d4 Fire	String	suggested
enchantment	enchantment	The value of the enchantment on the weapon. Leave blank if no enchantment. Suggested values +1 +2 +3 +4 +5 Example +1	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. Suggested values normal short special	String	suggested
special range m	range m	Leave EMPTY unless range is "special." Special range of the weapon in meters. Example 18	Number	suggested
special range ft	range ft	Leave EMPTY unless range is "special." Special range of the weapon in feet. Example 60	Number	suggested
finesse	finesse	Does this weapon have the Finesse property? (Leave BLANK if no!) Suggested values yes	String	suggested
heavy	heavy	Does this weapon have the Heavy property? (Leave BLANK if no!) Suggested values yes Example yes	String	suggested
light	light	Does this weapon have the Light property? (Leave BLANK if no!) Suggested values yes Example yes	String	suggested
reach	reach	Does this weapon have the Extra Reach property? (Leave BLANK if no!) Suggested values yes Example yes	String	suggested
thrown	thrown	Does this weapon have the Thrown property? (Leave BLANK if no!) Suggested values yes Example yes	String	suggested
can't dual wield	can't dual wield	Does this weapon have the Can't Dual Wield property? (Leave BLANK if no!) Suggested values yes Example yes	String	suggested
dippable	dippable	Does this weapon have the Dippable property? (Leave BLANK if no!) Suggested values yes Default yes Example yes	String	suggested
weight kg	weight kg	Weight of the weapon in kilograms Example 1.35	Number	required
weight lb	weight lb	Weight of the weapon in pounds Example 2.7	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. Example 75	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
passives	passives	Any passive features granted to the wielder of the weapon. Separate multiple special features with a comma. Example	Content	suggested
passives main hand	passives main hand	Any passive features granted to the wielder of the weapon while in the main hand only. Separate multiple special features with a comma. Example	Content	suggested
passives off hand	passives off hand	Any passive features granted to the wielder of the weapon while in the off-hand only. Separate multiple special features with a comma. Example	Content	suggested
special	special	Any special features granted to the wielder of the weapon. Separate multiple special features with bullets. Example * '''Super Cool Ability:''' Cast [[Awesome Spell]] once per [[Long Rest]].	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. Example Pommel Strike, Lacerate	Content	suggested
special weapon actions	special weapon actions	List of Weapon Actions gained by wielding this weapon in the main hand. Be sure to separate multiple actions with a comma. Example Hellflame Cleave, Moonlight Butterflies	Content	suggested
this is an example	this is an example	no description	Unknown	optional
seo description	seo description	no description	Unknown	optional
modifier	modifier	Specify the modifier for the weapon's damage. This only needs to be specified in special cases where the weapon does not use the typical damage modifier for its class. Example Strength, spell, none	Content	optional
rarity honour	rarity honour	The rarity in Honour Mode, if it is different	Unknown	optional
price honour	price honour	The price in Honour Mode, if it is different.	Unknown	optional
condition	condition	no description	Unknown	optional
condition save	condition save	no description	Unknown	optional
condition duration	condition duration	no description	Unknown	optional
condition dc	condition dc	no description	Unknown	optional
condition2	condition2	no description	Unknown	optional
condition2 save	condition2 save	no description	Unknown	optional
condition2 duration	condition2 duration	no description	Unknown	optional
condition2 dc	condition2 dc	no description	Unknown	optional
notes	notes	no description	Unknown	optional