Scripting and Extensions: Difference between revisions

From Melvor Idle
m (Update Discord server link)
(Move the majority of installation instructions to Scripting and Extensions Instructions)
Line 1: Line 1:
<!--No version number since version is per tool/script-->
<!--No version number since version is per tool/script-->
{{Otheruses|listing scripts and extensions|instructions on installing scripts and extensions|Scripting and Extensions Instructions}}
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].


Line 270: Line 271:


== How to Use? ==
== 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]].
Depending on the type of script or extension, different methods may be needed to add them to the game. For Steam and web browser (PC), 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]]

Revision as of 22:35, 7 December 2021

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, different methods may be needed to add them to the game. For Steam and web browser (PC), see Scripting and Extensions Instructions.