Template:ItemInfobox/doc

The ItemInfobox provides information about items.

It is the "generic" Infobox for items that do not fall into the following categories: Clothing, Food, and Skins.

Fields with default icons indicate the priority information useful for a player to know. Other fields can be left blank. =Template= Copy and paste the below to the desired page. Fields that auto-complete or are rarely used have been left out (see below for information).

=Example= Below is an example of how the ItemInfobox fields might be filled out, with the resulting Infobox to the right.

Note: Some fields auto-complete, but are filled out here for example purposes. See the "Fields" glossary below for specifics. Item Name Information

=Fields=

title

 * Leave blank by default. This field automatically draws from the tag, and will show the quest name even if nothing is filled in. Only use if the in-game name, capitalization, or grammar differs from the page title for some reason.

image

 * Leave blank by default. Also utilizes the tag. Only fill in if the item's image does not load in the preview or Visual Editor (which probably means it does not match the page title or follow existing file naming conventions).

caption

 * Optional: This is the text that shows when looking at the item's crafting recipe or purchase window. Some items do not have captions. Leave blank if you're not sure.

buy_price

 * Optional. How much the item costs if purchased from a shopkeeper. The number typed in this field will automatically be preceded by a icon.

sell_price

 * Required. How much the item will sell through the player's shop. If it has no price, use "N/A".

stacks_up_to

 * Optional. The maximum number of that item in one stack.

obtaining

 * Optional: Where or how the item can be purchased, crafted, won, or earned. Examples:


 * Shop Name
 * Workstation Name
 * NPC Name
 * Mod NPC Name
 * Quest reward

requirements

 * Required if applicable: If the item only becomes available after completing certain actions, quests, or other criteria, note that here. Examples:


 * Mod Dependency Name
 * Complete "Quest name"
 * Played until Season #, Year #
 * If the item requires the purchase of a shopkeeper upgrade such as the Costume Shop, include that in "obtaining" instead.

crafting

 * Optional: If the item has a crafting recipe, include that here.
 * If the recipe uses non-modded items, please link them to those pages on the main wiki. To do that, use the following format:  Phrase to link  Use "_" instead of spaces in the URL.

capacity

 * Optional: If the item is a type of Storage, list how many slots it has.

dyeable

 * Optional: If the item can be painted with Paintbrushes, Furniture Brushes, or at a Dyeing Station. A simple Yes or No is fine, but you can link to one of the above to be more specific.

energy_required

 * Optional: If the item can be used as a tool, note whether or not the item uses up Energy.

energy_used

 * Required if applicable: If the item uses Energy, type the amount used here. The number will automatically be followed by a icon.

upgradeable

 * Optional: If the item has a higher tier version. Leave blank for "No".

profit

 * Optional: If it is a crafted item, how much more or less the item costs compared to its component materials.