#gaming #factorio #definition #prototype #export #exporter #com

factorio-exporter

A library to export prototype definitions from Factorio (http://www.factorio.com)

11 releases (7 breaking)

0.9.0 Nov 26, 2022
0.8.0 Nov 9, 2022
0.6.0 Nov 5, 2022
0.5.1 Nov 5, 2022
0.1.2 Nov 1, 2022

#10 in #factorio


Used in factorio-cli

MIT/Apache

130KB
888 lines

Factorio Exporter

A Rust library to export prototype definitions from Factorio.

See crate page on crates.io

Library

See the module documentation and the factorio-cli implementation for how to use the library.

Status

This is still very much in the prototype phase. The output will be incomplete and have bugs. Please try it out anyway and report any issues that you run into!

See the change log for progress.

Design

The goal of the importer is to be as close as possible to the authoritative definition of the prototypes. It tries to achieve that goal by two design decisions:

  • The prototypes are exported from a running Factorio instance in the runtime stage. This means that the prototypes are as close as possible to how they are used in the game.

  • The list of exported properties is taken from the official definition.

Another consequence of this design is that it allows to export the prototypes of loaded mods.

Platform support

This library is intended to be platform-independent, but it's currently only tested on Linux.

Contributing

Contributions are welcome! Feel free to send pull requests, but if you want to make large-scale changes it would make sense to discuss them first.

Dependencies

~8–18MB
~271K SLoC