A modding API for GDevelop games.
Note: This software is still in early stages, the API is not stable and may get breaking changes.
Disclaimer: Do not use this software on games which prohibit game code decompilation, modification etc.
GDMod is separated in multiple packages:
| Package | Description |
|---|---|
@gdmod/api |
A browser library that contains functions to interact with the game, load and run mods. |
@gdmod/cli |
A command line interface to do common tasks like installing mods or patching games. |
@gdmod/local-loader |
A script to inject @gdmod/api into a local build of a game. |
@gdmod/web-loader |
A chrome extension to inject @gdmod/api into web build build of a game. |
This project is separated into packages and maintained using lerna. To code on this repo you need yarn.
To setup the project run yarn at the root of the project, and to start the development watcher that will build the code when modified, run yarn start. If you are using VSCode, you can with one click on "Allow" run those automatically everytime you open the repo.
You can run unit tests by running yarn test at the root of the directory. You can also test your changes by running GDMod locally via either the CLI or the Chrome extension.
Before submitting a PR, make sure the code has been autoformatted with prettier. You can do so by running yarn format at the root of the repository.
Q: What is a mod?
A: A mod is like an unofficial extension, it is community written code that modifies parts of a game.
Q: Do I need to code to make mods with GDMod?
A: It depends. If you want to do any logic (e.g. what you would do with events in GDevelop), yes, you will have to write JavaScript.
For more trivial tasks (e.g. replacing resources), you can do it in most cases codeless.
You can join the GDMod discord server to get help or talk with the community.
