Config Versioning - Aizistral-Studios/Enigmatic-Legacy GitHub Wiki

Since update 1.3.0, Enigmatic Legacy uses config versioning to simplify updating any values defined by config file.

As a lot of items and features in the mod are affected by config, this is absolutely required to ensure that players receive all balance tweaks and other related changes upon updating to new version of the mod, without having to manually manipulate the config file.

If you are about to make massive tweaks via the config file, however, it is recommended to read this article in order to avoid loosing your precisely adjusted changes.

Config Version

Version of the config file is determined by separate parameter within enigmatic-legacy-common.toml file itself, that looks as following:

# Version of config file. DO NOT MODIFY UNLESS YOU KNOW EXACTLY WHAT YOU'RE DOING!
configVersion = "1.0"

It is located in the Generic Config category:

#Just some different stuff
["Generic Config"]

Updating Outdated Config

When you install version of Enigmatic Legacy that has newer version of the config, ALL the values in the config file will be resetted to their default values automatically when launching a client/server. Config version will then be changed to newer one.

This also happens upon fallback to versions of Enigmatic Legacy with previous config version. It is however will not happen upon downgrading to the versions of Enigmatic Legacy that didn't have config versioning implemented yet, but will always happen upon updating from such versions.

Config Management

Depending on the amount and importance of changes you are making to the config file, you may want to take some actions upon updating to newer config version.

If you're not making any changes at all, it's all simple - just don't care about it and let the mod do it's work.

If there is small or medium amount of changes you would like to keep, the best tactic would be to backup your old config file, let the mod update it, and then edit in all values you will want into updated file.

If there is large amount of changes or even most of the values in the file are changed, you may prefer to manually change the config version in order to avoid the values from being resetted at all. If you still want to see the updated values, though, you can backup your file, let the mod generate new one with new defaults, then take a look at it and write any values you'll want into your backup file, then change it's version to newer and put it back where it belongs.

Down here you will find compliances for config versions used by each Enigmatic Legacy version, in case you will require it.

Version Mappings

Enigmatic Legacy Version: 1.0.0 Release, Config File Version: Non-Existent
Enigmatic Legacy Version: 1.0.1 Release, Config File Version: Non-Existent
Enigmatic Legacy Version: 1.1.0 Release, Config File Version: Non-Existent
Enigmatic Legacy Version: 1.2.0 Release, Config File Version: Non-Existent
Enigmatic Legacy Version: 1.2.1 Release, Config File Version: Non-Existent
Enigmatic Legacy Version: 1.2.2 Release, Config File Version: Non-Existent
Enigmatic Legacy Version: 1.3.0 Release, Config File Version: 1.0
Enigmatic Legacy Version: 1.3.1 Release, Config File Version: 1.0
Enigmatic Legacy Version: 1.3.2 Release, Config File Version: 1.0
Enigmatic Legacy Version: 1.3.3 Release, Config File Version: 1.0
Enigmatic Legacy Version: 1.3.4 Release, Config File Version: 1.0
Enigmatic Legacy Version: 1.4.0 Release, Config File Version: 1.0
Enigmatic Legacy Version: 1.4.1 Release, Config File Version: ???
Enigmatic Legacy Version: 1.4.2 Release, Config File Version: 1.0
Enigmatic Legacy Version: 1.5.0 Release, Config File Version: ???
Enigmatic Legacy Version: 1.5.1 Release, Config File Version: 1.0
Enigmatic Legacy Version: 1.5.2 Release, Config File Version: 1.0
Enigmatic Legacy Version: 1.5.3 Release, Config File Version: 1.0
Enigmatic Legacy Version: 1.6.0 Release, Config File Version: 1.1