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

From Melvor Idle
(Remove step pertaining to legacy mod installation method)
No edit summary
 
(9 intermediate revisions by 3 users not shown)
Line 1: Line 1:
For mod developers, it may be beneficial to enable DevTools within the Steam client. This can be achieved by following the process detailed below. This is a one off operation and does not need to be repeated, that is unless the Steam client is uninstalled or reinstalled.
For mod developers, it may be beneficial to enable DevTools within the Steam or Epic client. This can be achieved by following the process detailed below. This is a one off operation and does not need to be repeated, that is unless the Steam or Epic client is uninstalled or reinstalled, or when the game client updates.
=== Enabling DevTools for Steam & Epic ===
<ol>
<li>Ensure Melvor Idle is closed - modifying game files while the game is running may result in unexpected behaviour</li>
<li>Download Melvor Idle on Steam or Epic, and find the installation folder. e.g. <code>[...]/steamapps/common/Melvor Idle</code>
<br/>Not sure where it's installed? It is possible to locate the installation folder through the Steam & Epic clients:</li>
<ul>
<li>'''Steam:''' Locate Melvor Idle within your library, right click, then click <code>Properties</code> - a window should appear. Within this window, click <code>Installed Files</code> → <code>Browse..</code></li>
<li>'''Epic:''' Locate Melvor Idle within your library, right click, then click <code>Manage</code> - a window should appear. Within this window, click on the folder icon within the Installation section
</ul>
<li>Open the <code>package.nw</code> folder then <code>package.json</code>. Inside <code>package.json</code>, find <code>"chromium-args":</code> and then remove <code>--disable-devtools</code> and save the changes.</li>
<li>Verify DevTools have been successfully enabled by opening Melvor Idle, then pressing the F12 key once loaded. If successful, the DevTools window should appear</li>
</ol>


# Download Melvor Idle on Steam, and find the installation folder. e.g. <code>[...]/steamapps/common/Melvor Idle</code>
'''IMPORTANT''': When running commands through the console, you must switch from 'Top' to 'game' in the top left corner or else any commands will not function properly. This must be done every time the console is opened.
#* Not sure where it's installed? Go to Melvor Idle in your Steam library, right click, and go to <code>Manage</code> → <code>Browse local files</code>.
 
# Download the NW.js SDK (Windows: v0.54.0; other OS: v0.49.2). The version might change in the future, but you need the specific one listed.
[[File:DevToolsSteamEpic.png|frameless]]
#* '''64bit Windows''': https://dl.nwjs.io/v0.54.0/nwjs-sdk-v0.54.0-win-x64.zip
#* '''64bit Linux''': https://dl.nwjs.io/v0.49.2/nwjs-sdk-v0.49.2-linux-x64.tar.gz
#* '''Other''': https://dl.nwjs.io/
# Extract all zipped files.
# Place the '''contents''' of the <code>nwjs-sdk*</code> folder in the Melvor Idle installation folder.
#* The current contents of the <code>nwjs-sdk-v0.54.0-win-x64</code> folder has 22 total items. Moving this to the Melvor Idle folder will overwrite over 100 existing files.
#* If it didn't ask you to overwrite any files then you did something wrong.
# Place the <code>icons</code>, <code>styles</code>, and source directories (i.e. <code>scripts</code> or <code>sources</code>) of the extracted extensions in the Melvor Idle installation folder.


{{ModGuideNav}}
{{ModGuideNav}}
{{Menu}}
{{Menu}}

Latest revision as of 17:15, 24 April 2024

For mod developers, it may be beneficial to enable DevTools within the Steam or Epic client. This can be achieved by following the process detailed below. This is a one off operation and does not need to be repeated, that is unless the Steam or Epic client is uninstalled or reinstalled, or when the game client updates.

Enabling DevTools for Steam & Epic

  1. Ensure Melvor Idle is closed - modifying game files while the game is running may result in unexpected behaviour
  2. Download Melvor Idle on Steam or Epic, and find the installation folder. e.g. [...]/steamapps/common/Melvor Idle
    Not sure where it's installed? It is possible to locate the installation folder through the Steam & Epic clients:
    • Steam: Locate Melvor Idle within your library, right click, then click Properties - a window should appear. Within this window, click Installed FilesBrowse..
    • Epic: Locate Melvor Idle within your library, right click, then click Manage - a window should appear. Within this window, click on the folder icon within the Installation section
  3. Open the package.nw folder then package.json. Inside package.json, find "chromium-args": and then remove --disable-devtools and save the changes.
  4. Verify DevTools have been successfully enabled by opening Melvor Idle, then pressing the F12 key once loaded. If successful, the DevTools window should appear

IMPORTANT: When running commands through the console, you must switch from 'Top' to 'game' in the top left corner or else any commands will not function properly. This must be done every time the console is opened.

DevToolsSteamEpic.png