Scripting and Extensions: Difference between revisions

From Melvor Idle
m (Update Discord server link)
 
(57 intermediate revisions by 11 users not shown)
Line 1: Line 1:
<!--No version number since version is per tool/script-->
<!--No version number since version is per tool/script
--><div class="warningbox">While mod developers take every precaution to ensure their mods are stable, it is possible that mods could contain bugs which in the worst case may corrupt your saves. Therefore, it is highly recommended to '''BACKUP YOUR SAVES''' before using any mods, and to take backups on a regular schedule thereafter.</div>
 
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/MelvorIdle 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/MelvorIdle 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.
From [[V1.1]] onwards, all mods available for the game can be browsed either on [https://mod.io/g/melvoridle mod.io] or through the in-game mod manager. Mods may then also be subscribed to via the in-game mod manager. The mod manager must first be enabled within the in-game settings, after which the mod manager will be accessible from the side bar.


It is highly recommended to '''BACKUP YOUR SAVE''' before running any scripts or extensions.
For spreadsheet based calculators instead, see [[Spreadsheets and Theorycrafting]].
 
'''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 ==
== List of Independent Tools ==
Line 18: Line 18:
! Aspects
! Aspects
|-
|-
| [https://silberdrachi.github.io/CanIIdle/ Can I Idle Melvor?]
| [https://melvor-calc.kpwn243.com/ Melvor Calculators]
| Determines whether dungeons, Slayer tiers, or any monsters can be safely idled.
| Contains various calculators for the game, currently a combat level calculator is available with more planned in the future.
| [https://discordapp.com/users/818221327826812950 Silber#6947]
| [https://discordapp.com/users/145335611631337472 kpwn243]
{{VColor|1.0}}
{{VColor|1.0.5}}
| Loot
|-
| [https://github.com/vbion/melvor-coupon-solver/ Melvor Coupon Solver]
| Calculates how many times you need to clear a dungeon to get at least one of each items that you want.
| vbion#1668, Benjamin#5349
{{VColor|1.0}}
| Multi
| Multi
|-
|-
| [https://mict.spectralcoding.com/ Melvor Idle Completionist Tool]
| 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]
{{VColor|0.22.1}}
| Multi
|-
| [https://lwagf.github.io/melvoredit/ MelvorEdit]
| Import, modify, and export Save Data Exports
| lwagf
{{VColor|0.22}}
| Multi
|}
|}


== List of Scripts and Extensions ==
=== In-Game Functions ===
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.
{{Main|Reference=In-game Functions}}
{| class="wikitable sortable stickyHeader"
|- class="headerRow-0"
! Name
! Description
! Author
! Version
! Aspects
|-
| [https://greasyfork.org/en/scripts/435520-melvor-items-drop-rates Melvor Items Drop Rates]
| Shows monsters and chest items drop rates
| [https://discordapp.com/users/909829590992711730 Polfy#6924]
{{VColor|1.0}}
| QOL
|-
| [https://greasyfork.org/en/scripts/435548-melvor-auto-loot Melvor Auto Loot]
| Add an Auto-Loot toggle button in combat.
| [https://discordapp.com/users/909829590992711730 Polfy#6924]
{{VColor|1.0}}
| Auto-Loot
|-
| [https://gitlab.com/aldousWatts/SEMI Scripting Engine for Melvor Idle] (SEMI)
| 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]
{{VColor|1.0}}
| Multi
|-
| [https://greasyfork.org/scripts/428138 Melvor Virtual Levels]
| Shows progress to the next virtual level, and some related changes
| [https://discordapp.com/users/369499615357304853 TinyCoyote#1769]
{{VColor|1.0}}
| QOL
|-
| [https://greasyfork.org/en/scripts/419699 Melvor Auto Farming]
| Automatically plants your seeds, prioritizes highest level tree seed and equal allotment and herb produce.
Comment seeds you don't want to plant and equipment you don't want to use.
| [https://discordapp.com/users/369499615357304853 TinyCoyote#1769]
{{VColor|1.0}}
| [[Farming]]
|-
| [https://greasyfork.org/en/scripts/415592 Melvor ETA]
| Shows Estimated Time till 100%, lvl 99... Requires Combat Simulator for GUI Settings.
| [https://discordapp.com/users/369499615357304853 TinyCoyote#1769]
{{VColor|1.0}}
| UI/QOL
|-
| [https://greasyfork.org/en/scripts/430344 Melvor Obstacle Filter]
| Agility course planner that allows you to filter agility obstacles based on skill of interest.
| [https://discordapp.com/users/369499615357304853 TinyCoyote#1769]
{{VColor|1.0}}
| [[Agility]]
|-
| [https://greasyfork.org/en/scripts/423121 Melvor Show Modifiers]
| Adds a button to show all your currently active modifiers.
| [https://discordapp.com/users/369499615357304853 TinyCoyote#1769]
{{VColor|1.0}}
| UI/QOL
|-
| [https://greasyfork.org/en/scripts/426675 Bad Lemon]
| Bad Apple goes Melvor. This Fan Content is a fan work based on Touhou Project
| [https://discordapp.com/users/369499615357304853 TinyCoyote#1769]
{{VColor|1.0}}
| UI/QOL
|-
| [https://greasyfork.org/en/scripts/423027 Lemvor]
| lemon
| [https://discordapp.com/users/369499615357304853 TinyCoyote#1769]
{{VColor|1.0}}
| UI/QOL
|-
| [https://greasyfork.org/en/scripts/425457-melvor-dungeontimer Melvor DungeonTimer]
| Displays different statistics relating to dungeon completion (Completion count, previous time, best time, average time)
| [https://discordapp.com/users/763882009641746452 Chrono#1840]
{{VColor|1.0}}
| [[Combat]]
|-
| [https://greasyfork.org/scripts/430727 Melvor Additive Skilling Anti-Lag]
| 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]
{{VColor|1.0}}
| QOL
|-
| [https://greasyfork.org/en/scripts/435372 Melvor Unlimited Offline]
| Removes the 18 hour offline cap
| [https://discordapp.com/users/369499615357304853 TinyCoyote#1769]
{{VColor|1.0}}
| QOL
|-
| [https://greasyfork.org/en/scripts/412689-melvor-action-queue Melvor Action Queue]
| 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]
{{VColor|1.0}}
| Multi
|-
| [https://discord.com/channels/625838709203271680/664637399028072470/909936190113874000 Melvor Astrology 5 Reroll]
| All astrology rerolls will net 5% modifiers
| [https://discordapp.com/users/909234620321648690 Zakangroth#2453]
{{VColor|1.0}}
| [[Astrology]]
|-
| [https://discord.com/channels/625838709203271680/664637399028072470/909936179980427348 Melvor Astrology Buy]
| Buy astrology modifiers for a user set amount
| [https://discordapp.com/users/909234620321648690 Zakangroth#2453]
{{VColor|1.0}}
| [[Astrology]]
|-
| [https://greasyfork.org/en/scripts/435688 Additional Bank Buttons]
| Adds bank buttons to select all items in current tab while in move/sell mode & reset default bank tabs for all items that are currently not in the bank
| [https://discordapp.com/users/912116703297695834 Xander#8896]
{{VColor|1.0}}
| UI/QOL
|-
| [https://greasyfork.org/en/scripts/435689 Close Offline Progress Pop-up]
| Automatically dismisses offline progress pop-up when it's displaying less than 10 minutes of progress
| [https://discordapp.com/users/912116703297695834 Xander#8896]
{{VColor|1.0}}
| UI/QOL
|-
| [https://greasyfork.org/en/scripts/435854 Impending Darkness for Combat Only Characters]
| Allows players to run Impending Darkness when they have level 99 in all combat skills and level 1 in all non-combat skills
| [https://discordapp.com/users/912116703297695834 Xander#8896]
{{VColor|1.0}}
| [[Game_Mode#Hardcore_Combat_Only_.28HCCO.29|HCCO]]
|-
| [https://greasyfork.org/en/scripts/422123-melvor-idle-item-dashboard-miid Melvor Idle Item Dashboard (MIID)]
| Big dashboard to track average items, gold value, kills and resources over time.
| [https://discordapp.com/users/316212552457781250 Gardens#3738]
{{VColor|1.0}}
| UI/QOL
|-
| [https://greasyfork.org/en/scripts/436210 Notification Golbin Raid]
| Notifies you when a wave in the golbin raid minigame is finished.
| [https://discordapp.com/users/912116703297695834 Xander#8896]
{{VColor|1.0}}
| [[Golbin Raid]]
|-
| [[Combat Simulator|Combat Simulator Reloaded]]
| An updated fork of the original Combat Simulator
| [https://discordapp.com/users/798542155999608873 Visua#9999]<br/>[https://discordapp.com/users/369499615357304853 TinyCoyote#1769]
{{VColor|0.22}}
| [[Combat]]
|-
| [https://greasyfork.org/en/scripts/405082-melvor-completion-log-helper Melvor Completion Log Helper]
| 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]
{{VColor|0.22}}
| UI/QOL
|-
| [https://greasyfork.org/en/scripts/411909-melvor-idle-timestamped-saves Melvor Idle Timestamped Saves]
| Adds character name and a timestamp to the default filename when downloading a save.
| [https://discordapp.com/users/798542155999608873 Visua#9999]
{{VColor|0.22}}
| UI/QOL
|-
| [https://greasyfork.org/en/scripts/425582-melvor-swap-rc Melvor Swap RC]
| Automatically changes Runecrafting runes.
| [https://discordapp.com/users/369499615357304853 TinyCoyote#1769]
{{VColor|0.22}}
| UI/QOL
|-
| [https://greasyfork.org/en/scripts/423057-melvor-make-xi Melvor Make-XI]
| 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]
{{VColor|0.22}}
| UI/QOL
|-
| [https://greasyfork.org/en/scripts/434605-melvor-bank-tab-values Melvor Bank Tab Values]
| Adds gp value of tab to the tab button
| [https://discordapp.com/users/591280269491830790 WhackyGirl#4639]
{{VColor|1.0}}
| UI/QOL
|-
| [https://greasyfork.org/en/scripts/434606-melvor-auto-slayer Melvor Auto Slayer]
| Auto Slayer
| [https://discordapp.com/users/591280269491830790 WhackyGirl#4639]
{{VColor|0.22}}
| [[Combat]]
|-
| [https://gitlab.com/aldousWatts/MICE/-/blob/main/README.md Melvor Idle Cheat Engine] (MICE)
| 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]
{{VColor|0.21}}
| Multi
|-
| [https://greasyfork.org/en/scripts/423552-melvor-golbin-raider Melvor Golbin Raider]
| Makes item selections for you in Golbin Raid, does not use Auto-Eat.
| [https://discordapp.com/users/86953616094543872 NotCorgan#1234]
{{VColor|0.20}}
| [[Golbin Raid]]
|-
| [https://greasyfork.org/en/scripts/394855-melvor-auto-replant Melvor Auto Replant]
| Automatically replants the same seed for [[Farming]]
| [https://discordapp.com/users/615898740607156234 NotArcanus#3825]
{{VColor|0.15.2}}
| [[Farming]]
|-
| [https://greasyfork.org/en/scripts/400027-melvor-idle-autosell-fishing-junk/code Melvor Idle AutoSell Fishing Junk]
| Automatically sells [[Fishing#Junk|junk]] caught while [[Fishing|fishing]]
| [https://discordapp.com/users/243146939611217931 Aldous Watts#2494]
{{VColor|0.15.2}}
| Auto-Sell
|-
| [https://pastebin.com/KjJnLt7f Auto planter by priorities]
| Automatically tries to plant the highest tier seeds avaible
| Dejv#3141
{{VColor|0.15.1}}
| [[Farming]]
|-
| [https://discordapp.com/channels/625838709203271680/664637399028072470/671113318135627808 Smithing HUD]
| Adds [[Smithing]] HUD and XP calculator
| [https://discordapp.com/users/170536827286061056 Bioniclegenius#3272]
{{VColor|0.11.2}}
| [[Smithing]]
|-
| [https://pastebin.com/wq641Nhx XPH]
| Monitors XP/HR stats experimentally
| Breakit
{{VColor|0.11.2}}
| UI/QOL
|}
 
=== In-game functions ===
{{main|Reference=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.
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 [https://addons.mozilla.org/en-US/firefox/extensions/ Firefox Extension Store].
For Chrome, many extensions needs to be added as an [https://developer.chrome.com/extensions/getstarted 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 [https://www.greasespot.net/ Greasemonkey] or [https://www.tampermonkey.net/ Tampermonkey].
If the source of your userscript is a userscript repository, such as [https://greasyfork.org/ Greasyfork], simply Install by clicking the button on the page.
If the userscript is shared through a plain text sharing site, such as [https://pastebin.com/ 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.


{{Menu}}
{{Menu}}
[[Category:Guides]]
[[Category:Guides]]

Latest revision as of 12:57, 26 July 2024

While mod developers take every precaution to ensure their mods are stable, it is possible that mods could contain bugs which in the worst case may corrupt your saves. Therefore, it is highly recommended to BACKUP YOUR SAVES before using any mods, and to take backups on a regular schedule thereafter.

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.

From V1.1 onwards, all mods available for the game can be browsed either on mod.io or through the in-game mod manager. Mods may then also be subscribed to via the in-game mod manager. The mod manager must first be enabled within the in-game settings, after which the mod manager will be accessible from the side bar.

For spreadsheet based calculators instead, see Spreadsheets and Theorycrafting.

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.

Name Description Author Version Aspects
Melvor Calculators Contains various calculators for the game, currently a combat level calculator is available with more planned in the future. kpwn243 1.0.5 Multi

In-Game Functions

Main article: 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.


Melvor Idle version v1.3.1 (Released: 30th October 2024)
Error creating thumbnail: File missing
Combat:
Error creating thumbnail: File missing
Attack •
Error creating thumbnail: File missing
Strength •
Error creating thumbnail: File missing
Defence •
Error creating thumbnail: File missing
Hitpoints •
Error creating thumbnail: File missing
Ranged •
Error creating thumbnail: File missing
Magic •
Error creating thumbnail: File missing
Prayer •
Error creating thumbnail: File missing
Slayer •
Error creating thumbnail: File missing
Corruption
Skills:
Error creating thumbnail: File missing
Farming •
Error creating thumbnail: File missing
Township •
Error creating thumbnail: File missing
Woodcutting •
Error creating thumbnail: File missing
Fishing •
Error creating thumbnail: File missing
Firemaking •
Error creating thumbnail: File missing
Cooking •
Error creating thumbnail: File missing
Mining •
Error creating thumbnail: File missing
Smithing •
Error creating thumbnail: File missing
Thieving •
Error creating thumbnail: File missing
Fletching •
Error creating thumbnail: File missing
Crafting •
Error creating thumbnail: File missing
Runecrafting •
Error creating thumbnail: File missing
Herblore •
Error creating thumbnail: File missing
Agility •
Error creating thumbnail: File missing
Summoning •
Error creating thumbnail: File missing
Astrology •
Error creating thumbnail: File missing
Alternative Magic •
Error creating thumbnail: File missing
Cartography •
Error creating thumbnail: File missing
Archaeology •
Error creating thumbnail: File missing
Harvesting
Other:
Error creating thumbnail: File missing
Beginners Guide • Guides •
Error creating thumbnail: File missing
Bank •
Error creating thumbnail: File missing
Combat •
Error creating thumbnail: File missing
Mastery •
Error creating thumbnail: File missing
Money Making •
Error creating thumbnail: File missing
Shop • Easter Eggs • Pets •
Error creating thumbnail: File missing
Golbin Raid •
Error creating thumbnail: File missing
Full Version • Throne of the Herald • Atlas of Discovery •
Error creating thumbnail: File missing
Into the Abyss
Reference Tables: Items, Equipment, Experience Table, Upgrading Items, Combat Areas, Slayer Areas, Dungeons, Strongholds, The Abyss, Monsters
Retrieved from "https://testwiki.melvoridle.com/index.php?title=Scripting_and_Extensions&oldid=78227"