Configuration

Configuration

There are several configurable files which are all loaded from the {game}/x64/scripts/config/TheInsurgentsForgeConfig/... directory when opening the game. All of these configuration files can be modified via any text editor.

There are 6 modules that provide the ground framework for this mod. This includes:

• Formulas

• Functions

• Classes

• Helpers

• Assemblies

• Middlewares

All of these files are maintained in the scripts/TheInsurgentsForge/... directory by me and me only.

However, every single file can be overwritten and expanded on by you via the configuration folder. So if you want to modify a function, you copy it from scripts/TheInsurgentsForge/functions to config/TheInsurgentsForgeConfig/functions and then tweak it to your desire.

All files in the functions, classes, helpers, and assemblies base directories are completely replaced by those in the configuration directories.

The classes.lua, helpers.lua, and assemblies.lua files from the base directory are expanded on with those in the configuration directory. All filenames listed in the base files have a higher priority than those listed in the configuration files.

The formulas.lua and middlewares.lua files from the base directory are merged with those in the configuration directory. If you want, you can overwrite anything from the base file by naming things exactly the same in the configuration file.

The point of this approach is that whenever there is an issue with functions, classes or anything else, I can publish a bugfix without worrying about whether you actually modified it in your mod or not. So a player always gets the latest features and bug fixes from this mod, as long as you don't overwrite them in your mod. However, once you do, you will be responsible for any of the issues caused by it.

It is entirely possible than an update to this mod will break things in yours that makes use of it as some things may be renamed or expanded on. However, I will try to keep this to a minimum as much as I can. So as long as you keep up to date with this mod every once in a while, there is nothing to worry about.

The purpose of every one of the base files in described in the following pages.