-
-
Notifications
You must be signed in to change notification settings - Fork 2
mod.txt Standards
mod.txt
is used to store information about the mod like it's name, ID and version.
Because it's a ConfigFile, it can also store any arbitrary piece of information.
For this information to be useful, it needs to be stored in a standardized way.
Mods can read other mods' configs using the ModLoader class located in /root/ModLoader
.
Below is a non-exhaustive list of standards.
The bare minimum needed for a mod to function
[mod]
name="Human-readable mod name"
id="internal-mod-id" ; Recommended to only use a-z, - and _
version="0.0.1" ; Recommended to be in the SemVer format
A list of scripts or scenes extending Node
to be loaded when this mod gets loaded.
The node gets added to /root/
with the name being it's key.
[autoload]
MyModMain="res://MyMod/Main.gd"
Used for automatic mod updating. Currently only supports mods hosted on ModWorkshop.
For more info, see Publishing your mod and updates.
Including a ModWorkshop ID also adds the link to the mod page in on the config screen.
[updates]
modworkshop=49779 ; The value is this mod's ModWorkshop ID. It is included in the URL of the mod page, e.g. 49779 for modworkshop.net/mod/49779