mirror/factorio-docker
1
0
Fork 0
mirror of https://github.com/factoriotools/factorio-docker.git synced 2024-11-07 03:07:24 +01:00
Code Issues Packages Projects Releases Wiki Activity

update docs

Browse Source
This commit is contained in:
David Andersen 2016-10-25 11:59:50 -07:00
parent 1e7c8bc8b7
commit 9dca3590ae
1 changed files with 27 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
README.md
View File

@ -28,9 +28,21 @@ NOTE: This is only the server. The game is available on [Steam](http://store.ste
## Quick Start ## Quick Start
Create ```server-config.json``` and modify it to your liking. Start the server in interactive mode for debugging. The game isn't saved.
Now start the server: ```
docker run --rm -it -P dtandersen/factorio
```
* ```--rm``` - Remove container after stopping
* ```-it``` - Interactive mode, i.e. you can see the console
* ```-P``` - Expose all ports.
## Usage
Normally the server runs as a daemon and a configuration file is specified. Volumes are mounted for saves and mods.
Create ```server-config.json``` and modify it to your liking.
``` ```
docker run -d -P \ docker run -d -P \
@ -41,33 +53,32 @@ docker run -d -P \
dtandersen/factorio dtandersen/factorio
``` ```
If you're wondering what all these options are:
* ```-d``` - Start the server as a daemon. * ```-d``` - Start the server as a daemon.
* ```-P``` - Expose all ports. * ```-P``` - Expose all ports.
* ```-v``` - Mount volumes for config, mods, and saves. * ```-v``` - Mount volumes for config, mods, and saves.
* ```--name``` - Give the container a name (otherwise it'll be random). * ```--name``` - Give the container a name (otherwise it'll be random).
* ```dtandersen/factorio``` - The Docker image name.
The server should start and create ```/path/to/saves/save.zip```. The save remains if the server stops, since the save folder is mounted as a volume. ## Saves
## Stopping the Server The first time the server is started a new map is generated and saved as ```save.zip```. On subsequent runs the newest save is used. To load an old save ```touch save.zip``` and restart the server.
Assuming the server is named ```factorio```, run: ## Mods
Copy them into the mods folder and restart the server.
## Start/Stopping
Assuming the server is named ```factorio```, to stop the server:
``` ```
docker stop factorio docker stop factorio
``` ```
## Saves To restart the server:
If there are no saves when the server starts, then a new map is generated and saved as ```save.zip```. ```
docker start factorio
Otherwise, the most recent ZIP file in the saves folder is used. To load an old save ```touch save.zip``` and restart the server. ```
## Mods
Copy them into the mods folder.
## Volumes ## Volumes