Godot-RTS-Template/mods/README.md

25 lines
929 B
Markdown

# Modding
By default a modding system is made.
Each mods need to be in the mod folder, each folder is a mod containing at least a `mod_id.modinfo` and a `mod_id.pck` and optionnaly a `mod_id.<locale>.loc`
## modinfo example
```json
{
"id": "mod_id",
"name": "Mod Displayed Name",
"version": "1.0",
"desc": "Mod displayed description",
"author": "Mod Author",
"dependencies": [],
"tags": ["units", "vehicles", "buildings", "textures", "maps", "quests"],
"packs": ["mod_id", "addon_pack"]
}
```
*id* (string) : should be the unique name of the mod. Only used internally. should be the same as the modinfo and the folder name
*name* (string) : the displayed name of the mode
*version* (string) : to keep track of the version of you mod. displayed in the mod manager
*author* (string) : you, the awesome modder
*dependecies* (array of strings) : list of ids of requiered mod. be sure to load them before this one