mirror of
https://github.com/factoriotools/factorio-docker.git
synced 2024-12-27 03:18:24 +01:00
revise docs
This commit is contained in:
parent
ee509835db
commit
ba68274a7b
52
README.md
52
README.md
@ -30,33 +30,37 @@ NOTE: This is only the server. The game is available on [Steam](http://store.ste
|
|||||||
|
|
||||||
## Quick Start
|
## Quick Start
|
||||||
|
|
||||||
Start the server in interactive mode.
|
Begin by running the server to create the necessary folder structure and configuration files under ```/tmp/factorio```.
|
||||||
|
|
||||||
```
|
|
||||||
docker run --rm -it -P -v /tmp/factorio:/factorio dtandersen/factorio
|
|
||||||
```
|
|
||||||
|
|
||||||
Here is an explanation of the options:
|
|
||||||
|
|
||||||
* ```--rm``` - Remove container after stopping
|
|
||||||
* ```-it``` - Interactive mode, i.e. you can see the console
|
|
||||||
* ```-P``` - Expose all ports.
|
|
||||||
* ```-v``` - Volume to mount.
|
|
||||||
|
|
||||||
Press ^C to stop the server. There is now a ```server-settings.json``` in ```/tmp/factorio/config```. Modify this to your liking.
|
|
||||||
|
|
||||||
Now start the server as a daemon.
|
|
||||||
|
|
||||||
```
|
```
|
||||||
docker run -d -P -v /tmp/factorio:/factorio --name factorio dtandersen/factorio
|
docker run -d -P -v /tmp/factorio:/factorio --name factorio dtandersen/factorio
|
||||||
```
|
```
|
||||||
|
|
||||||
Try to connect to the server. Check the logs if it isn't working:
|
Here is an explanation of the options:
|
||||||
|
|
||||||
|
* ```--d``` - Run as a daemon (detached).
|
||||||
|
* ```-P``` - Expose all ports.
|
||||||
|
* ```-v``` - Mount ```/tmp/factorio``` on the local file system to ```/factorio``` in the container.
|
||||||
|
* ```--name``` - Name the container ```factorio``` (otherwise it has a random name).
|
||||||
|
|
||||||
|
Check the logs to see what happened:
|
||||||
|
|
||||||
```
|
```
|
||||||
docker logs factorio
|
docker logs factorio
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Stop the server:
|
||||||
|
|
||||||
|
```docker stop factorio```
|
||||||
|
|
||||||
|
Now there's a ```server-settings.json``` in ```/tmp/factorio/config```. Modify this to your liking.
|
||||||
|
|
||||||
|
Restart the server:
|
||||||
|
|
||||||
|
```docker start factorio```
|
||||||
|
|
||||||
|
Try to connect to the server. Check the logs if it isn't working.
|
||||||
|
|
||||||
## Saves
|
## Saves
|
||||||
|
|
||||||
A new map (```save.zip```) is generated the first time the server is started. On subsequent runs the newest save is used. To load an old save ```touch save.zip``` and restart the server.
|
A new map (```save.zip```) is generated the first time the server is started. On subsequent runs the newest save is used. To load an old save ```touch save.zip``` and restart the server.
|
||||||
@ -69,20 +73,6 @@ For custom map settings edit ```map-gen-settings.json``` in ```/tmp/factorio/con
|
|||||||
|
|
||||||
Copy the mods into the mods folder and restart the server.
|
Copy the mods into the mods folder and restart the server.
|
||||||
|
|
||||||
## Start/Stopping
|
|
||||||
|
|
||||||
Assuming the server is named ```factorio```, to stop the server:
|
|
||||||
|
|
||||||
```
|
|
||||||
docker stop factorio
|
|
||||||
```
|
|
||||||
|
|
||||||
To restart the server:
|
|
||||||
|
|
||||||
```
|
|
||||||
docker start factorio
|
|
||||||
```
|
|
||||||
|
|
||||||
## Volumes
|
## Volumes
|
||||||
|
|
||||||
The server has only one volume: ```/factorio```. Under this folder there are folders for ```/saves```, ```/mods```, and ```/config```.
|
The server has only one volume: ```/factorio```. Under this folder there are folders for ```/saves```, ```/mods```, and ```/config```.
|
||||||
|
Loading…
Reference in New Issue
Block a user