Installation Guide
To mod your GDevelop game with GDMod, two steps are required:
- Patch the game with one of GDmods loaders
- Load the mod into the game
The instructions depend on the loader you are using (web game or a local game).
For web games you need the patcher extension (web loader). It will automatically patch games for you when loading the page, and you can then click its icon to open the control panel, from which you can control the game and load mods.
For Firefox, install it from the extension gallery.
For Edge install it from the edge extension store.
For Chrome, sadly, it costs money to publish an extension, which I don't currently have. You will have to download it in developer mode. To do so, go to the releases tab, and download the latest zip of the GDMod Patcher Extension. Unzip it to a known directory. Then, go to the chrome extension manager by typing in a new tab chrome://extensions. Make sure to enable developer mode in the top left. Then click install unpacked extension, and select the directory where you extracted the extension files. The extension should appear in the list of extensions.
First, go to a page with a game. You need to click the extension to open the popup. It will check if the page has a GDevelop game:
Here, There is no game, so you cannot open the control panel
Here there is a game, so you can open the control panel.
Click on the button to open the control panel. You now have a control panel linked to the game.
Now to load a mod, simply go to the mod manager tab, select load a mod, and select a mod file.
The base patcher (local loader) is currently available in the form of a node based CLI. To use it you will therefore require node (latest LTS version recommended).
To install the cli, only this simple command is needed:
npm i -g @gdmod/cli
In most cases, you will want to patch an electron game, as it is the default export platform for PC in GDevelop. Here is how to do so:
1.1 Locate the executable of the game (the .exe file).
1.2 Find the resources folder in the same directory. Inside it, there should be an app.asar file.
1.3 Copy the path to the file.
Example:
For this game:
This would be the path:
1.4 Run the gdmod patcher, by executing this command in the cmd: gdmod-cli install asar <path/to/the/app.asar>
For the example above, I would type gdmod-cli install asar "D:\\Downloads\\game-windows (4)\\resources\\app.asar"
1.5 Start the now patched game once.
1.6 There should now be a mods folder next to your app.asar:
2.1 Download the mod zip file.
2.2 Make sure you started the patched game at least once, so that a mods directory appeared next to the app.asar file.
2.3 Drop your mod zip file into the mods folder.
2.4 Start/restart your game to to load the mod.