Contributing

From Melvor Idle
This page is up to date (v1.0.3).

If you want to help with the wiki, join our Discord and direct message one of the Wiki Admins for an account.

What to do

- Main article: Contributing/To-Do List

If you want to help but don't know what you can do, here are a couple of things you can do:

  • Check Category:Out of Date pages, update them if necessary, and then update the template call on the page to the newest version.
  • Check Category:Pages with broken file links and fix missing images if needed.
  • Update pages such as the Money Making Guide or the FAQ to weed out answers that are obsolete and update ones that are out of date.
  • Look through existing Guides and refine the formatting or add additional information.

What not to do

A lot of the content on the Wiki is also generated via Lua functions. Please be cautious around this. If you notice a page generated by Lua, contact one of the Wiki Admins before editing the page.

If you wish to add information on pages with generated content, please edit the text above the placement of the template. For example, Crown of Rhaelyx (item).png Crown of Rhaelyx.

Generated content currently includes:

If you do find an issue with the accuracy of information in any of these templates, it is possible that the internal game data is flawed, or there has been a recent hotfix (hidden update without a version number change) to the game code and the Lua data modules need to be updated.

Templates

We use a number of templates on the wiki for various purposes. Such as the {{Menu}} template for the menu at the bottom of the page. To access the source page of a template, as for example the Menu template, simply go to the Template:Menu page. Because these pages are templates, they will automatically be imported when referred to, and therefore do not need the prior colon. Otherwise you'd need to prepend a colon to the page name {{:Menu}} to include its content.

Templates furthermore support numeric arguments, referenced in the templates by {{{1}}}, but also named arguments. An example of this would be {{{text}}} for {{ItemIcon|Mole|text=A summon}}.

Some of the templates are simply wrappers for Lua modules, which will include {{#invoke:SomeModule|someFunction}}. To access the module source files, simply go to Module:SomeModule, and look for someFunction in there.

Also note that if an argument is optional, you can simply append a pipe symbol after its name (be it numeric or a named keyword argument) to default to the empty string.

Versioning

We have created a system of templates to mark which pages are up to date. At the top of every page there should be a template indicating for which version the page is written. This will look like either {{V}} or {{V|1.0}}.

  • If a page is entirely populated by Lua-powered templates, then simply add {{V}} to the top of the page.
  • If a page contains a decent amount of user-written text that has the potential to change with each version, then the version number should be specified. For example, if a page is written for version 1.0 you would add {{V|1.0}} to the top of the page.

Each page should have a version attached to it. Every version can be found in the Versions Category. One of the main tasks is to make sure that pages are up to date.

You can view the versioning system in action on the top right corner of this page.

Referencing other pages

- Main article: Contributing

If you have a bit of text in a page but have more text explaining that concept on another page, it might be a good idea to use the Main Template. This template adds a formatted link to the main article to the page.

Usage: {{Main|Reference=Contributing}}


Event Clue 1 (item).svg
This article has a strategy guide here.
All information on strategy will be on this page.

If there is a guide for a page you're working on somewhere else, you should probably refer to it using the Guide Template. This adds a formatted link to the guide on the page.

Usage: {{HasGuide|page=Contributing}}


Coins.svg
This article has a money making guide here.
Please add tips to the subpage, rather than the article below.

If you've maken a moneymaking guide, consider adding a reference to it on its main page with the Moneymaking guide template. The template adds a formatted link to the guide.

Usage: {{HasMMG|page=Contributing}}

Icons

There are a number of icon templates which allow contributors to easily add icon formatting to links and inline with text, some examples are provided below.

For a comprehensive list of all icon templates and documentation of parameters these functions use, see Template:Icon.

{{Icon|Loot Container Stacking}} Amulet of Looting (item).svg Loot Container Stacking
{{Icon|Zarrah|type=pet}} Zarrah (pet).svg Zarrah
{{PetIcon|Zarrah}} Zarrah (pet).svg Zarrah
{{MonsterIcon|Necromancer}} Necromancer (monster).svg Necromancer
{{Icon|Princess|type=thieving}} Princess (thieving).svg Princess
{{ZoneIcon|Strange Cave}} Strange Cave (combatArea).svg Strange Cave
{{Skill|Mining|Rock extraction}} Mining (skill).svg Rock extraction
{{PrayerIcon|Eagle Eye}} Eagle Eye (prayer).svg Eagle Eye
{{ItemIcon|Pig}} Pig (item).svg Pig
{{Icon|Wind Strike|type=spell}} Wind Strike (spell).svg Wind Strike
{{Icon|Weakening III|type=curse}} Weakening III (curse).svg Weakening III
{{Icon|Fury III|type=aurora}} Fury III (aurora).svg Fury III
{{UpgradeIcon|Golbin Crate|nolink=true}} Golbin Crate (upgrade).png Golbin Crate
{{ItemIcon|Lucky Herb Potion}} Lucky Herb Potion I (item).svg Lucky Herb Potion
Combat icon {{Icon|Melee|notext=true}} Combat icon Combat.svg
{{GP|1000.25}} Coins.svg 1,000.25
{{SC|1337}} Slayer Coins.svg 1,337
{{RC|42069}} Raid Coins.svg 42,069

Tables

{{AreaMonsters|Spider Forest}}
Name Combat Level Hitpoints Max Hit Combat Style Count
Spider (monster).svg Spider 51 250 72 Combat.svg Melee 3
Brown Spider (monster).svg Brown Spider 52 300 72 Combat.svg Melee 2
Evil Spider (monster).svg Evil Spider 90 750 102 Combat.svg Melee 2
Spider King (monster).svg Spider King 158 2,000 142 Combat.svg Melee 1
{{CombatTriangleAdjustmentTable}}
Player Style Game Mode VS Attack (skill).svg Melee VS Ranged (skill).svg Ranged VS Magic (skill).svg Magic
DMG DR DMG DR DMG DR
Attack (skill).svg Melee Standard +0% 1.00x +10% 1.25x -15% 0.75x
Hardcore.svg Hardcore +0% 1.00x +10% 1.25x -25% 0.50x
Ranged (skill).svg Ranged Standard -15% 0.95x +0% 1.00x +10% 1.25x
Hardcore.svg Hardcore -25% 0.75x +0% 1.00x +10% 1.25x
Magic (skill).svg Magic Standard +10% 1.25x -15% 0.85x +0% 1.00x
Hardcore.svg Hardcore +10% 1.25x -25% 0.75x +0% 1.00x
{{EquipmentTableFromList|Aeris God Helmet,Aeris God Platebody,Aeris God Platelegs,Aeris God Boots,Aeris God Gloves}}
{{Obstacles/Recommended
|obs11 = Rope Climb
|obs31 = Pit Jump
|obs41 = Coal Stones
|obs51 = Rooftop Run
|obs52 = Tree Climb
}}
ObstaclePillar (most effective → least effective)
Agility (skill).svg IRope Climb
Agility (skill).svg IIIPit Jump
Agility (skill).svg IVCoal Stones
Agility (skill).svg VRooftop RunTree Climb
{{Equipment/Recommended
|obs11 = Rope Climb
|helm1 = Glacia God Helmet
|helm2 = Ancient Wizard Hat
|neck1 = Fury of the Elemental Zodiacs
|neck2 = Elite Amulet of Magic
|cape1 = Skull Cape
|body1 = Glacia God Platebody
|legs1 = Glacia God Platelegs
|familiar11 = Ent
|familiar21 = Wolf
|familiar22 = Leprechaun
}}
SlotItem (most effective → least effective)
HelmetGlacia God Helmet (item).svg Glacia God HelmetAncient Wizard Hat (item).svg Ancient Wizard Hat
PlatebodyGlacia God Platebody (item).svg Glacia God Platebody
PlatelegsGlacia God Platelegs (item).svg Glacia God Platelegs
CapeSkull Cape (item).svg Skull Cape
AmuletFury of the Elemental Zodiacs (item).svg Fury of the Elemental ZodiacsElite Amulet of Magic (item).svg Elite Amulet of Magic
Familiar LeftEnt (item).svg Ent
Familiar RightWolf (item).svg WolfLeprechaun (item).svg Leprechaun


Tables with Sticky Headers

Some of the tables on the wiki have headers which are "sticky", that is they will remain at the top of a table as the user scrolls down. See Equipment for an example of this. In order to implement this on your tables first add the class "stickyHeader" to the start of the table. E.g:

{| class="wikitable sortable"

would become:

{| class="wikitable sortable stickyHeader"

Before you start your first row of headers you then add |- class="headerRow-0" before it.

If you have a second row of headers you must add |- class="headerRow-1" before it.

As an example:

Can be generated with the following wikitext

{| class="wikitable sortable stickyHeader"
|- class="headerRow-0"
! First Column 1
! Second Column 1
! Third Column 1
|- class="headerRow-1"
! First Column 2
! Second Column 2
! Third Column 2
|-
| 1
| 2
| 3
|}


Special wiki stuff

#REDIRECT [[Currency]] A single line with this in a page, will redirect it to the given page
{{:Currency}} Includes the whole Currency page here
<nowiki>something</nowiki> Disables wiki formatting for the string inside
<onlyinclude>Hello</onlyinclude> When including the page, it will only display this text
<includeonly>Hello</includeonly> Will only include the text while transcluding it, not in the source page
<noinclude>Hello</noinclude> Removes this text when importing the page it as an include
[[Contributing]] Links to another page on the wiki
[[Contributing|Want to help write the wiki?]] Want to help write the wiki?