Scripting and Extensions: Difference between revisions

From Melvor Idle
m (Update for v0.21)
(Remove Base parameter for VColor template following definition change for Template:CurrentVersion)
Line 1: Line 1:
<!-- Current game version below. Should usually just be {{CurrentVersion}}
{{V|0.21}}
-->{{#vardefine:CVer|{{CurrentVersion}}}}<!--
-->{{V|0.21}}
Many people have developed scripts and extensions that add QOL, automation, calculators and more. There is an active community of people trying to develop new scripts and extensions on the [https://discord.gg/KNakXTh Melvor Idle Discord].
Many people have developed scripts and extensions that add QOL, automation, calculators and more. There is an active community of people trying to develop new scripts and extensions on the [https://discord.gg/KNakXTh Melvor Idle Discord].


Line 23: Line 21:
| Accepts a user's save data export and displays the remaining items, pets, and monsters needed to complete the game.
| Accepts a user's save data export and displays the remaining items, pets, and monsters needed to complete the game.
| [https://discordapp.com/users/178688021456093185 Dandelock#6912]
| [https://discordapp.com/users/178688021456093185 Dandelock#6912]
{{VColor|Base={{#var:CVer}}|0.21}}
{{VColor|0.21}}
| Multi
| Multi
|-
|-
Line 29: Line 27:
| Import, modify, and export Save Data Exports
| Import, modify, and export Save Data Exports
| lwagf
| lwagf
{{VColor|Base={{#var:CVer}}|0.21}}
{{VColor|0.21}}
| Multi
| Multi
|-
|-
Line 35: Line 33:
| Determines whether dungeons, Slayer tiers, or any monsters can be safely idled.
| Determines whether dungeons, Slayer tiers, or any monsters can be safely idled.
| [https://discordapp.com/users/818221327826812950 Silber#6947]
| [https://discordapp.com/users/818221327826812950 Silber#6947]
{{VColor|Base={{#var:CVer}}|0.21}}
{{VColor|0.21}}
| [[Combat]]
| [[Combat]]
|}
|}
Line 52: Line 50:
| An updated fork of the original Combat Simulator
| An updated fork of the original Combat Simulator
| [https://discordapp.com/users/798542155999608873 Visua#9999]<br/>[https://discordapp.com/users/369499615357304853 TinyCoyote#1769]
| [https://discordapp.com/users/798542155999608873 Visua#9999]<br/>[https://discordapp.com/users/369499615357304853 TinyCoyote#1769]
{{VColor|Base={{#var:CVer}}|0.21}}
{{VColor|0.21}}
| [[Combat]]
| [[Combat]]
|-
|-
Line 58: Line 56:
| Allows you to queue up actions ahead of time and automatically spend mastery pool. Works with Tampermonkey but not Greasemonkey.
| Allows you to queue up actions ahead of time and automatically spend mastery pool. Works with Tampermonkey but not Greasemonkey.
| [https://discordapp.com/users/266517729131888640 8992#7954]
| [https://discordapp.com/users/266517729131888640 8992#7954]
{{VColor|Base={{#var:CVer}}|0.21}}
{{VColor|0.21}}
| Multi
| Multi
|-
|-
Line 64: Line 62:
| Displays different statistics relating to dungeon completion (Completion count, previous time, best time, average time)
| Displays different statistics relating to dungeon completion (Completion count, previous time, best time, average time)
| [https://discordapp.com/users/763882009641746452 Chrono#1840]
| [https://discordapp.com/users/763882009641746452 Chrono#1840]
{{VColor|Base={{#var:CVer}}|0.21}}
{{VColor|0.21}}
| [[Combat]]
| [[Combat]]
|-
|-
Line 70: Line 68:
| Adds automation and functionality to Melvor Idle, combining several userscripts into one
| Adds automation and functionality to Melvor Idle, combining several userscripts into one
| [https://discordapp.com/users/243146939611217931 Aldous Watts#2494]<br/>[https://discordapp.com/users/181210019163930624 TheAlpacalypse#8105]
| [https://discordapp.com/users/243146939611217931 Aldous Watts#2494]<br/>[https://discordapp.com/users/181210019163930624 TheAlpacalypse#8105]
{{VColor|Base={{#var:CVer}}|0.21}}
{{VColor|0.21}}
| Multi
| Multi
|-
|-
Line 76: Line 74:
| Dynamically adjusts game speed to compensate for lag. Forked from the original [https://greasyfork.org/en/scripts/421556-melvor-anti-lag Melvor Anti-Lag] by [https://discordapp.com/users/266517729131888640 8992#7954]
| Dynamically adjusts game speed to compensate for lag. Forked from the original [https://greasyfork.org/en/scripts/421556-melvor-anti-lag Melvor Anti-Lag] by [https://discordapp.com/users/266517729131888640 8992#7954]
| [https://discordapp.com/users/369499615357304853 TinyCoyote#1769]
| [https://discordapp.com/users/369499615357304853 TinyCoyote#1769]
{{VColor|Base={{#var:CVer}}|0.21}}
{{VColor|0.21}}
| QOL
| QOL
|-
|-
Line 82: Line 80:
| Shows progress to the next virtual level, and some related changes
| Shows progress to the next virtual level, and some related changes
| [https://discordapp.com/users/369499615357304853 TinyCoyote#1769]
| [https://discordapp.com/users/369499615357304853 TinyCoyote#1769]
{{VColor|Base={{#var:CVer}}|0.21}}
{{VColor|0.21}}
| QOL
| QOL
|-
|-
Line 89: Line 87:
Comment seeds you don't want to plant and equipment you don't want to use.
Comment seeds you don't want to plant and equipment you don't want to use.
| [https://discordapp.com/users/369499615357304853 TinyCoyote#1769]
| [https://discordapp.com/users/369499615357304853 TinyCoyote#1769]
{{VColor|Base={{#var:CVer}}|0.21}}
{{VColor|0.21}}
| [[Farming]]
| [[Farming]]
|-
|-
Line 95: Line 93:
| Shows greyed out images of items/monsters that you have yet to get/kill in the completion log and adds links to the wiki.
| Shows greyed out images of items/monsters that you have yet to get/kill in the completion log and adds links to the wiki.
| [https://discordapp.com/users/190161169321951232 Breindahl#2660]<br/>[https://discordapp.com/users/369499615357304853 TinyCoyote#1769]
| [https://discordapp.com/users/190161169321951232 Breindahl#2660]<br/>[https://discordapp.com/users/369499615357304853 TinyCoyote#1769]
{{VColor|Base={{#var:CVer}}|0.21}}
{{VColor|0.21}}
| UI/QOL
| UI/QOL
|-
|-
Line 101: Line 99:
| Shows Estimated Time till 100%, lvl 99... Requires Combat Simulator for GUI Settings.
| Shows Estimated Time till 100%, lvl 99... Requires Combat Simulator for GUI Settings.
| [https://discordapp.com/users/369499615357304853 TinyCoyote#1769]
| [https://discordapp.com/users/369499615357304853 TinyCoyote#1769]
{{VColor|Base={{#var:CVer}}|0.21}}
{{VColor|0.21}}
| UI/QOL
| UI/QOL
|-
|-
Line 107: Line 105:
| Agility course planner that allows you to filter agility obstacles based on skill of interest.
| Agility course planner that allows you to filter agility obstacles based on skill of interest.
| [https://discordapp.com/users/369499615357304853 TinyCoyote#1769]
| [https://discordapp.com/users/369499615357304853 TinyCoyote#1769]
{{VColor|Base={{#var:CVer}}|0.21}}
{{VColor|0.21}}
| [[Agility]]
| [[Agility]]
|-
|-
Line 113: Line 111:
| Adds character name and a timestamp to the default filename when downloading a save.
| Adds character name and a timestamp to the default filename when downloading a save.
| [https://discordapp.com/users/798542155999608873 Visua#9999]
| [https://discordapp.com/users/798542155999608873 Visua#9999]
{{VColor|Base={{#var:CVer}}|0.21}}
{{VColor|0.21}}
| UI/QOL
| UI/QOL
|-
|-
Line 119: Line 117:
| Automatically changes Runecrafting runes.
| Automatically changes Runecrafting runes.
| [https://discordapp.com/users/369499615357304853 TinyCoyote#1769]
| [https://discordapp.com/users/369499615357304853 TinyCoyote#1769]
{{VColor|Base={{#var:CVer}}|0.21}}
{{VColor|0.21}}
| UI/QOL
| UI/QOL
|-
|-
Line 125: Line 123:
| Adds button to Make X amount of actions of a skill and then stop. Forked from the original Melvor MakeX by [https://discordapp.com/users/190161169321951232 Breindahl#2660]
| Adds button to Make X amount of actions of a skill and then stop. Forked from the original Melvor MakeX by [https://discordapp.com/users/190161169321951232 Breindahl#2660]
| [https://discordapp.com/users/369499615357304853 TinyCoyote#1769]
| [https://discordapp.com/users/369499615357304853 TinyCoyote#1769]
{{VColor|Base={{#var:CVer}}|0.21}}
{{VColor|0.21}}
| UI/QOL
| UI/QOL
|-
|-
Line 131: Line 129:
| Adds a button to show all your currently active modifiers.
| Adds a button to show all your currently active modifiers.
| [https://discordapp.com/users/369499615357304853 TinyCoyote#1769]
| [https://discordapp.com/users/369499615357304853 TinyCoyote#1769]
{{VColor|Base={{#var:CVer}}|0.21}}
{{VColor|0.21}}
| UI/QOL
| UI/QOL
|-
|-
Line 137: Line 135:
| Automatically mines the highest available rock at all times.
| Automatically mines the highest available rock at all times.
| [https://discordapp.com/users/611895892844216353 kieranw#5073]
| [https://discordapp.com/users/611895892844216353 kieranw#5073]
{{VColor|Base={{#var:CVer}}|0.21}}
{{VColor|0.21}}
| [[Mining]]
| [[Mining]]
|-
|-
Line 143: Line 141:
| Manipulates the game in a variety of ways. Best used as a save recovery tool or to facilitate testing.
| Manipulates the game in a variety of ways. Best used as a save recovery tool or to facilitate testing.
| [https://discordapp.com/users/243146939611217931 Aldous Watts#2494]
| [https://discordapp.com/users/243146939611217931 Aldous Watts#2494]
{{VColor|Base={{#var:CVer}}|0.21}}
{{VColor|0.21}}
| Multi
| Multi
|-
|-
Line 149: Line 147:
| Bad Apple goes Melvor. This Fan Content is a fan work based on Touhou Project
| Bad Apple goes Melvor. This Fan Content is a fan work based on Touhou Project
| [https://discordapp.com/users/369499615357304853 TinyCoyote#1769]
| [https://discordapp.com/users/369499615357304853 TinyCoyote#1769]
{{VColor|Base={{#var:CVer}}|0.21}}
{{VColor|0.21}}
| UI/QOL
| UI/QOL
|-
|-
Line 155: Line 153:
| lemon
| lemon
| [https://discordapp.com/users/369499615357304853 TinyCoyote#1769]
| [https://discordapp.com/users/369499615357304853 TinyCoyote#1769]
{{VColor|Base={{#var:CVer}}|0.21}}
{{VColor|0.21}}
| UI/QOL
| UI/QOL
|-
|-
Line 161: Line 159:
| Makes item selections for you in Golbin Raid, does not use Auto-Eat.
| Makes item selections for you in Golbin Raid, does not use Auto-Eat.
| [https://discordapp.com/users/86953616094543872 NotCorgan#1234]
| [https://discordapp.com/users/86953616094543872 NotCorgan#1234]
{{VColor|Base={{#var:CVer}}|0.20}}
{{VColor|0.20}}
| [[Golbin Raid]]
| [[Golbin Raid]]
|-
|-
Line 167: Line 165:
| Removes the 12hr offline cap
| Removes the 12hr offline cap
| [https://discordapp.com/users/266517729131888640 8992#7954]
| [https://discordapp.com/users/266517729131888640 8992#7954]
{{VColor|Base={{#var:CVer}}|0.20}}
{{VColor|0.20}}
| QOL
| QOL
|-
|-
Line 173: Line 171:
| Big dashboard to track average items, gold value, kills and resources over time.
| Big dashboard to track average items, gold value, kills and resources over time.
| [https://discordapp.com/users/316212552457781250 Gardens#3738]
| [https://discordapp.com/users/316212552457781250 Gardens#3738]
{{VColor|Base={{#var:CVer}}|0.19.0}}
{{VColor|0.19.0}}
| UI/QOL
| UI/QOL
|-
|-
Line 179: Line 177:
| Automatically plants your lowest mastery seeds.
| Automatically plants your lowest mastery seeds.
| [https://discordapp.com/users/310577881803784202 JHawk55#8345]
| [https://discordapp.com/users/310577881803784202 JHawk55#8345]
{{VColor|Base={{#var:CVer}}|0.17.0}}
{{VColor|0.17.0}}
| [[Farming]]
| [[Farming]]
|-
|-
Line 185: Line 183:
| Gives you notification on [[Slayer#Slayer Tasks|slayer task]] completion.
| Gives you notification on [[Slayer#Slayer Tasks|slayer task]] completion.
| [https://discordapp.com/users/190161169321951232 Breindahl#2660]
| [https://discordapp.com/users/190161169321951232 Breindahl#2660]
{{VColor|Base={{#var:CVer}}|0.17.0}}
{{VColor|0.17.0}}
|-
|-
| [https://greasyfork.org/en/scripts/394854-melvor-auto-loot Melvor Auto Loot]
| [https://greasyfork.org/en/scripts/394854-melvor-auto-loot Melvor Auto Loot]
| Automatically loot [[Enemies|enemy]] drops
| Automatically loot [[Enemies|enemy]] drops
| [https://discordapp.com/users/615898740607156234 NotArcanus#3825]
| [https://discordapp.com/users/615898740607156234 NotArcanus#3825]
{{VColor|Base={{#var:CVer}}|0.15.2}}
{{VColor|0.15.2}}
| Auto-Loot
| Auto-Loot
|-
|-
Line 196: Line 194:
| Automatically replants the same seed for [[Farming]]
| Automatically replants the same seed for [[Farming]]
| [https://discordapp.com/users/615898740607156234 NotArcanus#3825]
| [https://discordapp.com/users/615898740607156234 NotArcanus#3825]
{{VColor|Base={{#var:CVer}}|0.15.2}}
{{VColor|0.15.2}}
| [[Farming]]
| [[Farming]]
|-
|-
Line 202: Line 200:
| Automatically sells [[Fishing#Junk|junk]] caught while [[Fishing|fishing]]
| Automatically sells [[Fishing#Junk|junk]] caught while [[Fishing|fishing]]
| [https://discordapp.com/users/243146939611217931 Aldous Watts#2494]
| [https://discordapp.com/users/243146939611217931 Aldous Watts#2494]
{{VColor|Base={{#var:CVer}}|0.15.2}}
{{VColor|0.15.2}}
| Auto-Sell
| Auto-Sell
|-
|-
Line 208: Line 206:
| Automatically tries to plant the highest tier seeds avaible
| Automatically tries to plant the highest tier seeds avaible
| Dejv#3141
| Dejv#3141
{{VColor|Base={{#var:CVer}}|0.15.1}}
{{VColor|0.15.1}}
| [[Farming]]
| [[Farming]]
|-
|-
Line 214: Line 212:
| Several automatic functionalities
| Several automatic functionalities
| [https://discordapp.com/users/459758357692153866 Katorone#2957]
| [https://discordapp.com/users/459758357692153866 Katorone#2957]
{{VColor|Base={{#var:CVer}}|0.12.2}}
{{VColor|0.12.2}}
| Multi
| Multi
|-
|-
Line 220: Line 218:
| Automatically lights [[Firemaking#Bonfire|bonfires]] for [[Firemaking]]
| Automatically lights [[Firemaking#Bonfire|bonfires]] for [[Firemaking]]
| [https://discordapp.com/users/190295254073606144 Dream#1511]
| [https://discordapp.com/users/190295254073606144 Dream#1511]
{{VColor|Base={{#var:CVer}}|0.11.2}}
{{VColor|0.11.2}}
| [[Firemaking]]
| [[Firemaking]]
|-
|-
Line 226: Line 224:
| Mines highest ore available
| Mines highest ore available
| [https://discordapp.com/users/84980169600679936 Natsulus#0001]
| [https://discordapp.com/users/84980169600679936 Natsulus#0001]
{{VColor|Base={{#var:CVer}}|0.11.2}}
{{VColor|0.11.2}}
| [[Mining]]
| [[Mining]]
|-
|-
Line 232: Line 230:
| Switches between [[Tin Ore|tin]] and [[Copper Ore|copper]] to mine for [[Bronze Bar|bronze]]
| Switches between [[Tin Ore|tin]] and [[Copper Ore|copper]] to mine for [[Bronze Bar|bronze]]
| [https://discordapp.com/users/131154769942151168 nysos3#7071]
| [https://discordapp.com/users/131154769942151168 nysos3#7071]
{{VColor|Base={{#var:CVer}}|0.11.2}}
{{VColor|0.11.2}}
| [[Mining]]
| [[Mining]]
|-
|-
Line 238: Line 236:
| Automatically [[Mining|mines]] based on input ore priority
| Automatically [[Mining|mines]] based on input ore priority
| [https://discordapp.com/users/328305525710258176 Brqqq#2634]
| [https://discordapp.com/users/328305525710258176 Brqqq#2634]
{{VColor|Base={{#var:CVer}}|0.11.2}}
{{VColor|0.11.2}}
| [[Mining]]
| [[Mining]]
|-
|-
Line 244: Line 242:
| Adds [[Smithing]] HUD and XP calculator
| Adds [[Smithing]] HUD and XP calculator
| [https://discordapp.com/users/170536827286061056 Bioniclegenius#3272]
| [https://discordapp.com/users/170536827286061056 Bioniclegenius#3272]
{{VColor|Base={{#var:CVer}}|0.11.2}}
{{VColor|0.11.2}}
| [[Smithing]]
| [[Smithing]]
|-
|-
Line 250: Line 248:
| Monitors XP/HR stats experimentally
| Monitors XP/HR stats experimentally
| Breakit
| Breakit
{{VColor|Base={{#var:CVer}}|0.11.2}}
{{VColor|0.11.2}}
| UI/QOL
| UI/QOL
|}
|}

Revision as of 09:41, 14 September 2021

This page was last updated for (v0.21).

Many people have developed scripts and extensions that add QOL, automation, calculators and more. There is an active community of people trying to develop new scripts and extensions on the Melvor Idle Discord.

Disclaimer: It is possible that there are bugs in these scripts that could corrupt your game. Also note that many of these scripts and extensions were created for earlier versions of the game and could not be working in newer versions, or worst case scenario, corrupt your save.

It is highly recommended to BACKUP YOUR SAVE before running any scripts or extensions.

Disclaimer: Do not run code you can not understand or do not trust. Malicious code could be included in any of these scripts and extensions.

List of Independent Tools

These tools are used independently of the Melvor Idle app and website. Usually they are independent reference tools or interact with game data via the save data export.

List of Scripts and Extensions

These tools are used as part of the Melvor Idle app and website. Usually they are add ons that add menus, sections, or other functionality to the game interface.

In-game functions

It is possible to interact directly with the in-game functions of the game through the console. This can be used to add items, levels, GP and more.

How to Use?

Depending on the type of script or extension there are different ways needed to add them to the game. For Steam, see Scripting and Extensions Instructions.

Extensions

Extensions are independent add-ons that run in the browser. How to install varies from different browsers.

For Firefox, most extensions can be installed directly to the browser from the Firefox Extension Store.

For Chrome, many extensions needs to be added as an upacked extension while in Developer Mode.

Some extensions might require you to edit specific files or set specific variables before they can run. The page with the download link will usually have a more detailed explanation on how to install.

Remember to refresh the game for the extension to take effect.

Userscripts

Userscripts are programs that run by the help of userscript manager browser extensions such as Greasemonkey or Tampermonkey.

If the source of your userscript is a userscript repository, such as Greasyfork, simply Install by clicking the button on the page.

If the userscript is shared through a plain text sharing site, such as Pastebin, copy the code into a new userscript in your userscript manager browser extension.

Remember to refresh the game for the userscript to take effect.

Console scripts

The simplest form of scripts are javascript code that are pasted directly into the console of of your browser.

To access the console open Developer Tools (usually by pressing F12) in your browser and navigate to the console. Then, simply paste the code in the input field and press enter. Most console scripts will require you to fill out variables in the code before executing them.

Do note that unlike extensions and userscripts, console scripts will run without refreshing the game, but will in turn not be saved when the game is closed.