factorio-exporter
| Crates.io | factorio-exporter |
| lib.rs | factorio-exporter |
| version | 0.9.0 |
| source | src |
| created_at | 2022-11-01 18:58:24.548005 |
| updated_at | 2022-11-26 06:57:47.035737 |
| description | A library to export prototype definitions from Factorio (http://www.factorio.com) |
| homepage | http://github.com/MForster/factorio-rust-tools |
| repository | http://github.com/MForster/factorio-rust-tools |
| max_upload_size | |
| id | 702997 |
| size | 3,299,093 |
Mike Forster (MForster)
documentation
README
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.