Jump to content

Template:Weapon/doc: Difference between revisions

From Drifters Almanac
Created page with "== Template:Weapon == This template creates a detailed and consistent layout for non crafted weapons. It includes support for stats, positional bonuses, level/class requirements, acquisition info, additional stats, and a gallery. == Usage == <pre> {{WeaponTest | name = | tooltip_image = | model_image1 = | model_image2 = | model_image3 = | weapon_type = | durability = | damage_min = | damage_max..."
 
No edit summary
 
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Template:Weapon ==
<div style="font-size: 1.5em; font-weight: bold; margin-top: 1em;">Overview</div>
This template creates a detailed and consistent layout for non crafted weapons. It includes support for stats, positional bonuses, level/class requirements, acquisition info, additional stats, and a gallery.
<hr style="border: 0; border-top: 1px solid #555;" />
This template provides a standardized layout for weapons.<br>
It supports stats, positional bonuses, requirements, acquisition info, additional stats, galleries, and optional crafting info.<br>
Use this template for all melee and ranged weapons.


== Usage ==
<div style="font-size: 1.5em; font-weight: bold; margin-top: 1em;">Create a Weapon</div>
<pre>
<hr style="border: 0; border-top: 1px solid #555;" />
{{WeaponTest
For a guided, form-based workflow, click the "Create a Weapon" button in the [[Create Center]].
| name              =
| tooltip_image      =  
| model_image1      =
| model_image2      =
| model_image3      =
| weapon_type        =
| durability        =
| damage_min        =
| damage_max        =
| delay              =
| range              =
| angle              =
| OHAC              =
| stat1_name        =
| stat1_value        =
| stat2_name        =
| stat2_value        =
| stat3_name        =
| stat3_value        =
| stat4_name        =
| stat4_value        =
| stat5_name        =
| stat5_value        =
| front_value        =
| front_type        =
| front_percentage  =
| side_value        =
| side_type          =
| side_percentage    =
| rear_value        =
| rear_type          =
| rear_percentage    =
| level_requirement  =
| class_requirement1 =
| class_requirement2 =
| class_requirement3 =
| how_to_acquire    =
| is_soulbound      =
| sale_price        =
}}
</pre>


== Parameters ==
<div style="font-size: 1.5em; font-weight: bold; margin-top: 1em;">Parameters</div>
<hr style="border: 0; border-top: 1px solid #555;" />


=== General ===
<div style="font-size: 1.3em; font-weight: bold; margin-top: 1em;">General</div>
;name: Weapon name (defaults to the page name)
;name: Weapon name (defaults to the page name)
;tooltip_image: Tooltip image filename (keep these cleanly cropped and with as solid/dark of a background as possible)  
;tooltip_image: Filename of the tooltip image (omit the File: prefix)
;model_image1–3: Up to three additional model images
;is_soulbound: Set to **yes** to mark the item soulbound


=== Stats ===
<div style="font-size: 1.3em; font-weight: bold; margin-top: 1em;">Stats</div>
;weapon_type: Weapon classification (e.g., 1H Mace) — links to and categorizes under its type
;weapon_type: Type of weapon (e.g., 1H Sword) – links and categorizes automatically
;durability: Maximum durability value
;durability: Maximum durability
;damage_min / damage_max: Base damage range
;damage_min / damage_max: Base damage range
;delay: Time between attacks in seconds (seconds unit add automatically)
;dice_roll: Underlying dice formula (e.g., 2d4+20)
;range: Effective attack range
;delay: Attack delay in seconds
;angle: Arc of attack (° symbol is added automatically)
;range: Attack range in meters
;OHAC: Off-Hand Ability Contribution (percentage symbol added automatically)
;angle: Attack arc in degrees
;OHAC: Off-Hand Ability Contribution (percent)


=== Additional Stats (Optional) ===
<div style="font-size: 1.3em; font-weight: bold; margin-top: 1em;">Additional Stats (Optional)</div>
Supports up to 5 extra stats via:
Supports up to 6 extra stats via:<br>
;stat1_name / stat1_value (→ stat5_name / stat5_value): Stat name and its value
;stat1_name / stat1_value … stat6_name / stat6_value — each links and categorizes by stat
* Each stat name will automatically:
  - Link to its category (e.g. [[:Category:Penetration]])
  - Categorize the weapon under that stat’s category


=== Positional Bonuses ===
<div style="font-size: 1.3em; font-weight: bold; margin-top: 1em;">Positional Bonuses</div>
;front_value / front_type / front_percentage
;front_value / front_type / front_percentage<br>
;side_value / side_type / side_percentage
;side_value / side_type / side_percentage<br>
;rear_value / rear_type / rear_percentage
;rear_value / rear_type / rear_percentage
Displays as: `X [type] +Y% Positional`


=== Requirements ===
<div style="font-size: 1.3em; font-weight: bold; margin-top: 1em;">Requirements</div>
;level_requirement: Minimum required level
;level_requirement: Minimum level
;class_requirement1–3: Up to three eligible classes (each links to its class page)
;class_requirement1–3: Eligible classes (links automatically)


=== Acquisition & Sale ===
<div style="font-size: 1.3em; font-weight: bold; margin-top: 1em;">Acquisition &amp; Rewards</div>
;how_to_acquire: Where or how to get the weapon
;dropped_by: Comma-separated list of mobs that drop this weapon
;is_soulbound: Set to any value to display soulbound notice
;sold_by: Comma-separated list of vendors selling this weapon
;sale_price: Vendor sale price (e.g., 15G 22S 11C)
;quest_reward: Quest page rewarded by this weapon


== Notes ==
<div style="font-size: 1.3em; font-weight: bold; margin-top: 1em;">Sell Price</div>
* Weapon type is both linked to and categorized automatically.
;sell_price_gold / sell_price_silver / sell_price_copper — vendor sell values
* Positional bonuses use dedicated percentage fields for clarity.
* All unused fields are hidden automatically.
* The gallery supports 1–3 images and displays only defined ones.
* The `AdditionalStats` subtemplate is used to unify extra stat formatting across item types.


== Example ==
<div style="font-size: 1.3em; font-weight: bold; margin-top: 1em;">Gallery</div>
;model_image1–3: Filenames of in-game model renders (1–3 images)
 
<div style="font-size: 1.3em; font-weight: bold; margin-top: 1em;">Crafting Info (Optional)</div>
;crafting_profession / recipe_page — if weapon is craftable
;component#_name / component#_material / component#_material_category — up to 5 components
 
<div style="font-size: 1.5em; font-weight: bold; margin-top: 1em;">Notes</div>
<hr style="border: 0; border-top: 1px solid #555;" />
* Unused fields are hidden automatically.
* All links and categories are handled by semantic properties.
 
<div style="font-size: 1.5em; font-weight: bold; margin-top: 1em;">Example</div>
<hr style="border: 0; border-top: 1px solid #555;" />
See [[Sturdy Copper Mace]] for a working example.
See [[Sturdy Copper Mace]] for a working example.

Latest revision as of 11:15, 28 May 2025

Overview

This template provides a standardized layout for weapons.
It supports stats, positional bonuses, requirements, acquisition info, additional stats, galleries, and optional crafting info.
Use this template for all melee and ranged weapons.

Create a Weapon

For a guided, form-based workflow, click the "Create a Weapon" button in the Create Center.

Parameters
General
name
Weapon name (defaults to the page name)
tooltip_image
Filename of the tooltip image (omit the File: prefix)
is_soulbound
Set to **yes** to mark the item soulbound
Stats
weapon_type
Type of weapon (e.g., 1H Sword) – links and categorizes automatically
durability
Maximum durability
damage_min / damage_max
Base damage range
dice_roll
Underlying dice formula (e.g., 2d4+20)
delay
Attack delay in seconds
range
Attack range in meters
angle
Attack arc in degrees
OHAC
Off-Hand Ability Contribution (percent)
Additional Stats (Optional)

Supports up to 6 extra stats via:

stat1_name / stat1_value … stat6_name / stat6_value — each links and categorizes by stat
Positional Bonuses
front_value / front_type / front_percentage
side_value / side_type / side_percentage
rear_value / rear_type / rear_percentage
Requirements
level_requirement
Minimum level
class_requirement1–3
Eligible classes (links automatically)
Acquisition & Rewards
dropped_by
Comma-separated list of mobs that drop this weapon
sold_by
Comma-separated list of vendors selling this weapon
quest_reward
Quest page rewarded by this weapon
Sell Price
sell_price_gold / sell_price_silver / sell_price_copper — vendor sell values
Gallery
model_image1–3
Filenames of in-game model renders (1–3 images)
Crafting Info (Optional)
crafting_profession / recipe_page — if weapon is craftable
component#_name / component#_material / component#_material_category — up to 5 components
Notes
  • Unused fields are hidden automatically.
  • All links and categories are handled by semantic properties.
Example

See Sturdy Copper Mace for a working example.

Retrieved from "https://drifters-almanac.com/index.php?title=Template:Weapon/doc&oldid=2210"