User:Borys21/Project:Template index

Overview

This page was created to collect information about Templates on Sons of the Forest Wiki for new editors as well as veteran ones. It's meant to help with understanding and using different Templates across this Wiki. Currently we have Basic, Medium and Intermediate Templates for different uses but one main purpose - to make editing more consistent. You can check different tabs below mainly for: table with short descriptions, more expanded tabs with more info and uses, different tabs showing the infoboxes in use.

Cat.	Template code	What can be put inside	Short description	Input	Output
Text temp- lates	{{BigText|Your text here}}	Custom text	Makes text size same as Header Level 2	{{BT|Example}}	Example
	{{sm|Your text here}}	Custom text	Same function as <small>	{{sm|Example}}	Example
	{{Code|Your text here}}	Custom text	Same function as <code>	{{Code|Example}}	Example
	{{BT|Your text here}}	Custom text	Same function as '''	{{BT|Example}}	Example
	{{Red|Your text here}}	Custom text	Changes text color to red	{{Red|Example}}	Example
	{{Green|Your text here}}	Custom text	Changes text color to green	{{Green|Example}}	Example
	{{CT|Your text here}}	Centers text within	Centers the text inside the template	{{CT|Example text}}	Example text
Img. temp- lates	{{Icon|Icon Name}}	Icons Name from Here	Displays a default-sized icon (50px)	{{Icon|3D Printed Flask}}
	{{Icon|Icon Name|size_px}}	Icon name and custom size in px	Displays an icon with custom size	{{Icon|3D Printed Flask|20px}}
	{{MapIcon|Icon number|Map node id}}	1 and map node id 2 and map node id 3 and map node id 4 and map node id	Add icon with link to external Map using the icon number and map node id which can be found at the end of the link after pressing on selected node	{{MapIcon|1|327}} {{MapIcon|2|546}} {{MapIcon|3|28}} {{MapIcon|4|675}}
	{{AN|image-name}}	Achievements image name from Here	Displays default-sized image (64px)	{{AN|SURVIVOR}}
	{{AN|image-name|size_px}}	As above	Displays custom-sized image	{{AN|SURVIVOR|20px}}
Quick link- ing temp- lates	{{Keycards|CardType}}	Maintenance Guest VIP	Links to a specific keycard tab	{{Keycards|Maintenance}} {{Keycards|Guest}} {{Keycards|VIP}}	Maintenance Keycard Guest Keycard VIP Keycard
	{{Keycards|CardType|Custom name}}	Type from above and custom name	As above and allows for custom naming	{{Keycards|Maintenance|Workers keycard}}	Workers keycard
	{{Log|LogType}}	Full 3/4 Half 1/4	Links to specific log tab	{{Log|Full}} {{Log|3/4}} {{Log|Half}} {{Log|1/4}}	Full Log 3/4 Log Half Log 1/4 Log
	{{Log|LogType|Custom name}}	Type from above and custom name	As above and allows for custom naming	{{Log|Full|Log}}	Log
	{{Plank|PlankSize}}	Full = Full Plank 3/4 = 3/4 Plank Half = Half Plank 1/4 = 1/4 Plank	Links to specific plank tab	{{Plank|Full}} {{Plank|3/4}} {{Plank|Half}} {{Plank|1/4}}	Full Plank 3/4 Plank Half Plank 1/4 Plank
	{{Plank|PlankSize|Custom name}}	Type from above and custom name	As above and allows for custom naming	{{Plank|Full|Split up log}}	Full Plank
	{{Sta|ArrowType}}	N - Normal E - Explosive F - Fire P - Poison S - Shock	Links to specific stone arrow tab	{{Sta|N}} {{Sta|E}} {{Sta|F}} {{Sta|P}} {{Sta|S}}	Normal Stone Arrow Explosive Stone Arrow Fire Stone Arrow Poison Stone Arrow Shock Stone Arrow
	{{Sta|ArrowType|Custom name}}	Type from above and custom name	As above and allows for custom naming	{{Sta|N|Craftable arrow}}	Craftable arrow
	{{3da|ArrowType}}	N - Normal E - Explosive F - Fire P - Poison S - Shock	Links to specific 3D printed arrow tab	{{3da|N}} {{3da|E}} {{3da|F}} {{3da|P}} {{3da|S}}	Normal 3D Printed Arrow Explosive 3D Printed Arrow Fire 3D Printed Arrow Poison 3D Printed Arrow Shock 3D Printed Arrow
	{{3da|ArrowType|Custom name}}	Type from above and custom name	As above and allows for custom naming	{{3da|N|Medium grade arrow}}	Medium grade arrow
	{{cfa|ArrowType}}	1 = Carbon Fiber Arrow 2 = Explosive -||- 3 = Fire -||- 4 = Poison -||- 5 = Shock -||-	Links to specific carbon fiber arrow tab	{{cfa|1}} {{cfa|2}} {{cfa|3}} {{cfa|4}} {{cfa|5}}	Carbon Fiber Arrow Explosive Carbon Fiber Arrow Fire Carbon Fiber Arrow Poison Carbon Fiber Arrow Shock Carbon Fiber Arrow
	{{cfa|ArrowType|Custom name}}	Type from above and custom name	As above and allows for custom naming	{{cfa|1|Strongest arrow type}}	Strongest arrow type
	{{Seeds|SeedType}}	1 = Aloe Vera Seed 2 = Arrowleaf Seed 3 = Blackberry Seed 4 = Blueberry Seed 5 = Chicory Seed 6 = Devil's Club 7 = Fireweed Seed 8 = Guarana Seed 9 = Horsetail Seed 10 = Salmonberry Seed 11 = Snowberry Seed 12 = Twinberry Seed 13 = Yarrow Seed	Links to specific seed tab	{{Seeds|1}} {{Seeds|2}} {{Seeds|3}} {{Seeds|4}} {{Seeds|5}} {{Seeds|6}} {{Seeds|7}} {{Seeds|8}} {{Seeds|9}} {{Seeds|10}} {{Seeds|11}} {{Seeds|12}} {{Seeds|13}}	Aloe Vera Seed Arrowleaf Seed Blackberry Seed Blueberry Seed Chicory Seed Devils Club Seed Fireweed Seed Guarana Seed Horsetail Seed Salmonberry Seed Snowberry Seed Twinberry Seed Yarrow Seed
	{{Seeds|SeedType|Custom name}}	Type from above and custom name	As above and allows for custom naming	{{Seeds|1|Healing plant}}	Healing plant
	{{Bunkers|BunkerType}}	1 = Food and Dining Bunker 2 = Entertainment Bunker 3 = Residential Bunker 4 = Luxury Bunker 5 = Maintenance A 6 = Maintenance B 7 = Maintenance C	Links to specific bunker tab	{{Bunkers|1}} {{Bunkers|2}} {{Bunkers|3}} {{Bunkers|4}} {{Bunkers|5}} {{Bunkers|6}} {{Bunkers|7}}	Food and Dining Bunker Entertainment Bunker Residential Bunker Luxury Bunker Maintenance A Maintenance B Maintenance C
	{{Bunkers|BunkerType|Custom name}}	Type from above and custom name	As above and allows for custom naming	{{Bunkers|1|Main Bunker}}	Main Bunker
	{{Caves|CaveType}}	1 = Rebreather Cave 2 = Rope Gun Cave 3 = Shovel Cave 4 = Ancient Armor Cave 5 = Pickaxe Cave 6 = Artifact Cave 7 = Hell Cave	Links to specific cave tab	{{Caves|1}} {{Caves|2}} {{Caves|3}} {{Caves|4}} {{Caves|5}} {{Caves|6}} {{Caves|7}}	Rebreather Cave Rope Gun Cave Shovel Cave Ancient Armor Cave Pickaxe Cave Artifact Cave Hell Cave
	{{Caves|CaveType|Custom name}}	Type from above and custom name	As above and allows for custom naming	{{Caves|1|Cave A}}	Cave A
	{{Grottos|GrottoNumber}}	1 = Frozen Lake Grotto 2 = Mountainside Grotto 3 = Mountaintop Lake Grotto 4 = Large Lake Grotto 5 = Pond Grotto	Links to specific grotto tab	{{Grottos|1}} {{Grottos|2}} {{Grottos|3}} {{Grottos|4}} {{Grottos|5}}	Frozen Lake Grotto Mountainside Grotto Mountaintop Lake Grotto Large Lake Pond Grotto
	{{Grottos|GrottoNumber|Custom name}}	Type from above and custom name	As above and allows for custom naming	{{Grottos|1|Main Grotto}}	Main Grotto
	{{RL|Anchor Name|ResourceType}}	1 = Building Materials 2 = Crafting Materials 3 = Seeds 4 = Other Resources	Links to the Anchor on Resources page with resource category	{{RL|Building Materials Example|1}} {{RL|Crafting Materials Example|2}} {{RL|Seeds Example|3}} {{RL|Other Resources Example|4}}	Building Materials Crafting Materials Seeds Other Resources
	{{RTL|Tab Name|ResourceType}}	1 = Building Materials 2 = Crafting Materials 3 = Seeds 4 = Other Resources	Links to the Resources type tab used on Resources All tab	{{RTL|Building|1}} {{RTL|Crafting|2}} {{RTL|Seeds|3}} {{RTL|Other|4}}	Building Materials Crafting Materials Seeds Other Resources
	{{WL|Anchor Name|WeaponType}}	1 = Melee 2 = Ranged 3 = Attachment 4 = Explosives	Links to the Anchor on Weapons page with weapons category	{{WL|Melee Example|1}} {{WL|Ranged Example|2}} {{WL|Attachment Example|3}} {{WL|Explosives Example|4}}	Melee Ranged Attachment Explosives
Uti- lity temp- lates	{{TxtAnchor|Anchor name}}	Text anchor	Creates an invisible text anchor	{{TxtAnchor|Example}}	(Invisible anchor)
	{{ImgAnchor|Anchor name|image.png}}	Image anchor	Creates an anchor with an image	{{ImgAnchor|Example|image.png}}	(Anchor with image)
	{{CR|Item Name|Amount}}	Item counter	Displays item amount with it's name as link	{{CR|Rock|5}}	5 Rocks
	{{IC|value=|a=1|s=1|r=1}}	a = additem s = spawnitem r = removeitem	Add code boxed commands that copy the value when the 1 is inside them, can also use only one or two commands	{{IC|value=321|a=1|s=custom|r=1}}	additem 321 spawnitem 321 removeitem 321

Documentation

[purge]

This template aims to provide comprehensible and complete way of adding an infobox to Attachment, Clothing, Documents and Other Items and Resources. Based on JPKMn user wikitable

Usage

• Use this template to add an Portable Infobox to most items.
• If you don't have info or don't feel the need to add it just leave the parameter empty, don't cut it out.
• If anything needs to be added, feel free to do so (:

---

Template ready to use

{{Basic item
|title      = 
|image      = 
|caption    = 
|alias      = 
|obtained   = 
|type       = 
|id         = 
|stack      = 
|added      = 
|consumable = 
|equippable = 
|location   = 
|map        = 
|get        = 
|storage    = 
|uses       = 
|used       = 
}}

---

Template with Explanation

{{Basic item
|title      = Title, by default it's page name
|image      = Filename representing the item
|caption    = Image description if needed
|alias      = Other names for the item
|obtained   = Check the lower page part for more info
|type       = Check the lower page part for more info
|id         = Item ID number
|stack      = Max. inventory stack size
|added      = Version of the game when the item was added
|consumable = Specifies if the item is consumable (Yes/No)
|equippable = Specifies if the item is equippable (Yes/No)
|location   = Where the item can be found
|map        = Linked Icon to map node
|get        = What is needed in order to obtain the item
|storage    = Where the item can be stored
|uses       = For what the item can be used
|used       = Who or what uses/needs the item
}}

---

Example

Cooking Pot
Meta Info
Obtained:	Collecting
Item type:	Tool
Item ID:	517
Stack size:	1
Added in:	Patch 05
Other Info
Consumable:	No
Equippable:	Yes
Location:	Camps
Storage:	• Inventory • Shelf • Wall Shelf
Used for:	Cooking
Used by:	Campfires

{{Basic item
|title      = Cooking Pot
|image      = Cooking Pot Icon.png
|caption    = 
|alias      = 
|obtained   = Collecting
|type       = [[Items#Tool|Tool]]
|id         = 517
|stack      = 1
|added      = [[Patch 05]]
|consumable = No
|equippable = Yes
|location   = [[Locations#Major Locations|Camps]]
|map        = 
|get        = 
|storage    = • [[Inventory]] <br> • [[Prefab Buildings#Shelf|Shelf]] <br> • [[Prefab Buildings#Wall Shelf|Wall Shelf]]
|uses       = [[Cooking]]
|used       = [[Custom Buildings#Stick Structures|Campfires]]
}}

---

Currently usable Parameters

Please only use these parameters to keep all Infoboxes consistent.

|obtained

• Collecting - just picking up
• Cooking    - mixing food in Cooking Pot
• Crafting   - self explanatory
• Farming    - growing plants
• Mining     - self explanatory
• Hunting    - killing animals
• Looting    - opening stuff / killing enemies
• Cheating   - using console commands

|type

• [[Items#Attachment|Attachment]]
• [[Items#Clothing|Clothing]]
• [[Items#Documents|Document]]
• [[Items#Other Items and Resources|Other Item / Resources]]

---

Template data

Template for: Attachments, Clothing, Documents and Other Items and Resources sections.

Template parameters[Edit template data]

Parameter		Description	Type	Status
Title	|title	Title of the item. Default Page name	String	required
Image	|image	Filename representing the item.	String	required
Caption	|caption	Image description if needed.	String	optional
Alias	|alias	Other names for the item.	String	optional
Obtained	|obtained	How the item is obtained. Check this for [https://sonsoftheforest.wiki.gg/wiki/Template:Basic_item/doc#Currently_usable_Parameters Currently usable Parameters].	String	required
Type	|type	Type of the item. Check this for [https://sonsoftheforest.wiki.gg/wiki/Template:Basic_item/doc#Currently_usable_Parameters Currently usable Parameters].	String	required
Item ID	|id	Item ID number.	Number	required
Max. stack size	|stack	Maximum inventory stack size.	Number	required
Game Version	|added	Version of the game when the item was added.	String	required
Consumable	|consumable	Specifies if the item is consumable (Yes/No).	String	required
Equippable	|equippable	Specifies if the item is equippable (Yes/No).	String	required
Location	|location	Where the item can be found.	String	optional
Map	|map	Linked icon to map node.	String	optional
Get	|get	What is needed in order to obtain the item.	String	optional
Storage	|storage	Where the item can be stored.	String	required
Uses	|uses	For what the item can be used.	String	optional
Used	|used	Who or what uses/needs the item.	String	optional

The above documentation is transcluded from User:Borys21/Project:Template index/doc. (edit | history)

Documentation

[purge]

This template aims to provide comprehensible and complete way of adding an infobox to 3D Printables. Based on JPKMn user wikitable

Usage

• Use this template to add an Portable Infobox to most items.
• If you don't have info or don't feel the need to add it just leave the parameter empty, don't cut it out.
• If anything needs to be added, feel free to do so (:

---

Template ready to use

{{3D Printables
|title      = 
|image      = 
|caption    = 
|alias      = 
|obtained   = 
|type       = 
|id         = 
|stack      = 
|added      = 
|time       = 
|cost       = 
|amount     = 
|equippable = 
|storage    = 
|uses       = 
|used       = 
}}

---

Template with Explanation

{{3D Printables
|title      = Title, by default it's page name
|image      = Filename representing the item
|caption    = Image description if needed
|alias      = Other names for the item
|obtained   = Check the lower page part for more info
|type       = Check the lower page part for more info
|id         = Item ID number
|stack      = Max. inventory stack size
|added      = Version of the game when the item was added
|time       = How long the item is being printed
|cost       = How much printer resin it costs
|amount     = How many items will be printed at once
|equippable = Specifies if the item is equippable (Yes/No)
|storage    = Where the item can be stored
|uses       = For what the item can be used
|used       = Who or what uses/needs the item
}}

---

Example

Printed Grappling Hook
Meta Info
Obtained:	Crafting
Item type:	3D Printable
Item ID:	560
Stack size:	10
Added in:	Early Access release
3D Printing
Time to print:	15 sec
Cost to print:	100 ml
Amount printed:	2 pcs
Other Info
Equippable:	No
Storage:	• Inventory • Shelf • Wall Shelf
Used by:	Zipline Rope

{{3D Printables
|title      = Printed Grappling Hook
|image      = Zipline Hook Icon.png
|caption    = 
|alias      = 
|obtained   = Crafting
|type       = [[Items#3D Printables|3D Printable]]
|id         = 560
|stack      = 10
|added      = [[Updates|Early Access release]]
|time       = 15 sec
|cost       = 100 ml
|amount     = 2 pcs
|equippable = No
|storage    = • [[Inventory]] <br> • [[Prefab Buildings#Shelf|Shelf]] <br> • [[Prefab Buildings#Wall Shelf|Wall Shelf]]
|uses       = 
|used       = [[Zipline Rope]]
}}

---

Currently usable Parameters

Please only use these parameters to keep all Infoboxes consistent.

|obtained

• Collecting - just picking up
• Cooking    - mixing food in Cooking Pot
• Crafting   - self explanatory
• Farming    - growing plants
• Hunting    - killing animals
• Looting    - opening stuff / killing enemies
• Cheating   - using console commands

|type

• [[Items#3D Printables|3D Printable]]

---

Template data

Template for: 3D Printables.

Template parameters[Edit template data]

Parameter		Description	Type	Status
Title	|title	Title of the item. Default Page name	String	required
Image	|image	Filename representing the item.	String	required
Caption	|caption	Image description if needed.	String	optional
Alias	|alias	Other names for the item.	String	optional
Obtained	|obtained	How the item is obtained. Check this for [https://sonsoftheforest.wiki.gg/wiki/Template:Basic_item/doc#Currently_usable_Parameters Currently usable Parameters].	String	required
Type	|type	Type of the item. Check this for [https://sonsoftheforest.wiki.gg/wiki/Template:Basic_item/doc#Currently_usable_Parameters Currently usable Parameters].	String	required
Item ID	|id	Item ID number.	Number	required
Stack size	|stack	Maximum inventory stack size.	Number	required
Game Version	|added	Version of the game when the item was added.	String	required
Printing time	|time	How long the item is being printed.	String	required
Printer Resin	|cost	How much printer resin it costs.	String	required
Printing amount	|amount	How many items will be printed at once.	String	required
Equippable	|equippable	Specifies if the item is equippable (Yes/No).	String	required
Storage	|storage	Where the item can be stored.	String	required
Uses	|uses	For what the item can be used.	String	optional
Used	|used	Who or what uses/needs the item.	String	optional

The above documentation is transcluded from User:Borys21/Project:Template index/doc. (edit | history)

Documentation

[purge]

This template aims to provide comprehensible and complete way of adding an infobox to Weapons and some Tools. Based on JPKMn user wikitable

Usage

• Use this template to add an Portable Infobox to most items.
• If you don't have info or don't feel the need to add it just leave the parameter empty, don't cut it out.
• If anything needs to be added, feel free to do so (:

---

Template ready to use

{{Weapon
|title      = 
|image      = 
|caption    = 
|alias      = 
|obtained   = 
|type       = 
|id         = 
|stack      = 
|added      = 
|block      = 
|capacity   = 
|ammo       = 
|attachment = 
|atype      = 
|distance   = 
|speed      = 
|standard   = 
|charge     = 
|downward   = 
|ing        = 
|equippable = 
|upgradable = 
|location   = 
|map        = 
|get        = 
|storage    = 
|uses       = 
|used       = 
}}

---

Template with Explanation

{{Weapon
|title      = Title, by default it's page name
|image      = Filename representing the item
|caption    = Image description if needed
|alias      = Other names for the item
|obtained   = Check the lower page part for more info
|type       = Check the lower page part for more info
|id         = Item ID number
|stack      = Max. inventory stack size
|added      = Version of the game when the item was added
|block      = Check the lower page part for more info
|capacity   = Max. ammo loaded into the weapon
|ammo       = All ammo types that can be loaded
|attachment = All attachments that can be added
|atype      = Check the lower page part for more info
|distance   = Check the lower page part for more info
|speed      = Check the lower page part for more info
|standard   = Default left mouse button click attack
|charge     = Other name used "powerful attack"
|downward   = Self explanatory
|ing        = Crafting ingredients for the item
|equippable = Specifies if the item is equippable (Yes/No)
|upgradable = Specifies if the item is upgradable (Yes/No)
|location   = Where the item can be found
|map        = Linked Icon to map node
|get        = What is needed in order to obtain the item
|storage    = Where the item can be stored
|uses       = For what the item can be used
|used       = Who or what uses/needs the item
}}

---

Example

Crossbow
Meta Info
Obtained:	Collecting
Item type:	Weapon
Item ID:	365
Stack size:	1
Added in:	Early Access release
Weapon Info
Max. Capacity:	1
Ammunition:	Crossbow Bolt
Attachments:	Flashlight Attachment Laser Sight
Attack Statistics
Type	Ranged
Type	Ranged
Distance	Long
Distance	Long
Speed	Slow
Speed	Slow
Standard	50
Standard	50
Other Info
Equippable:	Yes
Upgradable:	No
Location:	Food and Dining Bunker
Check on map:
First get:	Maintenance Keycard
Storage:	Inventory

{{Weapon
|title      = Crossbow
|image      = Crossbow Icon.png
|caption    = 
|alias      = 
|obtained   = Collecting
|type       = [[Weapons]]
|id         = 365
|stack      = 1
|added      = [[Updates|Early Access release]]
|block      = 
|capacity   = 1
|ammo       = [[Crossbow Bolt]]
|attachment = 
* [[Flashlight Attachment]]
* [[Laser Sight]]
|atype      = Ranged
|distance   = Long
|speed      = Slow
|standard   = 50
|charge     = 
|downward   = 
|ing        = 
|equippable = Yes
|upgradable = No
|location   = {{Bunkers|Food and Dining Bunker}}
|map        = {{MapIcon|4|20}}
|get        = {{Keycards|Maintenance}}
|storage    = [[Inventory]]
|uses       = 
|used       = 
}}

---

Currently usable Parameter Please only use these parameters to keep all Infoboxes consistent.

|obtained

• Collecting - just picking up
• Cooking    - mixing food in Cooking Pot
• Crafting   - self explanatory
• Farming    - growing plants
• Hunting    - killing animals
• Looting    - opening stuff / killing enemies
• Cheating   - using console commands

|type

• [[Weapons]]
• [[Tools]]

|block

• Weak
• Medium
• Strong

|atype

• Melee
• Stun
• Ranged
• Explosive

|distance

• Short
• Medium
• Long

|speed

• Slow
• Medium
• Fast

---

Template data

Template for: Weapons and Tools.

Template parameters[Edit template data]

Parameter		Description	Type	Status
Title	|title	Title of the item. Default Page name	String	required
Image	|image	Filename representing the item.	String	required
Caption	|caption	Image description if needed.	String	optional
Alias	|alias	Other names for the item.	String	optional
Obtained	|obtained	How the item is obtained. Check this for [https://sonsoftheforest.wiki.gg/wiki/Template:Basic_item/doc#Currently_usable_Parameters Currently usable Parameters].	String	required
Type	|type	Type of the item. Check this for [https://sonsoftheforest.wiki.gg/wiki/Template:Basic_item/doc#Currently_usable_Parameters Currently usable Parameters].	String	required
Item ID	|id	Item ID number.	Number	required
Stack size	|stack	Maximum inventory stack size.	Number	required
Game Version	|added	Version of the game when the item was added.	String	required
Blocking	|block	Check the lower page part for more info.	String	optional
Capacity	|capacity	Max. ammo loaded into the weapon.	String	optional
Ammunition	|ammo	All ammo types that can be loaded.	String	optional
Attachments	|attachment	All attachments that can be added.	String	optional
Attack type	|atype	For item attacks check this [https://sonsoftheforest.wiki.gg/wiki/Template:Basic_item/doc#Currently_usable_Parameters Currently usable Parameters].	String	optional
Attack distance	|distance	For item attack distances check this [https://sonsoftheforest.wiki.gg/wiki/Template:Basic_item/doc#Currently_usable_Parameters Currently usable Parameters].	String	optional
Attack speed	|speed	For item attack speed check this [https://sonsoftheforest.wiki.gg/wiki/Template:Basic_item/doc#Currently_usable_Parameters Currently usable Parameters].	String	optional
Standard attack	|standard	Default left mouse button click attack.	String	optional
Charged attack	|charge	Other name is "powerful attack".	String	optional
Downward attack	|downward	Self explanatory.	String	optional
Crafting	|ing	Crafting ingredients for the item.	String	required
Equippable	|equippable	Specifies if the item is equippable (Yes/No).	String	optional
Upgradable	|upgradable	Specifies if the item is upgradable (Yes/No).	String	required
Location	|location	Where the item can be found.	String	optional
Map	|map	Linked Icon to map node.	String	optional
Get	|get	What is needed in order to obtain the item.	String	optional
Storage	|storage	Where the item can be stored.	String	required
Uses	|uses	For what the item can be used.	String	optional
Used	|used	Who or what uses/needs the item.	String	optional

The above documentation is transcluded from User:Borys21/Project:Template index/doc. (edit | history)

Documentation

[purge]

This template aims to provide comprehensible and complete way of adding an infobox to Ammunition. Based on JPKMn user wikitable

Usage

• Use this template to add an Portable Infobox to most items.
• If you don't have info or don't feel the need to add it just leave the parameter empty, don't cut it out.
• If anything needs to be added, feel free to do so (:

---

Template ready to use

{{Ammunition
|title       = 
|image       = 
|caption     = 
|alias       = 
|obtained    = 
|type        = 
|id          = 
|stack       = 
|added       = 
|ing         = 
|equippable  = 
|storage     = 
|uses        = 
|used        = 
}}

---

Template with Explanation

{{Ammunition
|title       = Title, by default it's page name
|image       = Filename representing the item
|caption     = Image description if needed
|alias       = Other names for the item
|obtained    = Check the lower page part for more info
|type        = Check the lower page part for more info
|id          = Item ID number
|stack       = Max. inventory stack size
|added       = Version of the game when the item was added
|ing         = Crafting ingredients for the item
|equippable  = Specifies if the item is equippable (Yes/No)
|storage     = Where the item can be stored
|uses        = For what the item can be used
|used        = Who or what uses/needs the item
}}

---

Example

Explosive Stone Arrow
Meta Info
Obtained:	Crafting
Item type:	Ammunition
Stack size:	20
Added in:	Patch 14
Crafting Recipe
Ingredients:	4 x Stone Arrows 2 x Batteries 1 x Wire 1 x C4 Brick 1 x Circuit Board
Other Info
Equippable:	No
Storage:	Inventory
Used by:	• Crafted Bow • Compound Bow

{{Ammunition
|title       = Explosive Stone Arrow
|image       = Crafted Arrow Icon.png
|caption     = 
|alias       = 
|obtained    = Crafting
|type        = [[Items#Ammunition|Ammunition]]
|id          = 
|stack       = 20
|added       = [[Patch 14]]
|ing         = 4 x [[Stone Arrow]]s <br> 2 x [[Batteries]] <br> 1 x [[C4 Brick]] <br> 1 x [[Circuit Board]] <br> 1 x [[[Wire]]
|equippable  = No
|storage     = [[Inventory]]
|uses        = 
|used        = • [[Crafted Bow]] <br> • [[Compound Bow]]
}}

---

Currently usable Parameters

Please only use these parameters to keep all Infoboxes consistent.

|obtained

• Collecting - just picking up
• Cooking    - mixing food in Cooking Pot
• Crafting   - self explanatory
• Farming    - growing plants
• Hunting    - killing animals
• Looting    - opening stuff / killing enemies
• Cheating   - using console commands

|type

• [[Items#Ammunition|Ammunition]]

---

Template data

Template for: Ammunition.

Template parameters[Edit template data]

Parameter		Description	Type	Status
Title	|title	Title of the item. Default Page name	String	required
Image	|image	Filename representing the item.	String	required
Caption	|caption	Image description if needed.	String	optional
Alias	|alias	Other names for the item.	String	optional
Obtained	|obtained	How the item is obtained. Check this for [https://sonsoftheforest.wiki.gg/wiki/Template:Basic_item/doc#Currently_usable_Parameters Currently usable Parameters].	String	required
Type	|type	Type of the item. Check this for [https://sonsoftheforest.wiki.gg/wiki/Template:Basic_item/doc#Currently_usable_Parameters Currently usable Parameters].	String	required
Item ID	|id	Item ID number.	Number	required
Max. stack size	|stack	Maximum inventory stack size.	Number	required
Game Version	|added	Version of the game when the item was added.	String	required
Crafting	|ing	Crafting ingredients for the item.	String	required
Equippable	|equippable	Specifies if the item is equippable (Yes/No).	String	required
Storage	|storage	Where the item can be stored.	String	required
Uses	|uses	For what the item can be used.	String	optional
Used	|used	Who or what uses/needs the item.	String	optional

The above documentation is transcluded from User:Borys21/Project:Template index/doc. (edit | history)

Documentation

[purge]

This template aims to provide a comprehensible and complete way of adding an infobox to Consumable items and Plants and Seeds. Based on JPMKn user wikitable

Usage

• Use this template to add an Portable Infobox to most items.
• If you don't have info or don't feel the need to add it just leave the parameter empty, don't cut it out.
• If anything needs to be added, feel free to do so (:

---

Template ready to use

{{Consumable
|title      = 
|image      = 
|caption    = 
|alias      = 
|obtained   = 
|type       = 
|id         = 
|stack      = 
|added      = 
|health     = 
|stamina    = 
|energy     = 
|hydration  = 
|fullness   = 
|poison     = 
|spoil      = 
|cook       = 
|effects    = 
|items      = 
|ing        = 
|consumable = 
|equippable = 
|storage    = 
|used       = 
}}

---

Template with Explanation

{{Consumable
|title      = Title, by default it's page name
|image      = Filename representing the item
|caption    = Image description if needed
|alias      = Other names for the item
|obtained   = Check the lower page part for more info
|type       = Check the lower page part for more info
|id         = Item ID number
|stack      = Max. inventory stack size
|added      = Version of the game when the item was added
|health     = Health impact of the item
|stamina    = Stamina impact of the item
|energy     = Energy impact of the item
|hydration  = Hydration impact of the item
|fullness   = Fullness impact of the item
|poison     = Poisoning effect of the item
|spoil      = Specifies if the item spoils (Yes/No)
|cook       = Specifies if the item is cookable (Yes/No)
|effects    = Special effects after cooking
|items      = Ingredients for cooking
|ing        = Crafting ingredients for the item
|consumable = Specifies if the item is consumable (Yes/No)
|equippable = Specifies if the item is equippable (Yes/No)
|storage    = Where the item can be stored
|used       = Who or what uses/needs the item
}}

---

Example

Ramen Noodles
Meta Info
Other names:	Instant Noodles
Obtained:	Collecting
Item type:	Consumable
Item ID:	421
Stack size:	6
Added in:	Early Game Access
Consumable Info
Affects Energy:	30%
Affects Hydration:	-25%
Affects Fullness:	25%
Spoils:	No
Cookable:	Yes
Other Info
Consumable:	Yes
Equippable:	No
Storage:	• Inventory • Shelf • Wall Shelf
Used by:	• Chicken Noodle Soup • Kitchen Sink

{{Consumable
|title      = Ramen Noodles
|image      = Ramen Noodles Icon.png
|caption    =
|alias      = Instant Noodles
|obtained   = Collecting
|type       = [[Items#Consumables|Consumable]]
|id         = 421
|stack      = 6
|added      = [[Updates|Early Game Access]]
|health     = 
|stamina    = 
|energy     = <span style="color:#00FF00">30%</span>
|hydration  = <span style="color:#FF0000">-25%</span>
|fullness   = <span style="color:#00FF00">25%</span>
|poison     = 
|spoil      = No
|cook       = Yes
|effects    = 
|items      = 
|ing        = 
|consumable = Yes
|equippable = No
|storage    = • [[Inventory]] <br> • [[Prefab Buildings#Shelf|Shelf]] <br> • [[Prefab Buildings#Wall Shelf|Wall Shelf]]
|used       = • [[Cooking#Chicken Noodle Soup|Chicken Noodle Soup]] <br> • [[Cooking#Kitchen Sink|Kitchen Sink]]
}}

Tips & Tricks

Use this green colour for positive values

<span style="color:#00FF00">%</span>

and this red colour for negative ones

<span style="color:#FF0000">-%</span>

---

Currently usable Parameters

Please only use these parameters to keep all Infoboxes consistent.

|obtained

• Collecting - just picking up
• Cooking    - mixing food in Cooking Pot
• Crafting   - self explanatory
• Farming    - growing plants
• Hunting    - killing animals
• Looting    - opening stuff / killing enemies
• Cheating   - using console commands

|type

• [[Items#Consumables|Consumable]]
• [[Items#Plants and Seed|Plant / Seed]]

---

Template data

Template for: Consumables.

Template parameters[Edit template data]

Parameter		Description	Type	Status
Title	|title	Title of the item. Default Page name	String	required
Image	|image	Filename representing the item.	String	required
Caption	|caption	Image description if needed.	String	optional
Alias	|alias	Other names for the item.	String	optional
Obtained	|obtained	How the item is obtained. Check this for [https://sonsoftheforest.wiki.gg/wiki/Template:Basic_item/doc#Currently_usable_Parameters Currently usable Parameters].	String	required
Type	|type	Type of the item. Check this for [https://sonsoftheforest.wiki.gg/wiki/Template:Basic_item/doc#Currently_usable_Parameters Currently usable Parameters].	String	required
Item ID	|id	Item ID number.	Number	required
Stack size	|stack	Maximum inventory stack size.	Number	required
Game Version	|added	Version of the game when the item was added.	String	required
Health	|health	Health impact of the item.	String	optional
Stamina	|stamina	Stamina impact of the item.	String	optional
Energy	|energy	Energy impact of the item.	String	optional
Hydration	|hydration	Hydration impact of the item.	String	optional
Fullness	|fullness	Fullness impact of the item.	String	optional
Poisonous	|poison	Poisoning effect of the item.	String	optional
Spoilable	|spoil	Specifies if the item spoils (Yes/No).	String	required
Cookable	|cook	Specifies if the item is cookable (Yes/No).	String	required
Effects	|effects	Special effects after cooking.	String	optional
Ingredients	|items	Ingredients for cooking.	String	optional
Crafting	|ing	Crafting ingredients for the item.	String	optional
Consumable	|consumable	Specifies if the item is consumable (Yes/No).	String	required
Equippable	|equippable	Specifies if the item is equippable (Yes/No).	String	required
Storage	|storage	Where the item can be stored.	String	required
Used	|used	Who or what uses/needs the item.	String	optional

The above documentation is transcluded from User:Borys21/Project:Template index/doc. (edit | history)

Documentation

[purge]

This template aims to provide comprehensible and complete way of adding an infobox to Armor. Based on JPKMn user wikitable

Usage

• Use this template to add an Portable Infobox to most items.
• If you don't have info or don't feel the need to add it just leave the parameter empty, don't cut it out.
• If anything needs to be added, feel free to do so (:

---

Template ready to use

{{Armor
|title      = 
|image      = 
|caption    = 
|alias      = 
|obtained   = 
|type       = 
|id         = 
|stack      = 
|added      = 
|stealth    = 
|warmth     = 
|durability = 
|special    = 
|ing        = 
|equippable = 
|location   = 
|map        = 
|get        = 
|storage    = 
|uses       = 
|used       = 
}}

---

Template with Explanation

{{Armor
|title      = Title, by default it's page name
|image      = Filename representing the item
|caption    = Image description if needed
|alias      = Other names for the item
|obtained   = Check the lower page part for more info
|type       = Check the lower page part for more info
|id         = Item ID number
|stack      = Max. inventory stack size
|added      = Version of the game when the item was added
|stealth    = How much it helps with hiding
|warmth     = How much it keeps you warmth
|durability = Check the lower page part for more info
|special    = Other special effects that are given
|ing        = Crafting ingredients for the item
|equippable = Specifies if the item is equippable (Yes/No)
|location   = Where the item can be found
|map        = Linked Icon to map node
|get        = What is needed in order to obtain the item
|storage    = Where the item can be stored
|uses       = For what the item can be used
|used       = Who or what uses/needs the item
}}

---

Example

Bone Armor
Meta Info
Other names:	Medium quality armor
Obtained:	Crafting
Item type:	Armor
Item ID:	494
Stack size:	10
Added in:	Early Access release
Armor Info
Durability:	Medium
Crafting Recipe
Ingredients:	1 x Duct Tape 1 x Rope 4 x Bone
Other Info
Equippable:	Yes
Storage:	• Inventory • Shelf • Wall Shelf • Armor Rack

{{Armor
|title      = Bone Armor
|image      = Bone Armor Icon.png
|caption    = 
|alias      = Medium quality armor
|obtained   = Crafting
|type       = [[Items#Armor|Armor]]
|id         = 494
|stack      = 10
|added      = [[Updates|Early Access release]]
|stealth    = 
|warmth     = 
|durability = Medium
|special    = 
|ing        = 1 x [[Duct Tape]] <br> 1 x [[Rope]] <br> 4 x [[Bone]]
|equippable = Yes
|location   = 
|map        = 
|get        = 
|storage    = • [[Inventory]] <br> • [[Prefab Buildings#Shelf|Shelf]] <br> • [[Prefab Buildings#Wall Shelf|Wall Shelf]] <br> • [[Prefab Buildings#Armor Rack|Armor Rack]]
|uses       = 
|used       = 
}}

---

Currently usable Parameters

Please only use these parameters to keep all Infoboxes consistent.

|obtained

• Collecting - just picking up
• Cooking    - mixing food in Cooking Pot
• Crafting   - self explanatory
• Farming    - growing plants
• Hunting    - killing animals
• Looting    - opening stuff / killing enemies
• Cheating   - using console commands

|type

• [[Items#Armor|Armor]]

|durability

• Low
• Medium
• High

---

Template data

Template for: Armor.

Template parameters[Edit template data]

Parameter		Description	Type	Status
Title	|title	Title of the item. Default Page name	String	required
Image	|image	Filename representing the item.	String	required
Caption	|caption	Image description if needed.	String	optional
Alias	|alias	Other names for the item.	String	optional
Obtained	|obtained	How the item is obtained. Check this for [https://sonsoftheforest.wiki.gg/wiki/Template:Basic_item/doc#Currently_usable_Parameters Currently usable Parameters].	String	required
Type	|type	Type of the item. Check this for [https://sonsoftheforest.wiki.gg/wiki/Template:Basic_item/doc#Currently_usable_Parameters Currently usable Parameters].	String	required
Item ID	|id	Item ID number.	Number	required
Max. stack size	|stack	Maximum inventory stack size.	Number	required
Game Version	|added	Version of the game when the item was added.	String	required
Stealth	|stealth	How much it helps with hiding.	String	required
Warmth	|warmth	How much it keeps you warmth.	String	required
Durability	|durability	If the value is not known check this for [https://sonsoftheforest.wiki.gg/wiki/Template:Basic_item/doc#Currently_usable_Parameters Currently usable Parameters].	String	required
Special effects	|Special	Other special effects that are given.	String	required
Crafting	|ing	Crafting ingredients for the item.	String	required
Equippable	|equippable	Specifies if the item is equippable (Yes/No).	String	required
Location	|location	Where the item can be found.	String	optional
Map	|map	Linked icon to map node.	String	optional
Get	|get	What is needed in order to obtain the item.	String	optional
Storage	|storage	Where the item can be stored.	String	required
Uses	|uses	For what the item can be used.	String	optional
Used	|used	Who or what uses/needs the item.	String	optional

The above documentation is transcluded from User:Borys21/Project:Template index/doc. (edit | history)

Documentation

[purge]

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

Usage

• Use this template to add an Portable Infobox to Animals.
• If you don't have info or don't feel the need to add it just leave the parameter empty, don't cut it out!
• If anything needs to be added, feel free to do so (:

---

Template ready to use

{{Animal
|title    =
|image    =
|caption  =
|alias    =
|location =
|season   =
|category =
|attitude =
|type     =
|loot     =
}}

---

Template with Explanation

{{Animal
|title    = Title, by default it's page name
|image    = Filename representing the animal
|caption  = Image description if needed
|alias    = Other names for the animal
|location = Where it can be mostly spotted
|season   = In which seasons it spawns
|category = What category it comes from
|attitude = How it reacts to the player
|type     = What family it comes from
|loot     = What can be gathered
}}

---

Example

Moose
Animal Info
Location:	Forest
Season:	All
Category:	Fauna
Other Info
Attitude:	Neutral
Type:	Cervidae
Loot:	Meat x4 Animal Hides x2 Head Trophyx1

{{Animal
|title    = Moose
|image    = [[MooseFlipped.png]]
|caption  =
|alias    =
|location = Forest
|season   = All
|category = Fauna
|attitude = Neutral
|type     = Cervidae
|loot     = [[Meat]] x4<br>[[Animal Hide]]s x2<br>[[Head Trophy]]x1
}}

The above documentation is transcluded from User:Borys21/Project:Template index/doc. (edit | history)

Documentation

[purge]

This template aims to provide comprehensible and complete way of adding an infobox to Characters. Based on JPKMn user wikitable

Usage

• Use this template to add an Portable Infobox to most items.
• If you don't have info or don't feel the need to add it just leave the parameter empty, don't cut it out.
• If anything needs to be added, feel free to do so (:

---

Template ready to use

{{Character
|title       =
|image       =
|caption     =
|alias       =
|sex         =
|age         =
|status      =
|affiliation =
|occupation  =
|background  =
|appearance  =
|hold        =
|actions     =
|skills      =
|achievement =
}}

---

Template with Explanation

{{Character
|title       = Title, by default it's page name.
|image       = Filename representing the character.
|caption     = Image description if needed.
|alias       = Other names for the character.
|sex         = Gender of the character.
|age         = If known how old he/she is.
|status      = Is alive or not.
|affiliation = Who character knows / their relationship to them.
|occupation  = What they were doing before coming to island.
|background  = Why they came to the island.
|appearance  = Where you can meet for the first time.
|hold        = What they can hold in their arms.
|actions     = What notable actions they perform.
|skills      = What notable skill they use/have.
|achievement = What achievements can be obtained.
}}

---

Example

Kelvin
Character Info
Other names:	Kalvin
Gender:	Male
Age:	30-35 (not officially)
Status	Alive
Affiliations:	Edward Puffton - Boss Barbara Puffton - Boss spouse Virginia - Boss daughter Jack Holt - Brother in arms
Occupations:	Puffcorp Mercenary
Background:	Was sent on a mission to find missing Pufftons
Other Info
First appearance:	In helicopter cutscene
Equipment:	Berries Raw Fish Sticks Rocks Stones Arrows Radio Log
Notable actions:	Take Item Follow Me Get (things he can hold) Build (Fire, Shelter, Finish Build or Clear Shelter) Stay (Here, At Shelter, Hidden) Take a break Maintain base Clear (5, 10 or 20 meters)
Skills:	Helping player inside base Hiding from enemies Pointing at enemies when they are nearby

{{BigText|Example}}
{{Character
|title       = Kelvin
|image       = Portrait Kelvin.png
|caption     = 
|alias       = Kalvin
|sex         = Male
|age         = 30-35 (not officially)
|status      = 
|affiliation = 
* [[Edward Puffton]] - Boss
* [[Barbara Puffton]] - Boss spouse
* [[Virginia]] - Boss daughter
* [[Jack Holt]] - Brother in arms
|occupation  = [[Puffcorp]] Mercenary
|background  = Was sent on a mission to find missing Pufftons
|appearance  = In helicopter cutscene
|hold        =
* [[Berries]]
* [[Fish#Fish Raw|Raw Fish]]
* [[Stick]]s
* [[Rock]]s
* [[Stone]]s
* [[Arrows]]
* [[Radio]]
* [[Log#Log|Log]]
|actions     =
* Take Item
* Follow Me
* Get (things he can hold)
* Build (Fire, Shelter, Finish Build or Clear Shelter)
* Stay (Here, At Shelter, Hidden)
* Take a break
* Maintain base
* Clear (5, 10 or 20 meters)
|skills      =
* Helping player inside base
* Hiding from enemies
* Pointing at enemies when they are nearby
|achievement =
}}

The above documentation is transcluded from User:Borys21/Project:Template index/doc. (edit | history)

Documentation

[purge]

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

Usage

• Use this template to add an Portable Infobox to Locations.
• If you don't have info or don't feel the need to add it just leave the parameter empty, don't cut it out!
• If anything needs to be added, feel free to do so (:

---

Template ready to use

{{Locations
|title   =
|image   =
|caption =
|alias   =
|map     =
|added   =
|tp      =
|loot    =
|enemies =
}}

---

Template with Explanation

{{Locations
|title   = Title, by default it's page name
|image   = Filename representing the item
|caption = Image description if needed
|alias   = Other names for the location
|map     = Linked Icon to map node
|added   = Version of the game when the location was added
|tp      = Teleport name or coordinates
|loot    = Most important items
|enemies = Cannibals, Mutants or other threats that can endanger you
}}

---

Example

Residential Bunker
Location Info
Other names:	Apartment Bunker
Check on map:
Added in:	Early Access release
Teleport:	goto BunkerResidential
Notable Items
Loot:	3D Printer Katana Pistol Putter Gold Mask Flashlight Attachment Pistol Rail Shotgun Rail
Hostiles
Enemies:	5 Creepies 8 Babies 2-4 Fingers 1 Demon

{{Locations
|title   = Residential Bunker
|image   = SonsOfTheForest Apartment Bunker Entrance.png
|caption = Cave entrance leading to the bunker
|alias   = Apartment Bunker
|map     = {{MapIcon|4|33}}
|added   = [[Updates|Early Access release]]
|tp      = goto BunkerResidential
|loot    = 
* [[3D Printer]]
* [[Katana]]
* [[Pistol]]
* [[Putter]]
* [[Gold Mask]]
* [[Flashlight Attachment]]
* [[Pistol Rail]]
* [[Shotgun Rail]]
|enemies = 
* 5 [[Mutants|Creepies]]
* 8 [[Babies]]
* 2-4 [[Fingers]]
* 1 [[Demon]]
}}

The above documentation is transcluded from User:Borys21/Project:Template index/doc. (edit | history)

Documentation

[purge]

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

Usage

• Use this template to add an Portable Infobox to Campsites.
• If you don't have info or don't feel the need to add it just leave the parameter empty, don't cut it out!
• If anything needs to be added, feel free to do so (:

---

Template ready to use

{{Camps
|title   =
|image   =
|caption =
|alias   =
|map     =
|tp      =
|loot    =
}}

---

Template with Explanation

{{Locations
|title   = Title, by default it's page name
|image   = Filename representing the item
|caption = Image description if needed
|alias   = Other names for the location
|map     = Linked Icon to map node
|tp      = Teleport name or coordinates
|loot    = All notable items
}}

---

Example

Campsite 05
Location Info
Other names:	Black Tent
Check on map:
Teleport:	goto
Items
Loot:	Modern Axe

{{Locations
|title   = Campsite 05
|image   = Camp_with_smoke.jpg
|caption = 
|alias   = Black Tent
|map     = {{MapIcon|4|1}}
|tp      = goto BunkerResidential
|loot    = 
* [[Modern Axe]]
}}

The above documentation is transcluded from User:Borys21/Project:Template index/doc. (edit | history)