z_mirror/flib

git clone https://git.raiguard.me/z_mirror/flib

Caleb HeuerRemove hard line wrapsa86ee05

trunk
1.5 KiB21 linesraw

shield shield shield

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.

There is currently no online documentation due to a lack of infrastructure to generate it from EmmyLua annotations.

Contributing

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

For locale contributions, please use Crowdin.

1[![shield](https://img.shields.io/badge/Ko--fi-Donate%20-hotpink?logo=kofi&logoColor=white)](https://ko-fi.com/raiguard)
2[![shield](https://img.shields.io/badge/Crowdin-Translate-brightgreen)](https://crowdin.com/project/raiguards-factorio-mods)
3[![shield](https://img.shields.io/badge/dynamic/json?color=orange&label=Factorio&query=downloads_count&suffix=%20downloads&url=https%3A%2F%2Fmods.factorio.com%2Fapi%2Fmods%2Fflib)](https://mods.factorio.com/mod/flib)
4
5# Factorio Library
6
7The Factorio Library is a set of high-quality, commonly-used utilities for creating Factorio mods.
8
9## Usage
10
11Download the latest release from the [mod portal](https://mods.factorio.com/mod/flib) unzip it, and put it in your mods directory. You can access libraries provided by flib with `require("__flib__.position")`, etc.
12
13Add the flib directory to your language server's library. We recommend installing the [Factorio modding toolkit](https://github.com/justarandomgeek/vscode-factoriomod-debug) and setting it up with the [Sumneko Lua language server](https://github.com/sumneko/lua-language-server) to get cross-mod autocomplete and type checking.
14
15There is currently no online documentation due to a lack of infrastructure to generate it from EmmyLua annotations.
16
17## Contributing
18
19Please use the [Codeberg repository](https://codeberg.org/raiguard/flib) for questions, bug reports, or pull requests.
20
21For locale contributions, please use [Crowdin](https://crowdin.com/project/raiguards-factorio-mods).