factorio-docker/README.md
2016-10-27 12:27:42 -07:00

3.7 KiB

Factorio Docker Pulls Docker Stars

What is Factorio?

Factorio 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 at factorio.com and Steam.

Usage

Quick Start

Run the server to create the necessary folder structure and configuration files. For this example data is stored in /tmp/factorio.

docker run -d -P -v /tmp/factorio:/factorio --name factorio dtandersen/factorio

For those new to Docker, here is an explanation of the options:

  • -d - Run as a daemon ("detached").
  • -P - Expose all ports.
  • -v - Mount /tmp/factorio on the local file system to /factorio in the container.
  • --name - Name the container "factorio" (otherwise it has a funny random name).

Check the logs to see what happened:

docker logs factorio

Stop the server:

docker stop factorio

Now there's a server-settings.json file in the folder /tmp/factorio/config. Modify this to your liking and restart the server:

docker start factorio

Try to connect to the server. Check the logs if it isn't working.

Saves

A new map named save.zip is generated the first time the server is started. The map-gen-settings.json file in /tmp/factorio/config is used for the map settings. On subsequent runs the newest save is used.

To load an old save stop the server and run the command touch oldsave.zip. This resets the date. Then restart the server.

To generate a new map stop the server, delete all of the saves and restart the server.

Mods

Copy mods into the mods folder and restart the server.

Remote Console

RCON is currently disabled.

Container Details

The philosophy is to keep things simple.

  • Prefer configuration files over environment variables.
  • The container should work in a basic way without external configuration.
  • Use one volume for data.

Volumes

To keep things simple, the container uses a single volume mounted at /factorio. This volume stores configuration, mods, and saves.

factorio
|-- config
|   |-- server-settings.json
|   +-- map-gen-settings.json
|-- mods
|   +-- fancymod.zip
+-- saves
    |-- _autosave1.zip
    +-- save.zip

Ports

  • 34197/udp - Factorio clients (required).
  • 27015/tcp - RCON (optional).

Troubleshooting

Server is listed in the in-game server browser, but users can't connect

Run Docker with the --userland-proxy=false option. The source UDP port is changed by docker-proxy when the server pings "pingpong" servers. See Incorrect port detected for docker hosted server.

Credits

Ideas borrowed from: