factorio-docker/README.md

70 lines
2.8 KiB
Markdown
Raw Normal View History

2016-04-15 07:50:29 +02:00
# Supported tags and respective `Dockerfile` links
2016-04-15 07:45:25 +02:00
2016-10-25 18:58:54 +02:00
* `0.14.14` [(0.14.14/Dockerfile)](https://github.com/dtandersen/docker_factorio_server/blob/0.14.14/Dockerfile)
2016-04-30 00:56:19 +02:00
* `0.12.32`, `latest` [(0.12.32/Dockerfile)](https://github.com/dtandersen/docker_factorio_server/blob/dt_0.12.32/Dockerfile)
* `0.12.31` [(0.12.31/Dockerfile)](https://github.com/dtandersen/docker_factorio_server/blob/dt_0.12.31/Dockerfile)
2016-04-27 00:01:32 +02:00
* `0.12.30` [(0.12.30/Dockerfile)](https://github.com/dtandersen/docker_factorio_server/blob/dt_0.12.30/Dockerfile)
2016-04-15 07:45:25 +02:00
2016-04-27 00:05:59 +02:00
[![](https://imagelayers.io/badge/dtandersen/factorio:latest.svg)](https://imagelayers.io/?images=dtandersen/factorio:latest 'Get your own badge on imagelayers.io')
2016-04-15 07:41:33 +02:00
2016-04-15 07:48:52 +02:00
# What is Factorio?
2016-04-15 07:37:25 +02:00
[Factorio](https://www.factorio.com) is a game in which you build and maintain factories.
You will be mining resources, researching technologies, building infrastructure, automating production and fighting enemies. Use your imagination to design your factory, combine simple elements into ingenious structures, apply management skills to keep it working and finally protect it from the creatures who don't really like you.
The game is very stable and optimized for building massive factories. You can create your own maps, write mods in Lua or play with friends via Multiplayer.
NOTE: This is only the server. The game is available on [Steam](http://store.steampowered.com/app/427520/).
2016-03-24 08:39:16 +01:00
2016-04-15 07:48:52 +02:00
# Features
2016-04-15 07:54:17 +02:00
2016-04-15 07:23:36 +02:00
* Automatically takes latest save or autosave when restarting the container.
* Volumes for saves and mods
* Set autosave interval and number of saves.
* Enable/disable the no-auto-pause option.
* Enable/disable console commands in game.
2016-04-15 07:37:25 +02:00
* Based on Alpine Linux.
2016-03-26 10:23:21 +01:00
2016-04-15 07:48:52 +02:00
# How to use this image?
## Quick Start
2016-10-25 18:58:54 +02:00
Create ```server-config.json``` and modify it to your liking. Now run:
2016-03-04 15:50:01 +01:00
2016-03-27 08:56:09 +02:00
```
2016-10-25 18:58:54 +02:00
docker run -d -P \
-v /path/to/server-config.json:/opt/factorio/data/server-config.json \
-v /path/to/saves:/opt/factorio/saves \
-v /path/to/mods:/opt/factorio/mods \
2016-10-25 19:03:50 +02:00
--name factorio
2016-04-15 07:23:36 +02:00
dtandersen/factorio
2016-03-27 08:56:09 +02:00
```
2016-04-15 07:54:17 +02:00
2016-10-25 19:03:50 +02:00
```-d``` starts the server as a daemon. ```-P``` exposes all ports. The ```-v``` options mount volumes on the local file system to the container for config, mods, and saves. ```dtandersen/factorio``` is the docker images name. ```--name``` gives the container a name instead of a random name.
2016-10-25 18:58:54 +02:00
The server should start and create ```/path/to/saves/save.zip```. This save is used when the server is restarted.
2016-03-27 08:57:43 +02:00
2016-10-25 18:58:54 +02:00
## Volumes
2016-04-15 07:48:52 +02:00
2016-10-25 18:58:54 +02:00
* /opt/factorio/saves - save files
* /opt/factorio/mods - save files
* /opt/factorio/data/server-config.json - config file
2016-04-15 07:48:52 +02:00
2016-10-25 18:58:54 +02:00
## Ports
2016-04-15 07:54:17 +02:00
2016-10-25 18:58:54 +02:00
* 34197/udp - game data
* 27015/tcp - rcon
2016-04-15 07:23:36 +02:00
2016-04-15 07:54:17 +02:00
### Logs
Sometimes it's useful to see the logs of a running container:
```
2016-10-25 19:03:50 +02:00
docker exec -it factorio tail -f /opt/factorio/factorio-current.log
2016-04-15 07:54:17 +02:00
```
2016-04-15 07:48:52 +02:00
# Credits
2016-04-15 07:23:36 +02:00
Based on [Zopanix' Factorio Server](https://github.com/zopanix/docker_factorio_server).