https://github.com/nothub/openttd-docker
https://github.com/nothub/openttd-docker
container docker openttd openttd-server
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/nothub/openttd-docker
- Owner: nothub
- Created: 2022-05-16T22:00:45.000Z (about 3 years ago)
- Default Branch: trunk
- Last Pushed: 2024-10-30T08:58:07.000Z (7 months ago)
- Last Synced: 2025-03-24T02:21:40.871Z (about 2 months ago)
- Topics: container, docker, openttd, openttd-server
- Language: Dockerfile
- Homepage: https://hub.docker.com/r/n0thub/openttd
- Size: 37.1 KB
- Stars: 3
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## openttd-docker
[docker hub](https://hub.docker.com/r/n0thub/openttd)
---
### Configuration
#### Custom config
A custom configuration can be loaded by mounting the file to: `/data/openttd.cfg`
Available options are listed in the official [wiki](https://wiki.openttd.org/en/Archive/Manual/Settings/Openttd.cfg) and [github](https://github.com/OpenTTD/OpenTTD/blob/master/src/settings_type.h).
#### Load latest autosave
If the environment variable LOAD_AUTOSAVE is set, the latest autosave present in `/data/save/autosave/` will be loaded.
#### Load template save
A template save file can be loaded by mounting the file to: `/data/save/template.sav`
The file will be ignored if LOAD_AUTOSAVE is set and an autosave file is present in `/data/save/autosave/`.
#### Custom user or group id
A custom user or group id can be defined by setting the environment variable `PUID` or `PGID`, e.g. `PUID=2000` or `PGID=3000`.
---
### Online content
To download online content in a running container, use the `content` command:
```
content update
content state ITL Houses
content select 54540301
content download
```
For online content to be loaded from persistent storage, make sure the content file is:
Present in the mounted volume, e.g.
`/data/content_download/newgrf/54540301-ITL_Houses-2.1.tar`
And configured in the `/data/openttd.cfg` config file, e.g.
```
[newgrf]
54540301|F7CDD4F730E4F3EE87100CE42E5070AE|itl_houses-2.1/itl_houses.grf = 0 0 0
```
### Ports
If no port mapping is configured for the container, a server with `server_game_type = public` will still register with the [Game Coordinator](https://github.com/OpenTTD/game-coordinator) and attempt to use `Connection type: Behind NAT` to establish connections with clients.
---
### Examples
Defaults
**docker run**
```bash
docker run --interactive --tty --rm \
-p "3979:3979/tcp" \
-p "3979:3979/udp" \
n0thub/openttd:latest
```
**docker compose**
```yaml
version: '3'
services:
openttd:
image: n0thub/openttd:latest
ports:
- "3979:3979/tcp"
- "3979:3979/udp"
```
---
Custom config
**docker run**
```bash
docker run --interactive --tty --rm \
-p "3979:3979/tcp" \
-p "3979:3979/udp" \
-v "${PWD}/example.cfg:/data/openttd.cfg" \
n0thub/openttd:latest
```
**docker compose**
```yaml
version: '3'
services:
openttd:
image: n0thub/openttd:latest
ports:
- "3979:3979/tcp"
- "3979:3979/udp"
volumes:
- ./example.cfg:/data/openttd.cfg
```
---
Persistent storage mount
**docker run**
```bash
docker run --interactive --tty --rm \
-p "3979:3979/tcp" \
-p "3979:3979/udp" \
-v "${PWD}/data/:/data/" \
n0thub/openttd:latest
```
**docker compose**
```yaml
version: '3'
services:
openttd:
image: n0thub/openttd:latest
ports:
- "3979:3979/tcp"
- "3979:3979/udp"
volumes:
- ./data/:/data/
```
---
Load latest autosave
**docker run**
```bash
docker run --interactive --tty --rm \
-p "3979:3979/tcp" \
-p "3979:3979/udp" \
-v "${PWD}/data/:/data/" \
-e LOAD_AUTOSAVE="true" \
n0thub/openttd:latest
```
**docker compose**
```yaml
version: '3'
services:
openttd:
image: n0thub/openttd:latest
ports:
- "3979:3979/tcp"
- "3979:3979/udp"
volumes:
- ./data/:/data/
environment:
- LOAD_AUTOSAVE="true"
```
---
Load template save
**docker run**
```bash
docker run --interactive --tty --rm \
-p "3979:3979/tcp" \
-p "3979:3979/udp" \
-v "${PWD}/template.sav:/data/save/template.sav" \
n0thub/openttd:latest
```
**docker compose**
```yaml
version: '3'
services:
openttd:
image: n0thub/openttd:latest
ports:
- "3979:3979/tcp"
- "3979:3979/udp"
volumes:
- ./template.sav:/data/save/template.sav
```
---
Custom user or group id
**docker run**
```bash
docker run --interactive --tty --rm \
-p "3979:3979/tcp" \
-p "3979:3979/udp" \
-v "${PWD}/data/:/data/" \
-e PUID=2000 \
-e PGID=3000 \
n0thub/openttd:latest
```
**docker compose**
```yaml
version: '3'
services:
openttd:
image: n0thub/openttd:latest
ports:
- "3979:3979/tcp"
- "3979:3979/udp"
volumes:
- ./data/:/data/
environment:
- PUID=2000
- PGID=3000
```
---
Combined options
**docker run**
```bash
docker run --interactive --tty --rm \
-p "3979:3979/tcp" \
-p "3979:3979/udp" \
-v "${PWD}/data/:/data/" \
-v "${PWD}/example.cfg:/data/openttd.cfg" \
-v "${PWD}/template.sav:/data/save/template.sav" \
-e PUID=2000 \
-e PGID=3000 \
-e LOAD_AUTOSAVE="true" \
n0thub/openttd:latest
```
**docker compose**
```yaml
version: '3'
services:
openttd:
image: n0thub/openttd:latest
ports:
- "3979:3979/tcp"
- "3979:3979/udp"
volumes:
- ./data/:/data/
- ./example.cfg:/data/openttd.cfg
- ./template.sav:/data/save/template.sav
environment:
- PUID=2000
- PGID=3000
- LOAD_AUTOSAVE="true"
```
---
### Arguments
Arguments will be relayed to the OpenTTD process if supplied to the container:
```bash
docker run --rm n0thub/openttd:latest --help
```