From e5c351dd142f46c58eab9844449a0281a004fb30 Mon Sep 17 00:00:00 2001 From: Christophe Vandekerchove Date: Sat, 26 Mar 2016 18:45:31 +0100 Subject: [PATCH] Added mods feature and refactored readme --- Dockerfile | 2 ++ README.md | 39 ++++++++++++++++++--------------------- 2 files changed, 20 insertions(+), 21 deletions(-) diff --git a/Dockerfile b/Dockerfile index f1a2e9e..596b6da 100644 --- a/Dockerfile +++ b/Dockerfile @@ -25,3 +25,5 @@ RUN echo "# Installing curl" && \ ENV FACTORIO_AUTOSAVE_INTERVAL 2 ENV FACTORIO_AUTOSAVE_SLOTS 3 + +VOLUME "/opt/facotrio/mods" diff --git a/README.md b/README.md index b56c508..9b7ccdb 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,9 @@ Current Version See [factorio's site](http://www.factorio.com) #### Docker image * 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 ----- @@ -18,36 +20,31 @@ I'm keeping the image up to date. If you need to use an older version, checkout How to use ? ----- -3 ways of launching it : -* Without map persistence -* With map persistence -* With existing map - -### Without map persistence -Here is the command : +### I just want to play ! +This runs factorio with default settings, and your save will be kept : +`docker run -d -v [PATH]:/opt/factorio/saves -p [PORT]:34197/udp 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 [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 +#### Without map persistence `docker run -d -p [PORT]:34197/udp zopanix/factorio` 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` 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. - -### With existing map +#### With existing map `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 - -### Advanced usage #### 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. -`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. #### 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. -`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. - -ToDo's : ------ -* Adding possibility to add a 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. +`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.