Template:Basic item

From Sons of the Forest Wiki
Jump to navigation Jump to search
Template-info.png Documentation

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[edit source]

• 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[edit source]

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

Template with Explanation[edit source]

{{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[edit source]

{{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[edit source]

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[edit source]

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

Template parameters

ParameterDescriptionTypeStatus
Title|title

Title of the item.

Default
Page name
Stringrequired
Image|image

Filename representing the item.

Stringrequired
Caption|caption

Image description if needed.

Stringoptional
Alias|alias

Other names for the item.

Stringoptional
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].

Stringrequired
Type|type

Type of the item. Check this for [https://sonsoftheforest.wiki.gg/wiki/Template:Basic_item/doc#Currently_usable_Parameters Currently usable Parameters].

Stringrequired
Item ID|id

Item ID number.

Numberrequired
Max. stack size|stack

Maximum inventory stack size.

Numberrequired
Game Version|added

Version of the game when the item was added.

Stringrequired
Consumable|consumable

Specifies if the item is consumable (Yes/No).

Stringrequired
Equippable|equippable

Specifies if the item is equippable (Yes/No).

Stringrequired
Location|location

Where the item can be found.

Stringoptional
Map|map

Linked icon to map node.

Stringoptional
Get|get

What is needed in order to obtain the item.

Stringoptional
Storage|storage

Where the item can be stored.

Stringrequired
Uses|uses

For what the item can be used.

Stringoptional
Used|used

Who or what uses/needs the item.

Stringoptional