Scripting and Extensions: Difference between revisions

From Melvor Idle
m (Remove excessive whitespace)
 
(104 intermediate revisions by 15 users not shown)
Line 1: Line 1:
{{V|0.20}}
<!--No version number since version is per tool/script
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].
--><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>


'''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.
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].


It is highly recommended to '''BACKUP YOUR SAVE''' before running any scripts or extensions.
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.


'''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.
For spreadsheet based calculators instead, see [[Spreadsheets and Theorycrafting]].


== List of Independent Tools ==
== List of Independent Tools ==
Line 18: Line 18:
! Aspects
! Aspects
|-
|-
| [https://lwagf.github.io/melvoredit/ MelvorEdit]
| [https://melvor-calc.kpwn243.com/ Melvor Calculators]
| Import, modify, and export Save Data Exports
| Contains various calculators for the game, currently a combat level calculator is available with more planned in the future.
| lwagf
| [https://discordapp.com/users/145335611631337472 kpwn243]
| style="background-color:#E8FFEB;" | 0.20
{{VColor|1.0.5}}
| Multi
| Multi
|-
|-
| [https://silberdrachi.github.io/CanIIdle/ Can I Idle Melvor?]
| Determines whether dungeons, Slayer tiers, or any monsters can be safely idled.
| [https://discordapp.com/users/818221327826812950 Silber#6947]
| style="background-color:#E8FFEB;" | 0.20
| [[Combat]]
|-
| [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]
| style="background-color:#E8FFEB;" | 0.20
| Multi
|}
== 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.
{| class="wikitable sortable stickyHeader"
|- class="headerRow-0"
! Name
! Description
! Author
! Version
! Aspects
|-
| [https://github.com/visua0/Melvor-Idle-Combat-Simulator-Reloaded 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]
| style="background-color:#E8FFEB;" | 0.20
| [[Combat]]
|-
| [https://greasyfork.org/en/scripts/419699-melvor-auto-farming 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]
| style="background-color:#E8FFEB;" | 0.20
| [[Farming]]
|-
| [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]
| style="background-color:#E8FFEB;" | 0.20
| UI/QOL
|-
| [https://greasyfork.org/en/scripts/415592-melvor-eta Melvor ETA]
| Shows Estimated Time till 100%, lvl 99... Requires Combat Simulator for GUI Settings.
| [https://discordapp.com/users/369499615357304853 TinyCoyote#1769]
| style="background-color:#E8FFEB;" | 0.20
| UI/QOL
|-
| [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]
| style="background-color:#E8FFEB;" | 0.20
| [[Golbin Raid]]
|-
| [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]
| style="background-color:#E8FFEB;" | 0.20
| UI/QOL
|-
| [https://greasyfork.org/en/scripts/428066-melvor-mine-highest Melvor Mine Highest]
| Automatically mines the highest available rock at all times.
| [https://discordapp.com/users/611895892844216353 kieranw#5073]
| style="background-color:#E8FFEB;" | 0.20
| [[Mining]]
|-
| [https://greasyfork.org/en/scripts/423121-melvor-show-modifiers Melvor Show Modifiers]
| Adds a button to show all your currently active modifiers.
| [https://discordapp.com/users/369499615357304853 TinyCoyote#1769]
| style="background-color:#E8FFEB;" | 0.20
| 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]
| style="background-color:#E8FFEB;" | 0.20
| UI/QOL
|-
| [https://greasyfork.org/en/scripts/423027-lemvor/ Lemvor]
| lemon
| [https://discordapp.com/users/369499615357304853 TinyCoyote#1769]
| style="background-color:#E8FFEB;" | 0.20
| UI/QOL
|-
| [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]
| style="background-color:#E8FFEB;" | 0.20
| Multi
|-
| [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]
| style="background-color:#E8FFEB;" | 0.20
| Multi
|-
| [https://greasyfork.org/en/scripts/421556-melvor-anti-lag Melvor anti-lag]
| Dynamically adjusts game speed to compensate for lag
| [https://discordapp.com/users/266517729131888640 8992#7954]
| style="background-color:#E8FFEB;" | 0.20
| QOL
|-
| [https://greasyfork.org/en/scripts/419960-melvor-offline-cap-remover Melvor offline cap remover]
| Removes the 12hr offline cap
| [https://discordapp.com/users/266517729131888640 8992#7954]
| style="background-color:#E8FFEB;" | 0.20
| QOL
|-
| [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]
| style="background-color:#E8FFEB;" | 0.20
| Multi
|-
| [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]
| style="background-color:#FFE8E8;" | 0.19.2
| [[Combat]]
|-
| [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]
| style="background-color:#FFE8E8;" | 0.19.0
| 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]
| style="background-color:#FFE8E8;" | 0.19.0
| UI/QOL
|-
| [https://greasyfork.org/en/scripts/404416-melvor-auto-farming-mastery Melvor Auto Farming Mastery]
| Automatically plants your lowest mastery seeds.
| [https://discordapp.com/users/310577881803784202 JHawk55#8345]
| style="background-color:#FFE8E8;" | 0.17.0
| [[Farming]]
|-
| [https://greasyfork.org/en/scripts/404853-melvor-slayer-task-notification Melvor Slayer Task Notification]
| Gives you notification on [[Slayer#Slayer Tasks|slayer task]] completion.
| [https://discordapp.com/users/190161169321951232 Breindahl#2660]
| style="background-color:#FFE8E8;" | 0.17.0
| QOL
|-
| [https://greasyfork.org/en/scripts/394850-melvor-auto-eat Melvor Auto Eat]
| Automatically eats [[Food|food]] when [[Hitpoints|health]] is low
| [https://discordapp.com/users/615898740607156234 NotArcanus#3825]
| style="background-color:#FFE8E8;" | 0.15.2
| Auto-Eat
|-
| [https://greasyfork.org/en/scripts/394854-melvor-auto-loot Melvor Auto Loot]
| Automatically loot [[Enemies|enemy]] drops
| [https://discordapp.com/users/615898740607156234 NotArcanus#3825]
| style="background-color:#FFE8E8;" | 0.15.2
| Auto-Loot
|-
| [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]
| style="background-color:#FFE8E8;" | 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]
| style="background-color:#FFE8E8;" | 0.15.2
| Auto-Sell
|-
| [https://pastebin.com/KjJnLt7f Auto planter by priorities]
| Automatically tries to plant the highest tier seeds avaible
| Dejv#3141
| style="background-color:#FFE8E8;" | 0.15.1
| [[Farming]]
|-
| [https://pastebin.com/N36QMx2S Melvor Idle Auto Eat Just Enough]
| Tries to eat just enough to survive the next attack
| [https://discordapp.com/users/460150576567681035 Lamb#3856]
| style="background-color:#FFE8E8;" | 0.15.1
| Auto-Eat
|-
| [https://github.com/Katorone/AutoMelvorIdle AutoMelvorIdle]
| Several automatic functionalities
| [https://discordapp.com/users/459758357692153866 Katorone#2957]
| style="background-color:#FFE8E8;" | 0.12.2
| Multi
|-
| [https://discordapp.com/channels/625838709203271680/664637399028072470/669475769671483392 Auto Bonfire]
| Automatically lights [[Firemaking#Bonfire|bonfires]] for [[Firemaking]]
| [https://discordapp.com/users/190295254073606144 Dream#1511]
| style="background-color:#FFE8E8;" | 0.11.2
| [[Firemaking]]
|-
| [https://discordapp.com/channels/625838709203271680/664637399028072470/670601663467487242 Auto Cook]
| Automatically [[Cooking|cooks]] [[Fishing|fish]]
| [https://discordapp.com/users/190295254073606144 Dream#1511]
| style="background-color:#FFE8E8;" | 0.11.2
| [[Cooking]]
|-
| [https://discordapp.com/channels/625838709203271680/664637399028072470/671126592591757332 Auto Eat]
| Automatically eats if health is less than equipped food
| [https://discordapp.com/users/86969703808892928 Shakalaka#3812]
| style="background-color:#FFE8E8;" | 0.11.2
| Auto-eat
|-
| [https://discordapp.com/channels/625838709203271680/664637399028072470/668666998992928779 Auto Mine Tracker]
| Mines highest ore available
| [https://discordapp.com/users/84980169600679936 Natsulus#0001]
| style="background-color:#FFE8E8;" | 0.11.2
| [[Mining]]
|-
| [https://discordapp.com/channels/625838709203271680/664637399028072470/667770884278321222 Auto Slayer]
| Automatically switches to new [[Slayer#Slayer Tasks|slayer task]]
| [https://discordapp.com/users/131154769942151168 nysos3#7071]
| style="background-color:#FFE8E8;" | 0.11.2
| [[Combat]]
|-
| [https://discordapp.com/channels/625838709203271680/664637399028072470/667406487785570304 Balanced Bronze Mining]
| Switches between [[Tin Ore|tin]] and [[Copper Ore|copper]] to mine for [[Bronze Bar|bronze]]
| [https://discordapp.com/users/131154769942151168 nysos3#7071]
| style="background-color:#FFE8E8;" | 0.11.2
| [[Mining]]
|-
| [https://discordapp.com/channels/625838709203271680/664637399028072470/672289426310823972 Get Specific Task]
| Automatically rerolls [[Slayer#Slayer Tasks|Slayer Tasks]] from defined list
| [https://discordapp.com/users/160528347871313921 Coolrox95#9670]
| style="background-color:#FFE8E8;" | 0.11.2
| [[Combat]]
|-
| [https://discordapp.com/channels/625838709203271680/664637399028072470/668936067331653642 Mine Priority List]
| Automatically [[Mining|mines]] based on input ore priority
| [https://discordapp.com/users/328305525710258176 Brqqq#2634]
| style="background-color:#FFE8E8;" | 0.11.2
| [[Mining]]
|-
| [https://discordapp.com/channels/625838709203271680/664637399028072470/671113318135627808 Smithing HUD]
| Adds [[Smithing]] HUD and XP calculator
| [https://discordapp.com/users/170536827286061056 Bioniclegenius#3272]
| style="background-color:#FFE8E8;" | 0.11.2
| [[Smithing]]
|-
| [https://pastebin.com/wq641Nhx XPH]
| Monitors XP/HR stats experimentally
| Breakit
| style="background-color:#FFE8E8;" | 0.11.2
| UI/QOL
|}
|}


=== In-game functions ===
=== In-Game Functions ===
{{main|Reference=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"