Template:Infobox item/doc

Documentation

[purge]

This template aims to provide a comprehensible and complete way of adding an infobox to an item.

Copied from theforest:Template:Infobox item, this documentation and the template will likely need editing to be more relevant to Sons of the Forest.

Anything that goes into the inventory qualifies as an item. Furthermore, some items used in crafting but not directly collectible are counted as well. These include, but are not limited to, rock or severed animal heads.

Usage

• Use this template to add an infobox to an item
• There are specified parameters for some fields which apply a category to the page. Use these for easy categorization.
• Leave out any fields you are not sure about or that are not applicable for the very item (e.g. |armor for raw rabbit.). Feel free to delete these rows on the item's page.
• If anything needs to be added, feel free to do so (:

Template Ready to Copy

{{Infobox item
|name        = 
|image       = 
|caption     = 
|alias       = 
|added_in    = 
|removed     = 
|type        = 
|location    = 
|obtained    = 
|equipable   = 
|upgradable  = 
|throwable   = 
|consumable  = 
|stewable    =
|spoils      = 
|storage     = 
|health      =
|stamina     =
|hydration   =
|fullness    =
|energy      =
|poison      =
|armor       =
|temperature =
|calories    =
|effects     =
|speed       =
|damage      =
|block       =
|range       =
|stack       =
|itemid      =
|ammo        =
|clip        =
|used_in     =
|used_by     =
|printable   = 
|time        = 
|cost        = 
|count       = 
}}

Template with Explanation

Note: The brackets contain explanations for each field. "Default" means that this is the value appearing in the corresponding row when it is left blank in the template. Leave a field blank if it is not applicable (e.g. "|removed", when the item is still available in game).

{{Infobox item
|name        = Name of the item. Default: name of the page
|image       = Image showing the item. Default: placeholder
|caption     = Caption describing the image in one line
|alias       = Alternative names the item is or used to be known as
|added_in    = Version the item was added. (e.g. [[v.0.60b]], do not link if unknown (v.0.5?)
|removed     = Version the item was removed. (e.g. [[v.0.60b]], do not link if unknown (v.0.5?)
|type        = Type of the item. See below for options
|location    = Where the item can be found
|obtained    = How the item is obtained most commonly. See below for options
|equipable   = Yes/No
|upgradable  = Yes/No
|throwable   = Yes/No
|consumable  = Yes/No
|stewable    = Yes/No
|spoils      = Yes/No
|storage     = 
|health      = Impact on Health (e.g. 100%).
|stamina     = Impact on Stamina (e.g. 50%).
|hydration   = Impact on Hydration (e.g. 25%).
|fullness    = Impact on Fullness (e.g. 15%).
|energy      = Impact on Energy (e.g. 10%).
|poison      = Impact on Poison (e.g. 5%).
|armor       = Armor stats of the item. See below for options
|temperature = Impact on temperature. (e.g. a torch warms)
|effects     = Further effects, if any
|speed       = Speed of a tool/weapon measured in the bar shown in-game
|damage      = Damage of a tool/weapon measured in the bar shown in-game
|block       = Block of a tool/weapon measured in the blocks shown in-game
|range       = Range of a melee weapon. See below for options
|stack       = Maximum units of the item in [[Inventory]]
|itemid      = The ID of the item (can only be found within the game files)
|ammo        = Type of ammo used. Note that e.g. [[Air Canisters]] qualify as ammo too
|clip        = Max. capacity of the ammo. E.g. it's 1 for a [[Bow]], because you have to reload after one shot, and 300s for the [[Rebreather]]
|used_in     = Crafting recipes the item is used in. Separate by <br> (without spaces) to render vertically
|used_by     = Characters the item is seen being used by, if any
|printable   = Yes/No if can be 3d printed
|time        = Time needed to print
|cost        = Cost in resin to print
|count       = How many items are printed
}}

Example

Crafted Club
The crafted club held while blocking.
Description
Also known as	Skull Club
Item type	Weapon
Obtained through	Crafting
Equipable	Yes
Upgradable	Yes
Throwable	No
Statistics
Speed ◼	1
Damage ◼	5 1/2
Block ◼	9
Range	Medium
Max. Stack	1
Used by	Cannibals
3D Printing
Printable	No

{{Infobox item
|name        = Crafted Club
|image       = Crafted Club Icon.png
|caption     = The crafted club held while blocking.
|alias       = Skull Club
|removed     = 
|type        = Weapon
|location    = 
|obtained    = Crafting
|equipable   = Yes
|upgradable  = Yes
|throwable   = No
|consumable  = 
|armor       = 
|temperature = 
|health      = 
|energy      = 
|fullness    = 
|fatigue     = 
|effects     = 
|durability  = 
|speed       = 1
|damage      = 5 1/2
|block       = 9
|range       = Medium
|stack       = 1
|ammo        = 
|clip        = 
|used_by     = [[Cannibals]]
|used_in     = 
|printable   = No
|time        = 
|cost        = 
|count       = 
}}

Currently Possible Parameters

These parameters will add a category to the marked item:

|armor

• Cold Armor (like Hide Armor)
• Stealth Armor (like Leaf Armor)
• Damage Armor (like Bone Armor)

|type

• Tool
• Light
• Weapon
• Melee
• Ranged
• Explosive
• Consumable
• Raw
• Material
• Plant

|obtained

• Collecting (means it is obtainable by simply picking it up somewhere)
• Cooking
• Crafting
• Farming
• Hunting (means killing animals and obtatining it from them)
• Looting (means killing enemies and obtatining it frim them)
• Cheating (using codes or hacks)

|range

• Short (like the Machete)
• Medium (like the Modern Axe)
• Long (like a Crafted Spear)

This is the documentation page, it should be transcluded into the main template page. See Template:Doc for more information.