CodeLenny / factorio-recipe-extraction

Extracts recipes from Factorio, including recipes added from mods.

Factorio Recipe Extraction

Extracts recipes and items from Factorio, including recipes added from mods.

Factorio 0.15 Status

This program was designed for Factorio v0.14. Basic changes (#1 - big thanks to @sdobz) have been implemented so the extractor doesn't crash on v0.15, but the code ignores the added difficulty factor.

If the program crashes on 0.15 or doesn't output data added to the game (scenarios, etc.), please create an issue!

Command Line Usage

Install NodeJS (v6 or later) and Lua5.1 (you MUST have 5.1, nodelua fails on later versions!). You may need to also install g++.

Install system-wide:

npm install --global factorio-recipe-extraction
factorio-extractor --output recipes.json --data ~/.factorio

Install into the local directory:

npm install factorio-recipe-extraction
$(npm bin)/factorio-extractor # ...

Programmatic Usage

A NodeJS API allows you to use the recipe extractor in your own projects.

npm install --save factorio-recipe-extraction

const path = require("path");
const Extractor = require("factorio-recipe-extraction");

let extractor = new Extractor("~/.factorio", path.join(__dirname, "data-output.json"));
extractor
  .extract()
  .then(() => {
    console.log("Finished extracting Factorio data.");
  });

Full Extractor documentation

Acknowledgements

Thanks go out to Nicholas Powell for creating Foreman, from which the basic structure for recipe extraction was based upon.