Creating a Mod

To create a mod, create a file named mod.txt in a new folder. This file is in Godot's ConfigFile format. It is required for a mod to load. It contains the mod's human-readable name, internal mod identifier and the current mod version.

This is the minimal mod.txt template:

[mod]
name="Human-readable mod name"
id="internal-mod-id"
version="0.0.1"

version is recommended to be in the Semantic Versioning format.
This config file may be extended with additional sections and fields.

To load this mod, zip the contents of the folder containing the mod.txt file (NOT the folder itself) and put it in the mods folder in your game's installation.
This minimal mod will not do anything.
To make sure the mod has loaded properly, press any key during the launch of the game to open the mod loader config screen and press the "Open user://" button, launch the game using the "Launch" button, wait for the game to load into the main menu and open the log file in logs/godot.log inside the opened user:// directory using a text editor. You should see a line with the following text:

Loading mod "Human-readable mod name" (internal-mod-id 0.0.01)

To add functionality to your mod, see these pages:

• Replacing assets and resources
• Autoload scripts