Mod Creation/Enabling DevTools for the Steam and Epic Clients: Difference between revisions

From Melvor Idle
m (more formatting)
m (final formatting)
Line 13: Line 13:
How to use console commands, scripts, and extensions on Steam.
How to use console commands, scripts, and extensions on Steam.


===Setup===
===1. Setup===
You only have to do this once.
You only have to do this once.
<ol>
<ol>
Line 38: Line 38:
</ol>
</ol>


===Loading Scripts===
===2.a. Loading Scripts===
Loading scripts must be run every time the game is opened on Steam.
Loading scripts must be run every time the game is opened on Steam.
<ol>
<ol>
Line 60: Line 60:
</ol>
</ol>


===Alternate Variation===
===2.b. 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 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.
 
====Additional Setup====
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:
Do all the normal steps 1-5 of the Setup section then follow the below instructions.
<ol>
<li>Create a directory Extensions in the Melvor Idle installation directory.</li>
<li>Make new directories for the extensions and scripts. e.g.</li>
<pre>
Extensions/
Extensions/
   Greasy Fork/
   Greasy Fork/
Line 80: Line 84:
     scripts/
     scripts/
     styles/
     styles/
</pre>
<li>Place the icons, styles, and source (i.e. scripts or sources) directories of the extracted extensions in the respective created directories.</li>
</ol>


The script in (9) then has to be changed accordingly:
====Alternate Variation Loading Scripts====
If you followed the alternate variation setup steps, you will have to load scripts slightly differently.
<ol>
<li>Open the game and load a character.</li>
<li>Open the dev tools console (F12).</li>
<li>Set the context of the console to game.</li>
<ul>
<li>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.</li>
</ul>
<li>Load the scripts and extensions you placed in the installation directory before.</li>
<pre>
[
[
     // own
     // own
Line 102: Line 119:
     //'Extensions/SEMI-steam/styles/semi.css',
     //'Extensions/SEMI-steam/styles/semi.css',
].forEach(cssFile => $(document.head).append(`<link rel="stylesheet" href="${chrome.runtime.getURL(cssFile)}">`));
].forEach(cssFile => $(document.head).append(`<link rel="stylesheet" href="${chrome.runtime.getURL(cssFile)}">`));
 
</pre>
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.
<li>If you are using extensions, edit the main extension script so all source files and icons can be found.</li>
Additionally. this variant approach (C) needs an additional setup step if you are using extensions:
<ul>
(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:
<li>e.g. edit the paths in contentScript.js for Combat Simulator and SEMI.js for SEMI</li>
- Combat Simulator:
<pre>
  - - icons/ -> Extensions/MICS-steam/icons/
Combat Simulator:
  - - sources/ -> Extensions/MICS-steam/sources/
  -icons/ -> Extensions/MICS-steam/icons/
- SEMI:
  -sources/ -> Extensions/MICS-steam/sources/
  - - icons/ -> Extensions/SEMI-steam/icons/
SEMI:
  - - scripts/ -> Extensions/SEMI-steam/scripts/
  -icons/ -> Extensions/SEMI-steam/icons/
  -scripts/ -> Extensions/SEMI-steam/scripts/
</pre>
</ol>


==Auto-loading Scripts in Steam==
==Auto-loading Scripts in Steam==

Revision as of 23:09, 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

  1. back up your save by exporting or downloading the save file.
  2. read all instructions before following them.
  3. verify the code is not malicious.

Steam Console and Scripts

How to use console commands, scripts, and extensions on Steam.

1. Setup

You only have to do this once.

  1. Download Melvor Idle on Steam, and find the installation directory. e.g. [...]/steamapps/common/Melvor Idle
  2. Download the 0.49.2 version of NW.js SDK. The version might change in the future, but you need the specific one listed.
  3. Download the scripts and extensions you want to use.
  4. Extract all zipped files.
  5. Place the contents of the nwjs-sdk* directory in the Melvor Idle installation directory.
  6. Place the icons, styles, and source (i.e. scripts or sources) directories of the extracted extensions in the Melvor Idle installation directory.

2.a. Loading Scripts

Loading scripts must be run every time the game is opened on Steam.

  1. Open the game and load a character.
  2. Open the dev tools console (F12).
  3. 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.
  4. Load the scripts and extensions you placed in the installation directory before.
    • You can load SEMI like this:
    • require('fs').readFile('scripts/SEMI.js', 'utf8', (err, data) => {eval(data);})
      $(document.head).append(`<link rel="stylesheet" href="${chrome.runtime.getURL('styles/semi.css')}">`)
    • You can load the Combat Simulator like this:
    • require('fs').readFile('sources/contentScript.js', 'utf8', (err, data) => {eval(data);})
      $(document.head).append(`<link rel="stylesheet" href="${chrome.runtime.getURL('styles/mainStyle.css')}">`)
    • You can load user scripts like this, by changing the file name:
    • require('fs').readFile('relativePathToMyReallyCoolScript.js', 'utf8', (err, data) => {eval(data);})

2.b. 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.

Additional Setup

Do all the normal steps 1-5 of the Setup section then follow the below instructions.

  1. Create a directory Extensions in the Melvor Idle installation directory.
  2. Make new directories for the extensions and scripts. e.g.
  3. 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/
    
  4. Place the icons, styles, and source (i.e. scripts or sources) directories of the extracted extensions in the respective created directories.

Alternate Variation Loading Scripts

If you followed the alternate variation setup steps, you will have to load scripts slightly differently.

  1. Open the game and load a character.
  2. Open the dev tools console (F12).
  3. 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.
  4. Load the scripts and extensions you placed in the installation directory before.
  5. [
        // 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)}">`));
    
  6. If you are using extensions, edit the main extension script so all source files and icons can be found.
    • e.g. edit the paths in contentScript.js for Combat Simulator and SEMI.js for SEMI
    • 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

  1. Create a .js file in the Melvor Idle directory.
  2. 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.
    setTimeout(function(){ 
         /*insert all of the commands you would normally put in the console to load your scripts*/
    }, 15000);
  3. Add the following code to the parameters of package.json
  4. "inject_js_end": "pathToYourFile/yourFileName.js"