Mod Creation/Enabling DevTools for the Steam and Epic Clients: Difference between revisions
m (→Setup: formatting) |
m (more formatting) |
||
Line 36: | Line 36: | ||
<li>Place the contents of the nwjs-sdk* directory in the Melvor Idle installation directory.</li> | <li>Place the contents of the nwjs-sdk* directory in the Melvor Idle installation directory.</li> | ||
<li>Place the icons, styles, and source (i.e. scripts or sources) directories of the extracted extensions in the Melvor Idle installation directory.</li> | <li>Place the icons, styles, and source (i.e. scripts or sources) directories of the extracted extensions in the Melvor Idle installation directory.</li> | ||
</ol> | |||
===Loading Scripts=== | ===Loading Scripts=== | ||
Line 113: | Line 114: | ||
==Auto-loading Scripts in Steam== | ==Auto-loading Scripts in Steam== | ||
<ol> | |||
<li>Create a .js file in the Melvor Idle directory.</li> | |||
<li>Set the contents of the .js file</li> | |||
<ul> | |||
<li>The 15000 is just to give the game 15 seconds to get up and running, it doesn't seem to matter if it fires on the character screen or once you load a character.</li> | |||
</ul> | |||
<pre>setTimeout(function(){ | |||
/*insert all of the commands you would normally put in the console to load your scripts*/ | |||
}, 15000);</pre> | |||
<li>Add the following code to the parameters of package.json</li> | |||
<pre>"inject_js_end": "pathToYourFile/yourFileName.js"</pre> | |||
</ol> | |||
{{Menu}} | {{Menu}} | ||
[[Category:Guides]] | [[Category:Guides]] |
Revision as of 22:55, 14 June 2021
This page was last updated for (v0.20). |
Disclaimer: 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 script and extension.
Before You Begin
It's highly recommended before doing anything to
- back up your save by exporting or downloading the save file.
- read all instructions before following them.
- verify the code is not malicious.
Steam Console and Scripts
How to use console commands, scripts, and extensions on Steam.
Setup
You only have to do this once.
- Download Melvor Idle on Steam, and find the installation directory. e.g. [...]/steamapps/common/Melvor Idle
- Download the 0.49.2 version of NW.js SDK. The version might change in the future, but you need the specific one listed.
- 64bit Windows: https://dl.nwjs.io/v0.49.2/nwjs-sdk-v0.49.2-win-x64.zip
- 64bit Linux: https://dl.nwjs.io/v0.49.2/nwjs-sdk-v0.49.2-linux-x64.tar.gz
- Others: https://dl.nwjs.io/
- Download the scripts and extensions you want to use.
- Download from the script manager website. e.g. GreasyFork
- Download from the extension's browser store page.
- Download the source from the extension's repository. e.g.
- Extract all zipped files.
- Place the contents of the nwjs-sdk* directory in the Melvor Idle installation directory.
- Place the icons, styles, and source (i.e. scripts or sources) directories of the extracted extensions in the Melvor Idle installation directory.
Loading Scripts
Loading scripts must be run every time the game is opened on Steam.
- Open the game and load a character.
- Open the dev tools console (F12).
- Set the context of the console to game.
- The top left of the console has a dropdown: change it from top to game (steam.melvoridle.com). After doing this, you can use the console.
- Load the scripts and extensions you placed in the installation directory before.
- You can load SEMI like this:
- You can load the Combat Simulator like this:
- You can load user scripts like this, by changing the file name:
require('fs').readFile('scripts/SEMI.js', 'utf8', (err, data) => {eval(data);}) $(document.head).append(`<link rel="stylesheet" href="${chrome.runtime.getURL('styles/semi.css')}">`)
require('fs').readFile('sources/contentScript.js', 'utf8', (err, data) => {eval(data);}) $(document.head).append(`<link rel="stylesheet" href="${chrome.runtime.getURL('styles/mainStyle.css')}">`)
require('fs').readFile('relativePathToMyReallyCoolScript.js', 'utf8', (err, data) => {eval(data);})
Alternate Variation
The following variant results in a cleaner directory without potential file name clashes. Note that the above does not clash for Combat Simulator + SEMI at the moment.
The (cleaner) way I do it mainly differs in the target location of steps (4) and (5) : I made a directory Extensions in the Melvor Idle installation directory, in which I made new directories for the extensions and scripts: Extensions/
Greasy Fork/ Melvor Completion Log Helper.js Melvor Idle - Timestamped Saves.js Melvor-ETA/ time-remaining.js MICS-steam/ icons/ sources/ styles/ scripts/ nameOfMyReallyCoolScript.js SEMI-steam/ icons/ scripts/ styles/
The script in (9) then has to be changed accordingly: [
// own 'Extensions/scripts/nameOfMyReallyCoolScript.js', 'Extensions/Melvor-ETA/time-remaining.js',
// extensions // other than the main script, extensions typically also require the insertion of a css file 'Extensions/MICS-steam/sources/contentScript.js', //'Extensions/SEMI-steam/scripts/SEMI.js',
// Greasy Fork user scripts 'Extensions/Greasy Fork/Melvor Completion Log Helper.js', 'Extensions/Greasy Fork/Melvor Idle - Timestamped Saves.js',
].forEach(pts => require('fs').readFile(pts, 'utf8', (err, data) => {eval(data);}));
// Extension css [
'Extensions/MICS-steam/styles/mainStyle.css', //'Extensions/SEMI-steam/styles/semi.css',
].forEach(cssFile => $(document.head).append(`<link rel="stylesheet" href="${chrome.runtime.getURL(cssFile)}">`));
Note that SEMI is commented here since I don't use that, you can easily swap scripts in and out by commenting them. Personally I keep a copy of this script saved as yet another script, and each time I load the game I just copy paste it in the console. Additionally. this variant approach (C) needs an additional setup step if you are using extensions: (5.1) Edit the main extension script, i.e. contentScript.js for Combat Simulator and SEMI.js for SEMI, so all source files and icons can be found. In particular you will find references to the icons and source directories in these files, replace these with the appropriate paths:
- Combat Simulator: - - icons/ -> Extensions/MICS-steam/icons/ - - sources/ -> Extensions/MICS-steam/sources/ - SEMI: - - icons/ -> Extensions/SEMI-steam/icons/ - - scripts/ -> Extensions/SEMI-steam/scripts/
Auto-loading Scripts in Steam
- Create a .js file in the Melvor Idle directory.
- Set the contents of the .js file
- The 15000 is just to give the game 15 seconds to get up and running, it doesn't seem to matter if it fires on the character screen or once you load a character.
- Add the following code to the parameters of package.json
setTimeout(function(){ /*insert all of the commands you would normally put in the console to load your scripts*/ }, 15000);
"inject_js_end": "pathToYourFile/yourFileName.js"
Melvor Idle version v1.3 (Released: 13th June 2024) | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||
Skills:
| ||||||||||||||||||||
Other:
| ||||||||||||||||||||
Reference Tables: Items, Equipment, Experience Table, Upgrading Items, Combat Areas, Slayer Areas, Dungeons, Strongholds, The Abyss, Monsters |