Server Configuration
Extra details about configurable options with your service.
Startup Values
Top-Tip
Both Name & Description support decorators, this allows you to change the colour and add font styles to it. View our guide on the topic.
| Name | Description | Example |
|---|---|---|
| Authentication Key | This is required if you want your server to appear on the serverlist, view our guide on obtaining a serverkey | 7ca57fc4-e255-4ec9-bcf4-4da14456c0ba |
| Name | What your server will apear as on the server list. | My Server |
| Description | What your servers subtitle will show on the server list. | Please join my server! |
| Cars | How many cars are allowed on your server at once. | 12 |
| Map | What map will be used when players join. | /levels/gridmap_v2/info.json |
| Max Players | The max player that can join at once. This value can only be modified by upgrading it on your billing panel | |
| Private | Should your server show on the serverlist. You must have a Authentication Key set for this | false |
ServerConfig.toml
| Name | Description | Example |
|---|---|---|
| Port | Reference Only, follow our guide on changing a gameserver port. | 25565 |
| AuthKey | Reference Only, please set via the startup values | 7ca57fc4-e255-4ec9-bcf4-4da14456c0ba |
| AllowGuests | Wether guests are allowed to join the server or not. | true |
| LogChat | Wether chat messages should be shown in the log file. | false |
| Debug | Show more detailed messages regarding the servers operation in console and in the log file. | false |
| IP | Reference Only, IP address is set based on your location, speak to staff to change location. | 127.0.0.1 |
| Private | Reference Only, please set via the startup values | false |
| InformationPacket | Allow unauthenticated clients to get the same info as on the server listing but directly via the server. | false |
| Name | Reference Only, please set via the startup values | My Server |
| Tags | List of tags for searching, view allowed list below. | |
| MaxCars | Reference Only, please set via the startup values | |
| MaxPlayers | Reference Only, please set via the startup values | |
| Map | Reference Only, please set via the startup values | |
| Description | Reference Only, please set via the startup values | |
| ResourceFolder | Used to set where BeamMP server will look for its resources. | /Resources/ |
| UpdateReminderTime | How often BeamMP should remind you of an update. (Any number with s, min, h, d appended is valid) | 30s |
Server Name/Description Decorations
BeamMP provides special symbols to allow users to decorate their server name/description. Apply these symbols before any text you wish to stylise. (eg ^l^4Epic Server Name!, for a bold red title)
| Value | Description |
|---|---|
^r | Reset |
^p | Newline (descriptions only) |
^n | Underline |
^l | Bold |
^m | Strike-through |
^o | Italic |
^0 | Black |
^1 | Blue |
^2 | Green |
^3 | Light blue |
^4 | Red |
^5 | Pink |
^6 | Orange |
^7 | Grey |
^8 | Dark grey |
^9 | Light purple |
^a | Light green |
^b | Light blue |
^c | Dark orange |
^d | Light pink |
^e | Yellow |
^f | White |
List of Allowed Tags
BeamMP provides tags to allow players to search for servers easier.
Multiple tags may be added together by seperating them by commas (eg Freeroam,Racing).
Tags are not case sensitive.
-
Age/Content:
Mature/18+
-
Gameplay Types:
FreeroamRoleplayEconomyTraffic
-
Racing Categories:
RacingRacing:NASCARRacing:TrackRacing:DragRacing:RallyTouge
-
Off-Roading and Challenges:
OffroadCrawlingDakarChallenge
-
Destruction Events:
DerbyArena
-
Weather and Time Conditions:
Snow/IceRainNightWeather
-
Gamemodes:
GamemodeGamemode:RacingGamemode:RallyGamemode:DragGamemode:DerbyGamemode:InfectionGamemode:Cops-RobbersGamemode:DeliveryGamemode:Sumo
-
Community and Events:
ScenariosEventsLeaderboard
-
Mods:
ModdedMod:BeamPaintMod:BeamJoyMod:CEI
-
Languages:
Lang:EnglishLang:RussianLang:FrenchLang:SpanishLang:PortugueseLang:GermanLang:PolishLang:Arabic
-
Other:
VanillaModerated