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

Mod Creation/Enabling DevTools for the Steam and Epic Clients (view source)

Revision as of 23:09, 14 June 2021

296 bytes added , 14 June 2021

m

final formatting

Foxy

454

edits

@@ Line 13: / Line 13: @@
 How to use console commands, scripts, and extensions on Steam.
-===Setup===
+===1. Setup===
 You only have to do this once.
 <ol>
@@ Line 38: / Line 38: @@
 </ol>
-===Loading Scripts===
+===2.a. Loading Scripts===
 Loading scripts must be run every time the game is opened on Steam.
 <ol>
@@ Line 60: / Line 60: @@
 </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.
+====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/
    Greasy Fork/
@@ Line 80: / Line 84: @@
      scripts/
      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
@@ Line 102: / Line 119: @@
      //'Extensions/SEMI-steam/styles/semi.css',
 ].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==