YPetremann / flib

A set of high-quality, commonly-used utilities for creating Factorio mods.

Factorio Library

The Factorio Library is a set of high-quality, commonly-used utilities for creating Factorio mods.

Usage

Download the latest release from the mod portal unzip it, and put it in your mods directory. You can access libraries provided by flib with require("__flib__/position"), etc.

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

You can view the online documentation here. This documentation is auto-generated by the Lua language server, and is heavily unpolished. It is recommended to use language server intellisense instead of the docs site wherever possible.

Contributing

Please use the GitHub repository for questions, bug reports, or pull requests.

For locale contributions, please use Crowdin.