How to Create Your Own BeamMP Server
Complete guide to create a BeamMP server (BeamNG.drive multiplayer) on a VPS or dedicated Linux server: AuthKey, map, mods, Lua plugins, systemd service and firewall.
On this page
Your values
Enter them once and the commands in this guide update.
BeamMP is the community multiplayer mod for BeamNG.drive. This guide explains how to install its server on your VPS or dedicated Linux server, run it with a dedicated user and a systemd service, then choose the map and add mods and Lua plugins.
Order a Server
BeamMP is lightweight: the number of players, vehicles and mods mostly determines the resources needed. HostMyServers offers several suitable plans:
- NVMe VPS - For a server with friends or a test server
- Performance VPS - Dedicated resources, for a public server
- Eco Dedicated Servers - For an active community or many mods
- Performance Dedicated Servers - Maximum performance
Prerequisites
- SSH access as root or user with sudo privileges
- 64-bit x86_64 Linux system: Debian 12/13 or Ubuntu 22.04/24.04
- Active firewall: nftables (recommended), iptables or ufw (use only one firewall tool at a time)
- A public IPv4 address: the BeamMP server does not yet support IPv6 for players
- A Discord account, to create your AuthKey on the BeamMP Keymaster
- Port 30814 accessible over TCP and UDP
Each player must own BeamNG.drive and install the BeamMP launcher.
Required Configuration
BeamMP publishes the following minimum values, excluding the operating system's own usage. The right column is a suggested starting point, to adjust according to your usage.
| Component | Official minimum | Suggested starting point |
|---|---|---|
| RAM | 50 MiB available | 2 GB |
| CPU | Over 1 GHz, preferably multi-core | 2 cores |
| Storage | 10 MiB, plus mods and plugins | 10 GB SSD, more with many mods |
| Network | 5 to 10 Mbps upload | 100 Mbps |
| Graphics card | None | None |
System Update
sudo apt update && sudo apt upgrade -yInstalling Dependencies
BeamMP requires the Lua 5.3 library (liblua5.3-0). The other packages are used for downloads, mods and backups:
sudo apt install -y liblua5.3-0 curl tar unzip nano cronCreating a Dedicated User
BeamMP advises against running the server as root or with your personal account. Create a dedicated user:
sudo adduser --disabled-password --gecos "" beammpPorts Used
| Port | Protocol | Usage |
|---|---|---|
| 30814 | TCP | Player connection, mod download |
| 30814 | UDP | Real-time game data |
BeamMP has neither RCON nor a web interface: you have no administration port to open. The console is only accessible from the server itself (see Administration).
Firewall Configuration
With UFW
sudo ufw allow 30814/tcp
sudo ufw allow 30814/udp
sudo ufw reloadWith iptables
sudo iptables -A INPUT -p tcp --dport 30814 -j ACCEPT
sudo iptables -A INPUT -p udp --dport 30814 -j ACCEPT
sudo iptables-save | sudo tee /etc/iptables/rules.v4Saving the rules across reboots requires the iptables-persistent package.
With nftables
These commands use the inet filter table and the input chain, present by default in /etc/nftables.conf on Debian.
sudo nft add rule inet filter input tcp dport 30814 accept
sudo nft add rule inet filter input udp dport 30814 accept
(echo "flush ruleset"; sudo nft list ruleset) | sudo tee /etc/nftables.confCreating the AuthKey
The AuthKey identifies your server to BeamMP. The server refuses to start without it, even if it stays private.
- Go to the BeamMP Keymaster and log in with Discord.
- Open the Keys section.
- Click the green + button.
- Enter a server name, then click Create.
- Copy the key you get.
Installing the Server
Log in as the beammp user and create the server folder:
sudo -iu beammp
mkdir -p ~/beammp-server
cd ~/beammp-serverDownload the latest version for your system. The first line detects your distribution, to get for example debian.12 or ubuntu.24.04:
. /etc/os-release
curl -fL -o BeamMP-Server "https://github.com/BeamMP/BeamMP-Server/releases/latest/download/BeamMP-Server.$ID.$VERSION_ID.x86_64"
chmod +x BeamMP-ServerStart the server once to generate its configuration:
./BeamMP-ServerServer Configuration
Open the configuration file:
nano ~/beammp-server/ServerConfig.tomlChange at least these values in the [General] section, without touching the other lines. The order of the lines in your file may be different:
[General]
AuthKey = "PASTE_YOUR_KEY_HERE"
Name = "My BeamMP Server"
Description = "Welcome to my server"
Tags = "Freeroam,Lang:English"
Map = "/levels/west_coast_usa/info.json"
MaxPlayers = 8
MaxCars = 2
Private = true
AllowGuests = falseThen protect this file, which contains your key, and exit the beammp user's session:
chmod 600 ~/beammp-server/ServerConfig.toml
exitMain Parameters
| Parameter | Default value | Description |
|---|---|---|
AuthKey |
empty | Key created on the Keymaster (required) |
Name |
BeamMP Server |
Name shown in the server list (250 characters maximum) |
Description |
BeamMP Default Description |
Server description (1000 characters maximum) |
Tags |
Freeroam |
Search tags separated by commas (100 characters maximum) |
Map |
/levels/gridmap_v2/info.json |
Hosted map |
MaxPlayers |
8 |
Maximum number of players |
MaxCars |
1 |
Maximum number of vehicles per player |
Port |
30814 |
Server TCP and UDP port |
Private |
true |
true hides the server from the public list, false publishes it there |
AllowGuests |
true |
Allows players connected without a BeamMP account |
LogChat |
true |
Saves the chat in the logs |
Debug |
false |
Detailed logs, much larger |
ResourceFolder |
Resources |
Folder for mods and plugins |
If you change Port, adjust the firewall rules as well.
Name Formatting
Name and Description accept formatting codes, placed before the text: ^l bold, ^o italic, ^n underline, ^r reset, ^4 red, ^2 green, ^e yellow, ^f white. For example: Name = "^l^4My server ^r^fBeamMP". The BeamMP documentation gives the full list, as well as the recognized tags.
Choosing the Map
Set the map path in the Map parameter. The maps shipped with the game require no installation:
| Map | Map value |
|---|---|
| Grid Map | /levels/gridmap_v2/info.json |
| Small Grid | /levels/smallgrid/info.json |
| West Coast USA | /levels/west_coast_usa/info.json |
| East Coast USA | /levels/east_coast_usa/info.json |
| Utah | /levels/utah/info.json |
| Italy | /levels/italy/info.json |
| Jungle Rock Island | /levels/jungle_rock_island/info.json |
| Johnson Valley | /levels/johnson_valley/info.json |
| Hirochi Raceway | /levels/hirochi_raceway/info.json |
| Automation Test Track | /levels/automation_test_track/info.json |
| Industrial | /levels/industrial/info.json |
| Small Island | /levels/small_island/info.json |
| Driver Training | /levels/driver_training/info.json |
| Derby | /levels/derby/info.json |
Configuration as systemd Service
The service below starts BeamMP automatically. It is paired with a small local channel (/run/beammp.stdin) that lets you send commands to the server console.
Create the Console Channel
sudo nano /etc/systemd/system/beammp.socket[Unit]
Description=BeamMP Server console
PartOf=beammp.service
[Socket]
ListenFIFO=/run/beammp.stdin
SocketUser=beammp
SocketGroup=beammp
SocketMode=0660
RemoveOnStop=trueCreate the Service File
sudo nano /etc/systemd/system/beammp.service[Unit]
Description=BeamMP Server
Wants=network-online.target
After=network-online.target beammp.socket
Requires=beammp.socket
[Service]
Type=simple
User=beammp
Group=beammp
WorkingDirectory=/home/beammp/beammp-server
ExecStart=/home/beammp/beammp-server/BeamMP-Server
Sockets=beammp.socket
StandardInput=socket
StandardOutput=journal
StandardError=journal
Restart=on-failure
RestartSec=10
TimeoutStopSec=30
[Install]
WantedBy=multi-user.targetEnable and Start Service
sudo systemctl daemon-reload
sudo systemctl enable beammp.service
sudo systemctl start beammp.serviceManagement Commands
# Check status
sudo systemctl status beammp.service
# Stop server
sudo systemctl stop beammp.service
# Restart server
sudo systemctl restart beammp.service
# View logs
sudo journalctl -u beammp.service -fChecking That It Works
The server is ready when the logs display ALL SYSTEMS STARTED SUCCESSFULLY, EVERYTHING IS OKAY:
sudo journalctl -u beammp.service -n 30 --no-pagerCheck that it is listening on both TCP and UDP:
sudo ss -tulpn | grep 30814You should get a tcp line and a udp line associated with BeamMP-Server. With Private = false, the logs should also display Authenticated!.
Connecting to the Server
- Launch the BeamMP launcher, which starts BeamNG.drive.
- Open the BeamMP multiplayer menu.
- Use Direct Connect, then enter
SERVER_IPand port30814.
If the server is public (Private = false), players can also search for it by name in the list. They must then disable the filters and set the map to Any.
Adding Mods
Vehicle and map mods go, in .zip format, in Resources/Client. Do not extract them. Players download them automatically when joining the server.
From your computer, send the mod to the server with your administrator account:
scp my_mod.zip YOUR_USER@SERVER_IP:/tmp/On the server, install it then restart BeamMP:
sudo install -o beammp -g beammp -m 644 /tmp/my_mod.zip /home/beammp/beammp-server/Resources/Client/
sudo rm /tmp/my_mod.zip
sudo systemctl restart beammp.serviceUsing a Modded Map
The map's .zip file contains a levels/<map_name> folder. Find that name:
unzip -l /home/beammp/beammp-server/Resources/Client/my_map.zip | grep 'levels/.*/info.json'If the line displayed contains levels/my_map/info.json, edit ServerConfig.toml:
Map = "/levels/my_map/info.json"Then restart the service. If the info.json file cannot be found in the archive, load the map in solo mode in BeamNG.drive, open the console with ~ and run print(getMissionFilename()) to get the exact path.
Adding Lua Plugins
Plugins run on the server. Each has its own folder in Resources/Server:
Resources/
├── Client/ Mods sent to players (.zip)
└── Server/
└── Welcome/ One folder per plugin
└── main.luaAll .lua files placed directly in the plugin's folder are loaded at startup, in alphabetical order. The server automatically reloads a plugin when one of these files is modified. Subfolders are not loaded automatically: use require(). The plugin reference details the available events and functions.
Example: Welcome Message
sudo -iu beammp
mkdir -p ~/beammp-server/Resources/Server/Welcome
nano ~/beammp-server/Resources/Server/Welcome/main.luafunction onInit()
print("Welcome plugin loaded")
end
function onPlayerArrival(player_id)
MP.SendChatMessage(player_id, "Welcome to the server!")
end
MP.RegisterEvent("onPlayerJoin", "onPlayerArrival")Example: Whitelist
This plugin only accepts the BeamMP usernames in the list and refuses guests. Still as the beammp user:
mkdir -p ~/beammp-server/Resources/Server/Whitelist
nano ~/beammp-server/Resources/Server/Whitelist/main.lualocal allowedPlayers = {
["Player1"] = true,
["Player2"] = true,
}
function checkPlayer(name, role, isGuest, identifiers)
if isGuest or not allowedPlayers[name] then
return "This server is reserved for authorized players."
end
end
MP.RegisterEvent("onPlayerAuth", "checkPlayer")Then exit the beammp user's session and restart the server, because a new plugin is not detected while the server is running:
exit
sudo systemctl restart beammp.serviceThe message Welcome plugin loaded should appear in the logs.
Administration
Sending Commands to the Console
Create a small command to write to the console and display its response:
sudo nano /usr/local/bin/beammp-cmd#!/bin/bash
if [ ! -p /run/beammp.stdin ]; then
echo "The BeamMP server is not running." >&2
exit 1
fi
echo "$*" > /run/beammp.stdin
sleep 1
journalctl -u beammp.service -n 15 --no-pager -o catsudo chmod 755 /usr/local/bin/beammp-cmdYou can then run, for example:
sudo beammp-cmd list
sudo beammp-cmd say Restarting in 5 minutesAvailable Commands
| Command | Description |
|---|---|
help |
Shows help |
list |
Lists connected players |
status |
Shows the server status |
say <message> |
Sends a message to all players |
kick <name> [reason] |
Kicks a player |
version |
Shows the server version |
reloadmods |
Reloads the mods from Resources/Client |
protectmod <file.zip> <true/false> |
Protects a paid or private mod: it is no longer sent to players, who must obtain it themselves |
settings help |
Shows help for viewing or changing settings |
To stop the server, use sudo systemctl stop beammp.service.
Server Update
BeamMP does not update automatically. New versions are announced on the releases page. Check your version with sudo beammp-cmd version.
Download the new version next to the old one:
sudo -iu beammp
cd ~/beammp-server
. /etc/os-release
curl -fL -o BeamMP-Server.new "https://github.com/BeamMP/BeamMP-Server/releases/latest/download/BeamMP-Server.$ID.$VERSION_ID.x86_64"
chmod +x BeamMP-Server.new
exitThen replace the executable and restart:
sudo systemctl stop beammp.service
sudo -u beammp mv /home/beammp/beammp-server/BeamMP-Server.new /home/beammp/beammp-server/BeamMP-Server
sudo systemctl start beammp.serviceIf you change Debian or Ubuntu version, repeat this procedure: the executable depends on the distribution.
Automatic Backup
You only need to back up the configuration and the Resources folder.
Backup Script
sudo nano /home/beammp/backup.sh#!/bin/bash
umask 077
BACKUP_DIR="/home/beammp/backups"
SERVER_DIR="/home/beammp/beammp-server"
DATE=$(date +%Y-%m-%d_%H-%M-%S)
mkdir -p "$BACKUP_DIR"
# Back up the configuration, mods and plugins
tar -czf "$BACKUP_DIR/beammp_$DATE.tar.gz" -C "$SERVER_DIR" ServerConfig.toml Resources
# Delete backups older than 7 days
find "$BACKUP_DIR" -name "beammp_*.tar.gz" -mtime +7 -delete
echo "Backup completed: beammp_$DATE.tar.gz"sudo chown beammp:beammp /home/beammp/backup.sh
sudo chmod 700 /home/beammp/backup.shSchedule Backup
sudo crontab -u beammp -eAdd:
# Backup every day at 5 AM
0 5 * * * /home/beammp/backup.shTroubleshooting
Server won't start
Check the logs:
sudo journalctl -u beammp.service -n 100 --no-pagerThe /home/beammp/beammp-server/Server.log file contains the same information and does not contain your AuthKey. It is useful for asking the BeamMP community for help.
| Message | Cause and solution |
|---|---|
No AuthKey specified |
The key is missing from ServerConfig.toml |
AuthKey specified is the wrong length |
The key is incomplete or was copied incorrectly |
Backend REFUSED the auth key |
The key is refused by BeamMP: check it on the Keymaster, or check that it is not already used by another server |
Error parsing config file value |
Syntax error, often missing quotes, or unreadable file: check that its owner is beammp |
bind() failed: Address already in use |
Another program is already using the port: identify it with sudo ss -tulpn | grep 30814 |
If ServerConfig.toml no longer belongs to beammp, fix its permissions:
sudo chown beammp:beammp /home/beammp/beammp-server/ServerConfig.toml
sudo chmod 600 /home/beammp/beammp-server/ServerConfig.tomlGLIBC_ or cannot execute binary file Error
The executable does not match your system. Check your version with cat /etc/os-release, then download the appropriate file again. The executables offered in this guide target x86_64 processors.
Players can't connect
Error codes 10060, 10061 or 10030 on the player side most often indicate that the server is unreachable or that the address entered is wrong.
- Check that the service is active:
sudo systemctl status beammp.service - Check that the port is listening on TCP and UDP:
sudo ss -tulpn | grep 30814 - Check the firewall rules, for both protocols
- Check that the player is using the server's IPv4 address
- VPNs such as Hamachi or RadminVPN are not supported
Server doesn't appear in the list
- Check that
Private = false - Look for
Authenticated!orBackend REFUSED the auth keyin the logs - In the game, disable the filters and set the map to Any
Connection blocked after adding a mod
A mod is probably incompatible, damaged or in conflict with another one. Remove the mods one by one from Resources/Client, restarting the server each time, to find the culprit.
Map doesn't load
- Check the path in
Map, which must end with/info.json - For a modded map, check that its
.zipis inResources/Client
The BeamMP server is not running with beammp-cmd
The console channel only exists while the service is running. Start it with sudo systemctl start beammp.service.
An AuthKey Has Been Exposed
If your key has leaked, BeamMP says to open an Account Support ticket on its official Discord.