Mod Structure

Editor

When developing mods in Godot, create a folder named mods-unpacked and add your mods there.

Mod folder names must follow the convention of {AuthorName}-{ModName}:

res://
└───mods-unpacked
    └───Author-ModName
        ├───mod_main.gd
        └───manifest.json

See Mod Files for info on what those files do.

If you have any dependencies, unzip them and add them to res://mods-unpacked.

Note that a bug in the Godot editor prevents using zipped and unpacked mods at the same time (see ZIPs in the Editor below).

ZIPs

Mod ZIPs should have the structure shown below. The structure matches the structure of the filesystem when developing mods in the Godot editor.

Mod users will add their ZIPs to a folder named mods in the root.

The name of the ZIP is arbitrary. This gives you freedom to, for example, append it with a version string, eg. AuthorName-ModName-v1.1.2.zip.

yourmod.zip
├───.import
└───mods-unpacked
    └───Author-ModName
        ├───mod_main.gd
        └───manifest.json

ZIPs in the Editor

Godot has a bug that, in short, means you can't use both unpacked mods (in res://mods-unpacked) and zipped mods (in res://mods). If you need to use a mod as a dependency, please unzip it and add it to your project.

You can still use mod ZIPs in the editor, eg. if you want to test your zipped mod. They will load as expected, but nothing from res://mods-unpacked will be loaded either.

.import (Custom Assets)

Distribution

If your mod includes custom assets, such as PNGs and CSVs, these files should be included in your mod ZIP.

Like in the editor, these go in a top-level directory called .import.

Your mod ZIP's .import folder should only include your custom assets. It should not include any vanilla assets.

Tips

For ease of use, it's highly recommended that you prefix all custom assets with your modname_*, eg modname_weapon1.png. This makes it much easier to find your custom assets in .import.

Custom assets can also be identified by sorting by date.

To clean up unused files, it's helpful to delete everything in .import that's not vanilla, then run the game again, which will re-create only the files that are actually used.

Notes

If you want to rename existing assets to include a modname_* prefix, you'll need to do two things:

1. Rename the files themselves.
   • Windows has a "PowerToy" (download/repo called Power Rename that will let you do this quickly, and it supports regex.
2. Update the resource paths.
   • You can use VS Code to do this, as its search and replace also supports regex.

For (2), here's some example regex to replace PNG filenames in .tres files. It supports these characters in file and folder names: A-z, 0-9, and _. See what it's doing on regex101.com.

Search:

\[ext_resource path="res:\/\/mods-unpacked\/AuthorName-ModName\/([A-z0-9_!-\/]+)\/([A-z0-9_!-]+).png

Replace:

[ext_resource path="res://mods-unpacked/AuthorName-ModName/$1/modname_$2.png

Next: Mod Files