When creating a REDmod, there is a certain file structure that you need to follow to ensure that it can be used by others. You will want to have a folder that is the name of the mod and in this folder you will have a file named
info.json.Whether you are doing Animation Modding, Script Modding, TweakDB Modding, Audio Modding, or other mods (archive mods), you will also need to have at least one subfolder for the mod files to go into. This subfolder should be located on the same level as the
info.jsonfile, and be nested directly inside the folder with the mod name.
An example REDmod might look something like this:
* | -📁 mods
* | |-📁 <Mod Name>
* | | |-📁 archives
* | | |-📁 scripts
* | | |-📁 tweaks
* | | |-📁 customSounds
* | | |-📄 info.json
When sharing you mod, you would package the folder that is the name of the mod. You could also package the mods folder with the "mod folder", but it is not necessary and it is assumed one might have other mods in their
For a REDmod to be recognized and loaded by the game engine, you must include an
info.jsonfile. This file sits in the root folder of the mod's folder at the same level as the subfolders containing your modded files. There are two required entries and a few optional entries that can be in this json file. At minimum a
namefield and a
versionfield are needed:
"description": "Description for the mod.",
"customSounds": [ ]
In the above:
namefield is the mod's name and should generally be the same as the folder the
info.jsonfile sits in.
versionfield is the mod's version. The version should generally use "Semantic Versioning"
descriptionfield is optional for all mods, but it is generally suggested one should include it so other tools have something to display for a given mod.
INFO - Semantic Versioning is a method of versioning where each number gives meaning for a release based on their position. It uses the format
MAJORrelease change is one which will break workflows,
MINORcould break a workflow but is generally safe and might introduce deprecations, and a
PATCHis a small non breaking change that all users on the same
MINORcan update to without any issues.