Template:Recipe/doc

This is a documentation subpage for Template:Recipe.

It contains usage information, categories, and other content that is not part of the original template page.

Template:Recipe invokes function main in Module:Recipe using Lua.

This template is used to generate the level requirements, experience gained, members icon, and materials required to do skilling creation. For example, listing the materials required to make a black d'hide vambraces along with the Crafting level required and the experience gained for the action.

Usage

For a complete list of facilities and special case tool names, visit the Module:Recipe page and look for toolsList and facilitiesIcons. The names before the equal sign (=) is what you will use. Note that although multiple outputs are supported, only the first output is passed to Bucket for use with Module:Uses material list.

{{Recipe
|skill#              = <!-- Name of the main skill; Exclude this parameter if there are no skill requirements --> 
|skill#lvl           = <!-- Level requirement of the first skill -->
|skill#boostable     = <!-- Boostable skill requirement or not; Default is unknown; Fill in with yes or no if known -->
|skill#exp           = <!-- Experience gained for the first skill -->

|notes               = <!-- (Optional) Quest, miniquest, etc additional requirements text -->
|members             = <!-- Members only or not -->
|ticks               = <!-- Number of ticks per action (defaults to ? if not passed in and sets a category for missing ticks, can also be set to na) -->
|ticksnote           = <!-- (Optional) Extra information for Make-All tick rates, tick manipulation information, etc -->
|tools               = <!-- (Optional) List of tools or non-consumed materials required to create the item; This parameter list CAN be comma delimited to render multiple tools; An example of comma delimited is the following: Knife, Shears, Knife -->
|facilities          = <!-- (Optional) List of facilities that the action may require (e.g. anvil or pottery wheel) -->
|bucket              = <!-- (Optional) Set to "No" to disable saving to Bucket for entire recipe template usage -->

|mat#                = <!-- Name of the consumed/used material -->
|mat#pic             = <!-- (Optional) Picture override for the material (do not include '.png') -->
|mat#quantity        = <!-- (Optional) Quantity of the material; Defaults to 1 -->
|mat#txt             = <!-- (Optional) Text override for the material link -->
|mat#cost            = <!-- (Optional) Cost override for the material -->
|mat#costnote        = <!-- (Optional) Extra information on the cost of the material; or the string "calculated" to append a pre-defined note related to calculation of GE prices of materials used to craft the item -->
|mat#currency        = <!-- (Optional) Currency override for the material (i.e. agility arena ticket or castle wars ticket) -->
|mat#itemnote        = <!-- (Optional) Extra information on the item material of a recipe -->
|mat#quantitynote    = <!-- (Optional) Extra information for the quantity of materials (e.g., 50% success chance for iron bars without rings of forging) -->

|output#             = <!-- Name of the item produced. Note that only output1 will be passed to Bucket -->
|output#pic          = <!-- (Optional) Picture override for the output (do not include '.png') -->
|output#quantity     = <!-- (Optional) Quantity of the item produced; defaults to 1 -->
|output#txt          = <!-- (Optional) Text override for the output link -->
|output#subtxt       = <!-- (Optional) Arbitrary parenthetical text that shows up after the item name in {{Uses material list}} results -->
|output#cost         = <!-- (Optional) Cost override for output item, set to No if not tradeable; Defaults to GE price -->
|output#currency     = <!-- (Optional) Currency override for the material (i.e. agility arena ticket or castle wars ticket) -->
|output#itemnote     = <!-- (Optional) Extra information on the item output of a recipe -->
|output#quantitynote = <!-- (Optional) Extra information for the quantity of outputs (e.g., 50% success chance for iron bars without rings of forging) -->
}}

Examples

One skill

{{Recipe
|skill1 = Crafting
|skill1lvl = 79
|skill1boostable = Yes
|skill1exp = 86
|ticks = 2
|members = Yes
|mat1 = Black dragon leather
|mat2 = Thread
|output1 = Black d'hide vambraces
|output1quantity = 1
}}

Requirements
Skill		Level	XP
Crafting		79 ^(b)	86
Members		Ticks	2 (1.2s)

Materials
Item		Quantity	Cost
	Black dragon leather	1	4,128
	Thread	1	7
Total cost			4,135
	Black d'hide vambraces	1	2,091
Profit			−2,044
Profit after GE Tax			−2,085

Two skills

{{Recipe
|skill1 = Crafting
|skill1lvl = 70
|skill1boostable = Yes
|skill1exp = 2500
|skill2 = Smithing
|skill2lvl = 70
|skill2boostable = Yes
|skill2exp = 2500
|ticks = 2
|members = Yes
|mat1 = Crystal armour seed
|mat2 = Crystal shard
|mat2quantity = 50
|mat2cost = 0
|output1 = Crystal helm
|output1quantity = 1
|output1cost = No
}}

Requirements
Skill	Level	XP
Crafting	70 ^(b)	2,500
Smithing	70 ^(b)	2,500
Members	Ticks	2 (1.2s)

Materials
Item		Quantity	Cost
	Crystal armour seed	1	8,412,467
	Crystal shard	50	N/A
Total cost			8,412,467
	Crystal helm	1	N/A

Two outputs

{{Recipe
|skill1 = Sailing
|skill1lvl = 73
|skill1boostable = No
|skill1exp = 1337
|ticks = 42
|members = Yes
|mat1 = Wrapped oomlie
|mat1quantity = 1
|mat2 = Needle
|mat2quantity = 899
|output1 = Burnt oomlie wrap
|output1quantity = 2
|output1cost = 1
|output2 = Red toad
|output2quantity = 2
|output2cost = No
}}

Requirements
Skill		Level	XP
Sailing		73 ^(nb)	1,337
Members		Ticks	42 (25.2s)

Materials
Item		Quantity	Cost
	Wrapped oomlie	1	7,958
	Needle	899	34,162
Total cost			42,120
	Burnt oomlie wrap	2	2
	Red toad	2	N/A
Profit			−42,118
Profit after GE Tax			−42,118

Quest requirement

{{Recipe
|skill1 = Herblore
|skill1lvl = 37
|skill1boostable = Yes
|skill1exp = 27
|ticks = 2
|notes = Learn the [[Barbarian Training#Barbarian Herblore|barbarian]] way of mixing potions.
|members = Yes
|mat1 = Agility potion(2)
|mat2 = Caviar
|output1 = Agility mix(2)
|output1quantity = 1
}}

Requirements
Skill	Level	XP
Herblore	37 ^(b)	27
Learn the barbarian way of mixing potions.
Members	Ticks	2 (1.2s)

Materials
Item		Quantity	Cost
	Agility potion(2)	1	228
	Caviar	1	95
Total cost			323
	Agility mix(2)	1	312
Profit			−11
Profit after GE Tax			−17

Tool requirement

{{Recipe
|skill1 = Crafting
|skill1lvl = 1
|skill1boostable = Yes
|skill1exp = 10
|ticks = 2
|members = yes
|tools = Ring mould
|mat1 = Opal
|mat2 = Silver bar
|output1 = Opal ring
|output1quantity = 1
}}

Requirements
Skill	Level	XP
Crafting	1	10
Members	Ticks	2 (1.2s)
Tools	Facilities	None

Materials
Item		Quantity	Cost
	Opal	1	154
	Silver bar	1	93
Total cost			247
	Opal ring	1	795
Profit			548
Profit after GE Tax			533

Facility requirement

{{Recipe
|skill1 = Crafting
|skill1lvl = 1
|skill1exp = 10
|ticks = 2
|members = yes
|facilities = Anvil
|mat1 = Opal
|mat2 = Silver bar
|output1 = Opal ring
|output1quantity = 1
}}

Requirements
Skill		Level	XP
Crafting		1	10
Members		Ticks	2 (1.2s)
Tools	None	Facilities	Anvil

Materials
Item		Quantity	Cost
	Opal	1	154
	Silver bar	1	93
Total cost			247
	Opal ring	1	795
Profit			548
Profit after GE Tax			533

Currency override

{{Recipe
|skill1 = Construction
|skill1lvl = 69
|skill1boostable = No
|skill1exp = 420
|ticks = 101
|members = Yes
|mat1 = Thread
|mat1quantity = 4
|mat1currency = Castle wars ticket
|mat2 = Needle
|mat2quantity = 899
|output1 = Attack potion(3)
|output1quantity = 1
}}

Requirements
Skill		Level	XP
Construction		69 ^(nb)	420
Members		Ticks	101 (60.6s)

Materials
Item		Quantity	Cost
	Decorative helm (red)	4	4
	Needle	899	34,162
Total cost			4 34,162
	Attack potion(3)	1	8
Profit			−34,154
Profit after GE Tax			−34,154

Cost note: "calculated"

{{Recipe
|skill1 = Cooking
|skill1lvl = 29
|skill1boostable = Yes
|skill1exp = 0
|members = Yes
|ticks = 2
|mat1 = Clay
|mat2 = Part mud pie (water)
|mat2cost = {{GEP|Pie shell}}+{{GEP|Compost}}+{{GEP|Bucket of water}}
|mat2costnote = calculated
|output1 = Raw mud pie
}}

Requirements
Skill		Level	XP
Cooking		29 ^(b)	0
Members		Ticks	2 (1.2s)

Materials
Item		Quantity	Cost
	Clay	1	76
	Part mud pie (water)	1	263^{[r 1]}
Total cost			339
	Raw mud pie	1	1,588
Profit			1,249
Profit after GE Tax			1,218

^ Calculated value given in the cost field (generally based on GE prices of ingredients).

Template data

Show/hide template's data

The following information is used by extensions and applications, such as VisualEditor, to help users implement this template onto pages. Please ensure that it is up-to-date.

This template is used to generate the level requirements, experience gained, members icon, and materials required to do skilling creation.

Template parameters
This template has custom formatting.
Parameter		Description	Type	Status
No parameters specified

[1] Calculated value given in the cost field (generally based on GE prices of ingredients).

[r 1]