rouhim/beammp-server repository overview

This project provides a container image for the BeamMP⁠ game server and shows its usage in a docker compose environment.

⁠Motivation

Because there were no well-documented BeamMP server container images out there, I did one by myself.

⁠Usage

The sections below provides use cases for docker and docker compose.

⁠Versions

There are two version tags available:

• latest: The latest stable⁠ release of the BeamMP server
• prerelease: The latest development⁠ release of the BeamMP server

⁠docker

Quick start:

docker run --name beammp-server \
           -p 30814:30814/tcp -p 30814:30814/udp \
           -e BEAMMP_NAME='My first awesome Server' \
           -e BEAMMP_AUTH_KEY='<insert auth-key>' \
           rouhim/beammp-server

⁠docker compose

First clone this repository and check docker-compose.yml if interested. The configuration should be done within the .env file.

To get started rename .env.example to .env and create the mod folder.

cp .env.example .env 
mkdir client-mods/ server-mods/
chmod 777 client-mods/ server-mods/

Adjust the values in the .env to your needs and run:

docker compose pull && docker compose up -d

⁠Server interaction

To connect to the interactive game server console, you need to start the server in detached (docker / -compose -d flag) mode. Then run the following command to attach to the server console:

docker attach <container-name>

⁠Environment parameter

A new auth key can be claimed on this site⁠, you will need a Discord⁠ account for this. Note that the IP entered there does not matter, despite what the site claims. For more information refer to this wiki page⁠.

⁠Client mods

In the first place you should consider reading the official mods guide⁠. Mods can be downloaded from the official BeamNG resources website⁠. Just copy the downloaded zip file into the client-mods folder.

⁠Custom maps

Copy the downloaded zip file into the client-mods folder.

Then have to find out the custom map path name (e.g.: /levels/car_jump_arena/info.json), to set it later as the map to load. To do so:

1. Execute the shell command below, or open the zip file manually.
2. Copy the absolute path to the info.json location (/levels/{map-name}/info.json).
3. Set in .env file: BEAMMP_MAP=/levels/{map-name}/info.json. Example: BEAMMP_MAP=/levels/car_jump_arena/info.json

A simple way to print the full map path including info.json (unzip, grep and awk is required):

unzip -l PATH/TO/MAP.zip \
  | grep 'levels/.*/info.json' \
  | awk '{split($0,a," "); print "/"a[4]}'

⁠Automatic updates

If you want to update the mods automatically, you can use a little tool I wrote called beammp-server-beiwagen⁠ which aims to provide an easy way to update the mods in the client-mods folder.

⁠Server mods

Server mods can be found in the BeamMP forum⁠. Installation and configuration instructions are provided by each mod.

⁠Custom ServerConfig.toml

If you want to specify a custom ServerConfig.toml file, just create a new file called ServerConfig.toml and fill it with your configuration (Example⁠). Make sure to mount the file as volume to the container. The file will be mounted to the server directory on startup.

Docker example:

docker run --name beammp-server \
           -p 30814:30814/tcp -p 30814:30814/udp \
           -v ./ServerConfig.toml:/beammp/ServerConfig.toml \
           -e BEAMMP_PRIVATE -e BEAMMP_MAX_CARS -e BEAMMP_MAX_PLAYERS -e BEAMMP_MAP -e BEAMMP_NAME -e BEAMMP_DESCRIPTION -e BEAMMP_PORT -e BEAMMP_DEBUG -e BEAMMP_AUTH_KEY \
           rouhim/beammp-server

For docker compose, just add the following line to the volumes section:

volumes:
  - ./ServerConfig.toml:/beammp/ServerConfig.toml

⁠Resources

• BeamMP server repository: https://github.com/BeamMP/BeamMP-Server⁠
• Official server maintenance guide: https://docs.beammp.com/server/server-maintenance/⁠
• Official server installation guide: https://docs.beammp.com/server/create-a-server/⁠
• Inspired by: https://github.com/mastamic-ian/BeamMP_docker⁠
• Built from: https://github.com/RouHim/beammp-container-image⁠
• Built to: https://hub.docker.com/r/rouhim/beammp-server⁠