How to Configure Your BeamMP Server (ServerConfig.toml)

Complete ServerConfig.toml reference for BeamMP — every setting for server name, map, players, mods, auth key, and more.

All BeamMP server settings live in ServerConfig.toml (TOML format). Auto-generated on first run.

File Structure

ServerConfig.toml
Server.log

Editing

  1. Stop your server
  2. In the XGamingServer Panel, click Files
  3. Open ServerConfig.toml
  4. Edit, save, and start your server

All Settings

Under [General]:

Server Identity

SettingDefaultMax LengthDescription
Name"Test Server"250Server browser display name (supports color codes)
Description"Total Random Beam MP Server"1000Description shown in browser
Tags"Freeroam"100Comma-separated filter tags
Privatetruefalse = listed in public browser

Authentication

SettingDefaultDescription
AuthKey""Required — get from BeamMP Keymaster
AllowGuestsfalseAllow players without BeamMP accounts

Players & Vehicles

SettingDefaultDescription
MaxPlayers10Max concurrent players
MaxCars2Max vehicles per player

Map

SettingDefaultDescription
Map"/levels/gridmap_v2/info.json"Active map path — see Map Guide

Network

SettingDefaultDescription
Port30814Listening port (1024–65535, TCP + UDP)
IP"::"Bind IP address

Other

SettingDefaultDescription
LogChatfalseLog chat messages to Server.log
DebugfalseEnable debug logging
ResourceFolder"Resources"Path to mod directory

Environment Variable Overrides (v3.2.0+)

Settings can be overridden via env vars using the BEAMMP_ prefix:

Env VarOverrides
BEAMMP_AUTH_KEYAuthKey
BEAMMP_MAX_PLAYERSMaxPlayers
BEAMMP_MAPMap
BEAMMP_PORTPort
BEAMMP_NAMEName

Example Config

[General]
AuthKey = "your-key-here"
Name = "^4XGaming ^fBeamMP Server"
Description = "Freeroam with mods! All welcome."
Tags = "Freeroam,Modded,Lang:English"
Map = "/levels/west_coast_usa/info.json"
MaxPlayers = 20
MaxCars = 2
Port = 30814
Private = false
AllowGuests = false
LogChat = true
Debug = false
ResourceFolder = "Resources"

How is this guide?

40% Off — Limited TimeGet your Beammp server todayInstant setup, DDoS protection, and 24/7 support included.
Get a Server

On this page