Skip to content

Afforess/Factorio-Stdlib

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

c89484a · Apr 15, 2021
Mar 3, 2020
Oct 18, 2020
Jul 19, 2020
Mar 14, 2020
Oct 11, 2020
Dec 4, 2020
Sep 22, 2020
Apr 15, 2021
Dec 5, 2020
Jun 22, 2019
Mar 15, 2020
Oct 20, 2020
Apr 16, 2018
Apr 5, 2016
Nov 25, 2020
Nov 25, 2020
Dec 4, 2020
Jun 5, 2019
May 20, 2019

Repository files navigation

Factorio-Stdlib

Factorio Standard Library Project

About

The Factorio Standard Library is a project to bring Factorio modders high-quality, commonly-required utilities and tools that developers have been often copying around, remixing, and rewriting poor quality copies of. Factorio mods often re-implement basic tools like logging, math calculations, and position or area manipulation. These common operations can be a subtle source of errors and their regular occurance has encouraged the creation of the Factorio Stdlib, as a toolbox and set of utilities for modders. Factorio Standard Library APIs are all unit-tested, documented, and high quality, and written to be simple and straightforward for the earliest beginners and seasoned developers alike.

Usage

  1. Install the Factorio Standard Library mod from the mod portal latest release
  2. In your info.json add stdlib as a dependency.
  3. In your control.lua or other lua modules, you can import the stdlib modules you need.

Documentation

See the wiki for an introduction and usage/examples.

See the github pages for the latest generated documentation of the Factorio-stdlib

Unit Tests

The codebase is tested with busted. Test specifications are located under spec/

Contributing

Contributions are welcome! Please follow general lua coding standards and include ldoc-compatible comments.

Circle CI