Skip to content

Latest commit

 

History

History
81 lines (57 loc) · 3.99 KB

readme.md

File metadata and controls

81 lines (57 loc) · 3.99 KB

Containerised OpenTTD

An image brought to you by /r/openttd

Build Stable Build Testing

Built from OpenTTD source to provide the leanest, meanest image you'll come across for putting trainsets in containers.

Image Names & Tags

The CI system will automatically build the current latest versions at 3AM every day. This is a little hacky, but it does mean we get new builds within 24 hours of release.

You can find the images at the following locations:

Registry URI
prefer Github Container Registry ghcr.io/ropenttd/openttd:{tag}
deprecated Docker Hub docker.io/redditopenttd/openttd:{tag}

Please prefer the Github Container registry for new deployments. It's 100% compatible with your Docker installation.

Tag Description
stable The latest stable release of OpenTTD.
latest As stable
Major Version The latest stable release for this major version (i.e 7 may point to 7.1.2)
testing The latest unstable release of OpenTTD, including betas and release candidates.
nightly Reserved (if you need this, raise an issue!)

Architectures

Images are built for AMD64 (x86_64, i.e 64bit PC) and ARM64 (modern ARM, i.e Raspberry Pi 3 running 64-bit OS).

If you need an architecture not listed above, please raise an issue.

Using this Container

Docker

docker run -d -p 3979:3979/tcp -p 3979:3979/udp redditopenttd/openttd:latest

The container is set by default to start a fresh game every time you restart the container. You can, however, change this behaviour with the loadgame envvar:

-e "loadgame={false|last-autosave|exit|(savename)}"

where:

  • false: standard behaviour, just start a new game
  • last-autosave: load the last chronological autosave
  • exit: try to load autosave/exit.sav, otherwise default to a new game
  • (savename): full name of a save file in config/saves

You'll probably want stuff to be persistant between container rebuilds, so we've got the /config volume for exactly that purpose.

-v /home/{username}/.openttd:/config:rw

Heads up: If we can't find an openttd.cfg in /config, we'll attempt to ask OpenTTD to start a new configuration directory there. We strongly recommend that if you're starting fresh, you stop the container and configure openttd.cfg as per the wiki.

If you don't want the entire .openttd directory to be copied to your local FS statically, you may want to consider mounting files / directories directly like so:

-v /home/{username}/.openttd/openttd.cfg:/config/openttd.cfg:ro
-v /home/{username}/.openttd/save/:/config/save:rw

The easiest way to play with NewGRF's is to first download and configure them how you want on a local machine with a GUI. Then in the config/ directory copy the folder from local machine named content_downloaded to the server. Next update the openttd.cfg file from your local machine, this is to ensure that when you create a new server your NewGRF settings will be copied across.

An example command to start a server

docker run -it -p 3979:3979/tcp -p 3979:3979/udp -v /home/{username}/.openttd:/config:rw -e "loadgame=game.sav" redditopenttd/openttd:latest

This will start a server with the console accessible due to -it in the command line, to run in the background use -d.

podman

Replace all of the docker commands in the docker section with podman. If you're having issues, please raise an issue.

Kubernetes

Because OpenTTD is quite heavily stateful, we have written some handy helper containers for you to use as init containers and sidecars. Please see the openttd_k8s-helpers repo for more information.