https://github.com/dentosal/facts
A Factorio server manager
https://github.com/dentosal/facts
Last synced: over 1 year ago
JSON representation
A Factorio server manager
- Host: GitHub
- URL: https://github.com/dentosal/facts
- Owner: Dentosal
- License: mit
- Created: 2017-05-16T23:22:43.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2020-03-31T21:55:17.000Z (over 6 years ago)
- Last Synced: 2025-01-26T06:25:40.386Z (over 1 year ago)
- Language: Rust
- Size: 60.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# `facts` - [Factorio server](https://www.factorio.com/download-headless) management CLI
Easily create and manage multiple servers. Automatically update to latest factorio.
## Installation
Requires [latest Rust nightly](https://rustup.rs/). Then simply run `cargo install --path .` on the repository root.
## Usage
### Quickstart
Create and run a world with default settings with
`facts create ExampleWorld && facts start ExampleWorld`
### Usage examples
#### Create new server
`facts create ExampleWorld`
* `--factorio experimental` to use the experimental versíon
* `--factorio 0.16` to force latest `0.16`
* `--map-gen-settings map-gen-settings.json` to specify map generation settings
* `--map-settings map-settings.json` to specify map settings
* `--server-settings map-settings.json` to specify server settings
* `--server-adminlist server-adminlist.json` to specify server admin list
* `--add-admin AdminUserName` to add server admins
* `--mod-list mod-list.json` to specify mods from an exising mod list
* `--autoupdate SETTING`
* `enabled` automatically apply updates when no players are online (default)
* `forced` immediately restart when updates are available, kicking out players
* `startup` auto-update on server startup
* `disabled` never auto-update
#### Import existing world to facts
`facts import ExampleWorld world.zip`
Supports all arguments from `facts create`, except map(-gen)-settings which cannot be changed after creation.
#### Edit server settings
`facts edit ExampleWorld`
Supports all arguments from `facts create`, except map(-gen)-settings which cannot be changed after creation.
#### Switch server to use the experimental build
`facts edit ExampleWorld --factorio experimental`
#### Start server
`facts start ExampleWorld`
#### Export (back up) a world.zip from facts
`facts export ExampleWorld world.zip`
#### Mods
`facts list-mods ExampleWorld`
`facts add-mod ExampleWorld Krastorio2`
`facts remove-mod ExampleWorld Krastorio2`
`facts update-mods ExampleWorld`
Use mod name from address bar or mod zip file name.
#### Remove unused server versions
`facts prune`
#### Update facts itself (not implemented yet)
`facts self update`