User:Andmcadams/RecipeTemplate/doc

From Old School RuneScape Wiki
Jump to: navigation, search
Information icon-grey.svg
This is a documentation subpage for User:Andmcadams/RecipeTemplate.
It contains usage information, categories, and other content that is not part of the original template page.
User:Andmcadams/RecipeTemplate invokes Module:Sandbox/User:Andmcadams/Recipe using Lua.

About

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.

{{Recipe
|skill#              = <!-- Name of the main skill; Set to None or 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 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) -->
|nosmw               = <!-- (Optional) Turns off SMW rendering for entire recipe template usage -->

|mat#                = <!-- Name of the material -->
|mat#pic             = <!-- (Optional) Picture override for the material -->
|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#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 -->
|output#pic          = <!-- (Optional) Picture override for the output -->
|output#quantity     = <!-- (Optional) Quantity of the item produced; defaults to 1 -->
|output#txt          = <!-- (Optional) Text override for the output link -->
|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
SkillLevelXP
Crafting Crafting79 (b)86
Members
Member icon.png
Ticks2 (1.2s)
Materials
ItemQuantityCost
Black dragon leather.pngBlack dragon leather13,234
Thread.pngThread19
Total Cost3,243
Black d'hide vambraces.pngBlack d'hide vambraces12,359
Profit-884

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
SkillLevelXP
Crafting Crafting70 (b)2,500
Smithing Smithing70 (b)2,500
Members
Member icon.png
Ticks2 (1.2s)
Materials
ItemQuantityCost
Crystal armour seed.pngCrystal armour seed14,629,871
Crystal shard 5.pngCrystal shard50N/A
Total Cost4,629,871
Crystal helm.pngCrystal helm1N/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
SkillLevelXP
Sailing Sailing73 (ub)1,337
Members
Member icon.png
Ticks42 (25.2s)
Materials
ItemQuantityCost
Wrapped oomlie.pngWrapped oomlie14,210
Needle.pngNeedle89940,455
Total Cost44,665
Burnt oomlie wrap.pngBurnt oomlie wrap22
Red toad.pngRed toad2N/A
Profit-44,663

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
SkillLevelXP
Herblore Herblore37 (b)27
Learn the barbarian way of mixing potions.
Members
Member icon.png
Ticks2 (1.2s)
Materials
ItemQuantityCost
Agility potion(2).pngAgility potion(2)1263
Caviar.pngCaviar1297
Total Cost560
Agility mix(2).pngAgility mix(2)1600
Profit40

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
SkillLevelXP
Crafting Crafting110
Members
Member icon.png
Ticks2 (1.2s)
ToolsRing mould.pngFacilitiesNone
Materials
ItemQuantityCost
Opal.pngOpal1264
Silver bar.pngSilver bar174
Total Cost338
Opal ring.pngOpal ring1522
Profit184

Facility requirement

{{Recipe
|skill1 = Crafting
|skill1lvl = 1
|skill1exp = 10
|ticks = 2
|members = yes
|facitilies = Anvil
|mat1 = Opal
|mat2 = Silver bar
|output1 = Opal ring
|output1quantity = 1
}}
Requirements
SkillLevelXP
Crafting Crafting110
Members
Member icon.png
Ticks2 (1.2s)
ToolsNoneFacilitiesAnvil icon.png Anvil
Materials
ItemQuantityCost
Opal.pngOpal1264
Silver bar.pngSilver bar174
Total Cost338
Opal ring.pngOpal ring1522
Profit184

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
SkillLevelXP
Construction Construction69 (ub)420
Members
Member icon.png
Ticks101 (60.6s)
Materials
ItemQuantityCost
Decorative helm (red).pngDecorative helm (red)4Castle wars ticket.png 4
Needle.pngNeedle89940,455
Total CostCastle wars ticket.png 4
40,455
Attack potion(3).pngAttack potion(3)13
Profit-40,452