Skip to content

Installation

The command-line tool is published as factorio-rs-cli. Installing it provides the factorio-rs binary:

Terminal window
cargo install factorio-rs-cli
factorio-rs --help

In your mod’s Cargo.toml:

[dependencies]
factorio-rs = "0.1.2"

Optional features:

# Type-check `tracing::info!` etc.; CLI lowers them to colored game.print
factorio-rs = { version = "0.1.2", features = ["tracing"] }

See Tracing for details.

factorio-rs init scaffolds a project with this pin and edition = "2024".

You only need a Factorio install for:

  • factorio-rs install - copies dist/ into the mods directory
  • factorio-rs open / install --open - launches the game
Purpose Resolution
Mods directory FACTORIO_MODS_DIR, else ~/.factorio/mods
Game binary FACTORIO_PATH, common Steam paths, factorio on PATH, or Steam protocol

On Linux, binary launches prefer steam-run when it is available so Steam runtime libraries are present.