From 048d12ef753b43727606ea78d971fa89b0303da1 Mon Sep 17 00:00:00 2001 From: Christophe Vandekerchove Date: Fri, 4 Mar 2016 15:50:01 +0100 Subject: [PATCH] Enriched readme --- README.md | 28 +++++++++++++++++++++++++--- 1 file changed, 25 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 21fffbb..186a629 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,25 @@ -# docker_factorio_server -Factorio Server in Docker -## Hoping this works +Factorio +===== +Factorio Server in docker + +How to use ? +----- +3 ways of launching it : +* Without map persistence +* With map persistence +* With existing map + +### Without map persistence +Here is the command : +`docker run -d -p [PORT]:34197/udp 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 +`docker run -d -v [PATH]:/opt/factorio/saves -p {port}:34197/udp 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 +`docker run -d -v [PATH]:/opt/factorio/saves -p {port}:34197/udp factorio` +It's the same as above, so if there is a file named save.zip in the [PATH] folder, it will use that map as default.