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

Fixed readme

Browse Source
This commit is contained in:
Christophe Vandekerchove 2016-03-27 08:56:09 +02:00
parent 2caf5345c2
commit 34a99ec43e
1 changed files with 30 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
README.md
View File

@ -22,48 +22,65 @@ How to use ?
----- -----
### I just want to play ! ### I just want to play !
This runs factorio with default settings, and your save will be kept : This runs factorio with default settings, and your save will be kept :
`docker run -d \ ```
docker run -d \
-v [PATH]:/opt/factorio/saves \ -v [PATH]:/opt/factorio/saves \
-p [PORT]:34197/udp \ -p [PORT]:34197/udp \
zopanix/factorio` zopanix/factorio
```
Where [PATH] is a folder where you'll put your saves, if there already is a save in it with the string "save", that one will be taken by default, otherwize, a new one will be made. Where [PATH] is a folder where you'll put your saves, if there already is a save in it with the string "save", that one will be taken by default, otherwize, a new one will be made.
Where [PORT] is the port number you choose, if you're going to launch it on your local machine, don't use the port 34197, take another one at random. Where [PORT] is the port number you choose, if you're going to launch it on your local machine, don't use the port 34197, take another one at random.
### Advanced usage ### Advanced usage
#### Without map persistence #### Without map persistence
`docker run -d \ ```
docker run -d \
-p [PORT]:34197/udp \ -p [PORT]:34197/udp \
zopanix/factorio` zopanix/factorio
```
This will generate a new random map with default settings. This will generate a new random map with default settings.
#### With map persistence #### With map persistence
`docker run -d \ ```
docker run -d \
-v [PATH]:/opt/factorio/saves \ -v [PATH]:/opt/factorio/saves \
-p [PORT]:34197/udp \ -p [PORT]:34197/udp \
zopanix/factorio` zopanix/factorio
```
This will generate a new random map with default settings and save it onto the volume. This will generate a new random map with default settings and save it onto the volume.
Replace [PATH] with a path to a folder on the host where the map will be saved. Replace [PATH] with a path to a folder on the host where the map will be saved.
#### With existing map #### With existing map
`docker run -d \ ```
docker run -d \
-v [PATH]:/opt/factorio/saves \ -v [PATH]:/opt/factorio/saves \
-p [PORT]:34197/udp \ -p [PORT]:34197/udp \
zopanix/factorio` zopanix/factorio
```
It's the same as above, it takes the last modified file which contains the word save in the filename as current save when booting the server. This allows when upgrading the container to take the last save, you don't have to rename the last autosave as save.zip It's the same as above, it takes the last modified file which contains the word save in the filename as current save when booting the server. This allows when upgrading the container to take the last save, you don't have to rename the last autosave as save.zip
#### Autosave interval #### Autosave interval
You can set the autosave interval. By default it is set at 2 minutes bud you can change it by launching the container with the "FACTORIO_AUTOSAVE_INTERVAL" variable to whatever suits you best. You can set the autosave interval. By default it is set at 2 minutes bud you can change it by launching the container with the "FACTORIO_AUTOSAVE_INTERVAL" variable to whatever suits you best.
`docker run -d \ ```
docker run -d \
--env FACTORIO_AUTOSAVE_INTERVAL=[NUMBER] \ --env FACTORIO_AUTOSAVE_INTERVAL=[NUMBER] \
-p [PORT]:34197/udp \ -p [PORT]:34197/udp \
zopanix/factorio` zopanix/factorio
```
Where [NUMBER] is the number of minutes between autosaves. Where [NUMBER] is the number of minutes between autosaves.
#### Autosave slots #### Autosave slots
You can set the number of autosave slots. By default it is set at 3 slots bud you can change it by launching the container with the "FACTORIO_AUTOSAVE_SLOTS" variable to whatever suits you best. You can set the number of autosave slots. By default it is set at 3 slots bud you can change it by launching the container with the "FACTORIO_AUTOSAVE_SLOTS" variable to whatever suits you best.
`docker run -d \ ```
docker run -d \
--env FACTORIO_AUTOSAVE_SLOTS=[NUMBER] \ --env FACTORIO_AUTOSAVE_SLOTS=[NUMBER] \
-p [PORT]:34197/udp \ -p [PORT]:34197/udp \
zopanix/factorio` zopanix/factorio
```
Where [NUMBER] is the number of autosave slots. Where [NUMBER] is the number of autosave slots.
#### Mounting mod volume #### Mounting mod volume
As everybody knows about factorio is you can add mods to it. Now you can also do it in this docker image by mounting a volume. As everybody knows about factorio is you can add mods to it. Now you can also do it in this docker image by mounting a volume.
`docker run -d -v [PATH]:/opt/factorio/mods -p [PORT]:34197/udp zopanix/factorio` ```
docker run -d \
-v [PATH]:/opt/factorio/mods \
-p [PORT]:34197/udp \
zopanix/factorio
```
Where [PATH] is the path to the folder with your mods. Where [PATH] is the path to the folder with your mods.
ToDo's ToDo's
----- -----