| title | description |
|---|---|
Godot Mod Loader |
A generalized Mod Loader for GDScript-based Godot games. |
GML is a generalized mod loader for GDScript-based Godot games. The mod loader allows users to create mods for games and distribute them as zips.
Importantly, it provides methods to change existing scripts, scenes, and resources without modifying or distributing vanilla game files.
!!! danger "" We, the mod loader team, do not condone using or creating malicious mods and piracy of any kind.
=== "Godot 4"
Mod Loader: [GitHub](https://github.com/GodotModding/godot-mod-loader/tree/4.x)
Mod Dev Tool: [GitHub](https://github.com/GodotModding/godot-mod-tool/tree/4.x)
=== "Godot 3"
Mod Loader: [Asset Lib](https://godotengine.org/asset-library/asset/1938), [GitHub](https://github.com/GodotModding/godot-mod-loader)
Mod Dev Tool: [Asset Lib](https://godotengine.org/asset-library/asset/1982), [GitHub](https://github.com/GodotModding/godot-mod-tool)
All stable Mod Loader versions: GitHub Releases
All stable Mod Dev Tool versions: GitHub Releases
Depending on what your goals are, setup of the mod loader will be slightly different.
As a mod user, you usually don't have to do much at all. If you are lucky the game already has the mod loader integrated, and you just need to add your mods. If not, the self setup is only a download and placing files in the correct spot.
As a game developer wishing to integrate the Mod Loader natively, you will only have to install it and add two autoloads. You can optionally configure a few aspects through the options.
As a mod developer, it is recommended that you work on your mods with access to the vanilla source code. Some games provide it, but for most, decompiling the game will be necessary. There are several steps on the path of creating a mod to finally uploading it, but there are tools like the Mod Dev Tool and Steam Workshop Uploader to help you along the way.
It is recommended that you know a little bit about the Godot game engine. You will be creating mods using the built-in scripting language GDScript and distributing them as ZIPs.
??? tip "Learn GDScript"
Here is a starter on the language: overview
and language basics
if you are a total beginner and like interactive courses, you can use Learn GDScript from Zero by GDQuest.
It's aimed at absolute beginners, so if you already know a programming language it might be a bit slow for you.
And if you prefer videos you can watch the How to program in Godot - GDScript Tutorial by Brackey's
???+ Note Several games already have the Mod Loader integrated and some have specific help pages with game-specific information.
- Dome Keeper: [DomeKeeperMods Wiki](https://github.com/DomeKeeperMods/Docs/wiki)
- Brotato: [Steam Workshop Guide](https://steamcommunity.com/sharedfiles/filedetails/?id=2931079751)
- Windowkill: [Developer website](https://torcado.com/windowkill/mods/modding.html)
- Megaloot
- Endoparasitic
- Of Life and Land
- Decompile the Game (if the source code is not provided)
- Install Godot or GodotSteam
- The decompilation log will tell you if it's default Godot or a custom build, in which case it's likely to be GodotSteam. In some cases (like Windowkill) it's a completely custom engine version which may be provided by the developer.
- GodotSteam is mandatory if the game has Steam support like achievements or leaderboards
- Set up your Godot project for modding (if the mod loader is not integrated yet)
- Create your Mod Structure
- Create your Mod Files
- Use the API Methods
- Easily Test and debug your mod
Check if the Godot ModLoader is already integrated into the game you want to mod. If this is not the case then use the self setup
Add the Godot ModLoader to your project, feel free to join our Discord for any support!
The Godot ModLoader is based on the brilliant work done for Delta-V-Modding.
The core developers of GML are: KANA, Darkly77, Ste, and otDan.