Added mods feature and refactored readme

This commit is contained in:
Christophe Vandekerchove 2016-03-26 18:45:31 +01:00
parent 115dc3b1a9
commit 46d525bcf7
2 changed files with 20 additions and 21 deletions

View File

@ -25,3 +25,5 @@ RUN echo "# Installing curl" && \
ENV FACTORIO_AUTOSAVE_INTERVAL 2 ENV FACTORIO_AUTOSAVE_INTERVAL 2
ENV FACTORIO_AUTOSAVE_SLOTS 3 ENV FACTORIO_AUTOSAVE_SLOTS 3
VOLUME "/opt/facotrio/mods"

View File

@ -10,7 +10,9 @@ Current Version
See [factorio's site](http://www.factorio.com) See [factorio's site](http://www.factorio.com)
#### Docker image #### Docker image
* Automatically takes latest save or autosave. when restarting the container. * Automatically takes latest save or autosave. when restarting the container.
* Added possibility to change defautl autosave interval * Added possibility to change default autosave interval
* Added possibility to change default autosave slots
* Added possibility to mount a mod volume to have your mods in your multiplayer session
Versions Versions
----- -----
@ -18,36 +20,31 @@ I'm keeping the image up to date. If you need to use an older version, checkout
How to use ? How to use ?
----- -----
3 ways of launching it : ### I just want to play !
* Without map persistence This runs factorio with default settings, and your save will be kept :
* With map persistence `docker run -d -v [PATH]:/opt/factorio/saves -p [PORT]:34197/udp zopanix/factorio`
* With existing map 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.
### Without map persistence ### Advanced usage
Here is the command : #### Without map persistence
`docker run -d -p [PORT]:34197/udp zopanix/factorio` `docker run -d -p [PORT]:34197/udp zopanix/factorio`
This will generate a new random map with default settings. This will generate a new random map with default settings.
If you're going to launch it on your local machine, don't use the port 34197, take another one at random. #### With map persistence
### With map persistence
`docker run -d -v [PATH]:/opt/factorio/saves -p [PORT]:34197/udp zopanix/factorio` `docker run -d -v [PATH]:/opt/factorio/saves -p [PORT]:34197/udp 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 -v [PATH]:/opt/factorio/saves -p [PORT]:34197/udp zopanix/factorio` `docker run -d -v [PATH]:/opt/factorio/saves -p [PORT]:34197/udp 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
### Advanced usage
#### 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 --env FACTORIO_AUTOSAVE_INTERVAL=[NUMBER] -v [PORT]:34197/udp zopanix/factorio` `docker run -d --env FACTORIO_AUTOSAVE_INTERVAL=[NUMBER] -p [PORT]:34197/udp 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 --env FACTORIO_AUTOSAVE_SLOTS=[NUMBER] -v [PORT]:34197/udp zopanix/factorio` `docker run -d --env FACTORIO_AUTOSAVE_SLOTS=[NUMBER] -p [PORT]:34197/udp zopanix/factorio`
Where [NUMBER] is the number of autosave slots. Where [NUMBER] is the number of autosave slots.
#### Mounting mod volume
ToDo's : 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`
* Adding possibility to add a mod volume Where [PATH] is the path to the folder with your mods.