Module:ManualDescriptions

Documentation for this module may be created at Module:ManualDescriptions/doc

-- Module:ManualDescriptions
local p = {}

-- Editable data table - contributors modify this directly
local descriptions = {
    ["Dragonite ore"] = "'''Dragonite ore''' is a rare ore used to create [[Dragonite bar]]s.",
	["Luminite ore"] = "'''Luminite ore''' can be crushed using a hammer, chisel, or pestle and mortar, to be turned into [[Luminite flux]], a stackable smelting catalyst used to make high tier bars for [[Smithing]].<br>'''Luminite ore''' can also be crushed into flux by using it on Nurmof at [[Home]], costing [[Skilling token]]s and rewarding no experience. <br><br>In addition to the below drop sources, '''Luminite ore''' can also be mined in donator mining zones at Home, in the mining guild, and south of the Barrows.",
	["Skilling token"] ="[[Skilling token|Skilling tokens]] are a currency dropped by performing skilling actions in August. Skilling tokens can be spent at the [[Skilling Token Store]] for various upgrades and rewards. <br><br>Skilling tokens are tradeable.",
	["$1 Bond"] ="[[Bonds]] are a tradeable item which can be redeemed for [[Donating#Donator_Rank|Donator Rank]] and [[Donating#Donator_Credits|Donator Credits]] equal to the value of the bond.",
	["$5 Bond"] ="[[Bonds]] are a tradeable item which can be redeemed for [[Donating#Donator_Rank|Donator Rank]] and [[Donating#Donator_Credits|Donator Credits]] equal to the value of the bond.",
	["$10 Bond"] ="[[Bonds]] are a tradeable item which can be redeemed for [[Donating#Donator_Rank|Donator Rank]] and [[Donating#Donator_Credits|Donator Credits]] equal to the value of the bond.",
	["$25 Bond"] ="[[Bonds]] are a tradeable item which can be redeemed for [[Donating#Donator_Rank|Donator Rank]] and [[Donating#Donator_Credits|Donator Credits]] equal to the value of the bond.",
	["$50 Bond"] ="[[Bonds]] are a tradeable item which can be redeemed for [[Donating#Donator_Rank|Donator Rank]] and [[Donating#Donator_Credits|Donator Credits]] equal to the value of the bond.",
["Dragonstone weapon seed"] = "The [[Dragonstone weapon seed]] is used in the creation of [[Gem beast#Weapons_5|Dragonstone weapons]]. Players can create the weapon seed with [[Dragonstone shards]], or receive it as a rare drop from [[Dragonstone Drake]]s.", 
["Dragonstone armour seed"] = "The [[Dragonstone armour seed]] is used in the creation of [[Gem beast#Armour_5|Dragonstone armour]]. Players can create the armour seed with [[Dragonstone shards]], or receive it as a rare drop from [[Dragonstone Drake]]s.",
["Dragonstone frame"] = "The [[Dragonstone frame]] is used in the creation of all [[Gem beast#Weapons_5|Dragonstone weapons]]. Players can create the frame with [[Dragonstone shards]], or receive it as a rare drop from [[Dragonstone Drake]]s.<br>The [[Dragonstone frame]] can also be used to charge [[Gem beast#Weapons_5|Dragonstone weapons]].",
["Dragonstone orb"] = "The [[Dragonstone orb]] is used in the creation of the [[Dragonstone staff]]. Players can create the orb with [[Dragonstone shards]], or receive it as a rare drop from [[Dragonstone Drake]]s.<br>The [[Dragonstone orb]] can also be used to charge [[Gem beast#Weapons_5|Dragonstone weapons]].",
["Dragonstone bowstring"] = "The [[Dragonstone bowstring]] is used in the creation of the [[Dragonstone longbow]] and [[Dragonstone shortbow]]. Players can create the bowstring with [[Dragonstone shards]], or receive it as a rare drop from [[Dragonstone Drake]]s.<br>The [[Dragonstone bowstring]] can also be used to charge [[Gem beast#Weapons_5|Dragonstone weapons]].",
["Dragonstone spike"] = "The [[Dragonstone spike]] is used in the creation of certain [[Gem beast#Weapons_5|Dragonstone weapons]]. Players can create the spike with [[Dragonstone shards]], or receive it as a rare drop from [[Dragonstone Drake]]s.<br>The [[Dragonstone spike]] can also be used to charge [[Gem beast#Weapons_5|Dragonstone weapons]].",
["Diamond weapon seed"] = "The [[Diamond weapon seed]] is used in the creation of [[Gem beast#Weapons_4|Diamond weapons]]. Players can create the weapon seed with [[Diamond shards]], or receive it as a rare drop from [[Diamond Beast]]s.", 
["Diamond armour seed"] = "The [[Diamond armour seed]] is used in the creation of [[Gem beast#Armour_4|Diamond armour]]. Players can create the armour seed with [[Diamond shards]], or receive it as a rare drop from [[Diamond Beast]]s.",
["Diamond frame"] = "The [[Diamond frame]] is used in the creation of all [[Gem beast#Diamond|Diamond]] weapons. Players can create the frame with [[Diamond shards]], or receive it as a rare drop from [[Diamond Beast]]s.<br>The [[Diamond frame]] can also be used to charge [[Gem beast#Weapons_4|Diamond weapons]].",
["Diamond orb"] = "The [[Diamond orb]] is used in the creation of the [[Diamond staff]]. Players can create the weapon seed with [[Diamond shards]], or receive it as a rare drop from [[Diamond Beast]]s.<br>The [[Diamond orb]] can also be used to charge [[Gem beast#Weapons_4|Diamond weapons]].",
["Diamond bowstring"] = "The [[Diamond bowstring]] is used in the creation of the [[Diamond longbow]] and [[Diamond shortbow]]. Players can create the bowstring with [[Diamond shards]], or receive it as a rare drop from [[Diamond Beast]]s.<br>The [[Diamond bowstring]] can also be used to charge [[Gem beast#Weapons_4|Diamond weapons]].",
["Diamond spike"] = "The [[Diamond spike]] is used in the creation of certain [[Gem beast#Weapons_4|Diamond weapons]]. Players can create the spike with [[Diamond shards]], or receive it as a rare drop from [[Diamond Beast]]s.<br>The [[Diamond spike]] can also be used to charge [[Gem beast#Weapons_4|Diamond weapons]].",
["Ruby weapon seed"] = "The [[Ruby weapon seed]] is used in the creation of [[Gem beast#Weapons_3|Ruby weapons]]. Players can create the weapon seed with [[Ruby shards]], or receive it as a rare drop from [[Ruby Beast]]s.", 
["Ruby armour seed"] = "The [[Ruby armour seed]] is used in the creation of [[Gem beast#Armour_3|Ruby armour]]. Players can create the armour seed with [[Ruby shards]], or receive it as a rare drop from [[Ruby Beast]]s.",
["Ruby frame"] = "The [[Ruby frame]] is used in the creation of all [[Gem beast#Weapons_3|Ruby weapons]]. Players can create the frame with [[Ruby shards]], or receive it as a rare drop from [[Ruby Beast]]s.<br>The [[Ruby frame]] can also be used to charge [[Gem beast#Weapons_3|Ruby weapons]].",
["Ruby orb"] = "The [[Ruby orb]] is used in the creation of the [[Ruby staff]]. Players can create the orb with [[Ruby shards]], or receive it as a rare drop from [[Ruby Beast]]s.<br>The [[Ruby orb]] can also be used to charge [[Gem beast#Weapons_3|Ruby weapons]].",
["Ruby bowstring"] = "The [[Ruby bowstring]] is used in the creation of the [[Ruby longbow]] and [[Ruby shortbow]]. Players can create the bowstring with [[Ruby shards]], or receive it as a rare drop from [[Ruby Beast]]s.<br>The [[Ruby bowstring]] can also be used to charge [[Gem beast#Weapons_3|Ruby weapons]].",
["Ruby spike"] = "The [[Ruby spike]] is used in the creation of certain [[Gem beast#Weapons_3|Ruby weapons]]. Players can create the spike with [[Ruby shards]], or receive it as a rare drop from [[Ruby Beast]]s.<br>The [[Ruby spike]] can also be used to charge [[Gem beast#Weapons_3|Ruby weapons]].",
["Emerald weapon seed"] = "The [[Emerald weapon seed]] is used in the creation of [[Gem beast#Weapons_2|Emerald weapons]]. Players can create the weapon seed with [[Emerald shards]], or receive it as a rare drop from [[Emerald Beast]]s.", 
["Emerald armour seed"] = "The [[Emerald armour seed]] is used in the creation of [[Gem_beast#Armour_2|Emerald armour]]. Players can create the armour seed with [[Emerald shards]], or receive it as a rare drop from [[Emerald Beast]]s.",
["Emerald frame"] = "The [[Emerald frame]] is used in the creation of all [[[Gem Beast#Armour_2|Emerald weapons]]. Players can create the frame with [[Emerald shards]], or receive it as a rare drop from [[Emerald Beast]]s.<br>The [[Emerald frame]] can also be used to charge [[Gem beast#Weapons_2|Emerald weapons]].",
["Emerald orb"] = "The [[Emerald orb]] is used in the creation of the [[Emerald staff]]. Players can create the orb with [[Emerald shards]], or receive it as a rare drop from [[Emerald Beast]]s.<br>The [[Emerald orb]] can also be used to charge [[Gem beast#Weapons_2|Emerald weapons]].",
["Emerald bowstring"] = "The [[Emerald bowstring]] is used in the creation of the [[Emerald longbow]] and [[Emerald shortbow]]. Players can create the bowstring with [[Emerald shards]], or receive it as a rare drop from [[Emerald Beast]]s.<br>The [[Emerald bowstring]] can also be used to charge [[Gem beast#Weapons_2|Emerald weapons]].",
["Emerald spike"] = "The [[Emerald spike]] is used in the creation of certain [[[Gem beast#Weapons_2|Emerald weapons]]. Players can create the spike with [[Emerald shards]], or receive it as a rare drop from [[Emerald Beast]]s.<br>The [[Emerald spike]] can also be used to charge [[Gem beast#Weapons_2|Emerald weapons]].",
["Sapphire weapon seed"] = "The [[Sapphire weapon seed]] is used in the creation of [[Gem_beast#Weapons|Sapphire weapons]]. Players can create the weapon seed with [[Sapphire shards]], or receive it as a rare drop from [[Sapphire Beast]]s.", 
["Sapphire armour seed"] = "The [[Sapphire armour seed]] is used in the creation of [[Gem_beast#Armour|Sapphire armour]]. Players can create the armour seed with [[Sapphire shards]], or receive it as a rare drop from [[Sapphire Beast]]s.",
["Sapphire frame"] = "The [[Sapphire frame]] is used in the creation of all [[Gem_beast#Weapons|Sapphire weapons]]. Players can create the frame with [[Sapphire shards]], or receive it as a rare drop from [[Sapphire Beast]]s.<br>The [[Sapphire frame]] can also be used to charge [[Gem beast#Weapons|Sapphire weapons]].",
["Sapphire orb"] = "The [[Sapphire orb]] is used in the creation of the [[Sapphire staff]]. Players can create the orb with [[Sapphire shards]], or receive it as a rare drop from [[Sapphire Beast]]s.<br>The [[Sapphire orb]] can also be used to charge [[Gem beast#Weapons|Sapphire weapons]].",
["Sapphire bowstring"] = "The [[Sapphire bowstring]] is used in the creation of the [[Sapphire longbow]] and [[Sapphire shortbow]]. Players can create the bowstring with [[Sapphire shards]], or receive it as a rare drop from [[Sapphire Beast]]s.<br>The [[Sapphire bowstring]] can also be used to charge [[Gem beast#Weapons|Sapphire weapons]].",
["Sapphire spike"] = "The [[Sapphire spike]] is used in the creation of certain [[Gem_beast#Weapons|Sapphire weapons]]. Players can create the spike with [[Sapphire shards]], or receive it as a rare drop from [[Sapphire Beast]]s.<br>The [[Sapphire spike]] can also be used to charge [[Gem beast#Weapons|Sapphire weapons]].",
["Dragonstone shards"] = "[[Dragonstone shards]] are a common drop from [[Dragonstone Drake]]s. Dragonstone shards are used in all [[Gem beast#Dragonstone Drake|Dragonstone]] weapon and armour crafts, and are also used to charge [[Gem beast#Weapons_5|Dragonstone weapons]] at a rate of 21 charges per 1 shard.",	
["Diamond shards"] = "[[Diamond shards]] are a common drop from [[Diamond Beast]]s. Diamond shards are used in all [[Gem beast#Diamond Beast|Diamond]] weapon and armour crafts, and are also used to charge [[Gem beast#Weapons_5|Diamond weapons]] at a rate of 22 charges per 1 shard.",
["Ruby shards"] = "[[Ruby shards]] are a common drop from [[Ruby Beast]]s. Ruby shards are used in all [[Gem beast#Ruby Beast|Ruby]] weapon and armour crafts, and are also used to charge [[Gem beast#Weapons_5|Ruby weapons]] at a rate of 23 charges per 1 shard.",
["Emerald shards"] = "[[Emerald shards]] are a common drop from [[Emerald Beast]]s. Emerald shards are used in all [[Gem beast#Emerald Beast|Emerald]] weapon and armour crafts, and are also used to charge [[Gem beast#Weapons_5|Emerald weapons]] at a rate of 24 charges per 1 shard.",
["Sapphire shards"] = "[[Sapphire shards]] are a common drop from [[Sapphire Beast]]s. Sapphire shards are used in all [[Gem beast#Sapphire Beast|Sapphire]] weapon and armour crafts, and are also used to charge [[Gem beast#Weapons_5|Sapphire weapons]] at a rate of 25 charges per 1 shard.",
["Dragonstone"] = "Not to be confused with [[Uncut dragonstone]]",
["Uncut dragonstone"] = "Not to be confused with [[Uncut dragonstone]]",
["Diamond"] = "Not to be confused with [[Uncut Diamond]]",
["Uncut diamond"] = "Not to be confused with [[Uncut Diamond]]",
["Ruby"] = "Not to be confused with [[Uncut Ruby]]",
["Uncut ruby"] = "Not to be confused with [[Uncut Ruby]]",
["Emerald"] = "Not to be confused with [[Uncut Emerald]]",
["Uncut emerald"] = "Not to be confused with [[Uncut Emerald]]",
["Sapphire"] = "Not to be confused with [[Uncut Sapphire]]",
["Uncut sapphire"] = "Not to be confused with [[Uncut Sapphire]]",
["Marinated big bass"] = "Requiring [[Prestige#Skilling_Benefits|Prestige 1]] Level 80 [[Cooking]], [[Marinated big bass]] can be created at the [[Home#Raids_Area|Olympian Brazier]]. [[Marinated big bass]] is used to create [[Hecate's Mana (I)]].",
["Marinated big swordfish"] = "Requiring [[Prestige#Skilling_Benefits|Prestige 1]] Level 80 [[Cooking]], [[Marinated big swordfish]] can be created at the [[Home#Raids_Area|Olympian Brazier]]. [[Marinated big swordfish]] is used to create [[Hecate's Mana (II)]].",
["Marinated big shark"] = "Requiring [[Prestige#Skilling_Benefits|Prestige 1]] Level 80 [[Cooking]], [[Marinated big shark]] can be created at the [[Home#Raids_Area|Olympian Brazier]]. [[Marinated big shark]] is used to create [[Hecate's Mana (III)]].",
["Aquamarine"] = "[[Aquamarine]]s are a possible legendary reward from [[Olympian Raid]]s. Aquamarines are crafting components used in the creation of [[Posideon armour]] set and the [[Cape of the seas]]. <br>When combined with an [[Olympian component side-grade token]], this item can be changed into either a [[Luminary bow string]], [[Luminary essence]], or [[Volcanic heartstone]].",
["Volcanic heartstone"] = "[[Volcanic heartstone]]s are a possible legendary reward from [[Olympian Raid]]s. Volcanic Heartstones are crafting components used in the creation of the [[Titanforge armour]] set. <br>When combined with an [[Olympian component side-grade token]], this item can be changed into either a [[Aquamarine]], [[Luminary bow string]], or [[Luminary essence]].",
["Luminary essence"] = "[[Luminary essence]] is a possible legendary reward from [[Olympian Raid]]s. Luminary essence is a crafting component used in the creation of the [[Luminary armour]] set. <br>When combined with an [[Olympian component side-grade token]], this item can be changed into either a [[Aquamarine]], [[Luminary bow string]], or [[Volcanic heartstone]].",
["Luminary bow string"] = "[[Luminary bow string]]s are a possible legendary reward from [[Olympian Raid]]s. Luminary bow strings are crafting components used in the creation of the [[Heavenly bow]]. <br>When combined with an [[Olympian component side-grade token]], this item can be changed into either a [[Aquamarine]], [[Luminary essence]], or [[Volcanic heartstone]].",
	
}

function p.getDescription(frame)
    local itemName = frame.args[1] or ""
    local description = descriptions[itemName]
    
    if description then
        return description
    end
    
    return string.format("''No description available for %s. Please edit [[Module:ManualDescriptions]] to add one.''", itemName)
end

return p