QuingKhaos' Factorio Library

A set of commonly-used utilities by QuingKhaos for creating Factorio mods.

Usage

Download the latest release from the mod portal or GitHub releases, unzip it and put it in your mods directory. You can access libraries provided by khaoslib with require("__khaoslib__.libname").

Add the khaoslib directory to your language server's library. I recommend installing the Factorio modding toolkit and setting it up with the Sumneko Lua language server to get cross-mod autocomplete and type checking.

Stability guarantee

khaoslib follows Semantic Versioning. Thus any 0.x API should not be considered stable. I will do my best to avoid breaking changes in minor releases, but if a breaking change is necessary it will be documented in the changelog.

Legal notice

khaoslib is licensed under the LGPLv3, unlike my other mods which are all licensed under the GPLv3. Mods that use khaoslib are not required to be open source, nor are they required to be licensed under the LGPLv3. However, if you modify khaoslib itself and distribute the modified version, you must also distribute the source code of your modified version under the LGPLv3.