Settings reference
Every server-wide setting BeamJoy has, with the default it ships with. Each row gives the
label as the window spells it and, in code, the key it is stored under in config.json — useful
when you are reading a backup rather than a screen.
Per-race settings are not here: a race carries its own, and they are in Racing and the race editor.
At the top of General
Section titled “At the top of General”| Setting | Key | Default | Meaning |
|---|---|---|---|
| Force-enable BeamJoy HUD | ForceHud |
On | The main window is always open and cannot be closed, for everyone. Off, only staff keep it. |
Two more live at this level with no visible control of their own:
| Key | Default | Meaning |
|---|---|---|
DefaultGroup |
default |
The group a brand-new player lands in. |
AllowWalking |
On | Players may leave the car and walk. |
AllowClientMods |
Off, fixed | Permanently off. The re-scan it enabled caused a severe client stall, so it is no longer a real toggle. |
Race Editor
Section titled “Race Editor”| Setting | Key | Default | Meaning |
|---|---|---|---|
| Restrict editing to authors | RaceAuthorshipRestriction |
Off | On, only staff and a race’s own creator may save or delete it. |
| Only show editable races | RaceEditorShowOnlyEditable |
Off | A display filter on the browse list. Does not change who may do what. |
Freeroam
Section titled “Freeroam”Stored under Freeroam.
| Setting | Key | Default | Meaning |
|---|---|---|---|
| Vehicle collisions | CollisionsMode |
ghosts |
forced always collide · disabled never collide · ghosts respawn protection only. |
| Respawn ghost timeout | RespawnGhostTimeoutEnabled / RespawnGhostTimeout |
On / 10s | How long a car stays ghosted after spawning or resetting. Off, the ghost lasts until the car is clear. |
| Respawn ghost distance | RespawnGhostDistance |
0 m | Extra clearance beyond contact before a ghost may expire. |
| Preserve fuel on reset | PreserveFuelOnReset |
Off | Keeps the fuel level across a reset instead of the game’s own refill. |
| Police chases between players | PlayerPursuits |
On | A police car may start a chase on a player nearby. Players can opt out. |
| Passive races | RaceRuns |
On | Races marked Passive start by being driven through in freeroam. |
| Ghost players outside games | GhostNonRacers |
Off | Everyone not in an activity drives as a ghost. |
| Strict bus stops | StrictBusStops |
Off | A stop also wants the doors open, and kneeling where the bus has it. |
| Teleport delay | TeleportDelay |
30s | Between two self-teleports. |
| Refuel duration | RefuelDuration |
5s | The hold at a station. |
| Repair duration | RepairDuration |
5s | The hold at a garage. |
| Preserve energy on refuel | PreserveEnergyOnRefuel |
On | A garage repair does not also refill the tank. |
| Emergency refuel cooldown | EmergencyRefuelCooldown |
300s | Before the free refuel button works again on the same car. |
Deliveries
Section titled “Deliveries”Stored under Deliveries.
| Setting | Key | Default | Meaning |
|---|---|---|---|
| Shortest route | MinRouteDistance |
500 m | By road, not as the crow flies. |
| Longest route | MaxRouteDistance |
8000 m | |
| Target speed | ReferenceSpeed |
40 km/h | Target time is route length at this average. Beating it adds up to 25% to the score. |
| Jobs per depot | OffersPerDepot |
4 | A taken job is replaced at once. |
| Job rotation | OfferRotation |
5 min | How long an untaken job stays up. |
| Drop-off hold | HoldDuration |
3s | Time inside the zone to deliver. |
| Jobs can run out of time | Timeouts |
On | A job fails past twice its target time. Turning it off also spares jobs already running. |
| Convoy lobby | LobbyDuration |
180s | How long a convoy lobby waits before it leaves. |
Stored under RacePits. The lane’s own speed limit belongs to the race, not here.
| Setting | Key | Default | Meaning |
|---|---|---|---|
| Pit entry speed penalty | EntrySpeedPenalty |
5s | Added for crossing PIT IN above the limit plus tolerance. 0 turns the penalty off; the limiter is always on. |
| Speed tolerance | SpeedTolerance |
5 km/h | How far over is forgiven at the line. |
| Experimental tyre changes | ExperimentalTyres |
Off | Adds a Tyres row to the pit menu, separate from repairs. |
Voting
Section titled “Voting”Stored under Voting.
| Setting | Key | Default | Meaning |
|---|---|---|---|
| Map vote pass threshold | MapVoteThresholdPercent |
51% | Of everyone connected, rounded up, never below 2. |
| Map vote timeout | MapVoteTimeout |
30s | Then it fails. |
| Kick vote pass threshold | KickVoteThresholdPercent |
51% | Of everyone connected except the target, rounded up. |
| Kick vote timeout | KickVoteTimeout |
30s |
Discord
Section titled “Discord”Stored under Discord.Webhooks — a list, empty on a fresh install, of at most ten.
| Per-webhook option | Key | New webhook | Meaning |
|---|---|---|---|
| Name | Name |
— | Yours, for your own benefit. |
| URL | Url |
— | Validated against Discord’s own shape. Secret. |
| Race results | RaceFinishes |
On | Solo times and full standings. |
| Only personal bests and records | RacePBsOnly |
Off | Narrows the above. |
| Map and kick votes | Votes |
On | |
| Players joining and leaving | JoinLeave |
Off | |
| Player chat | Chat |
Off | Every public message. |
| Deliveries | Deliveries |
Off | |
| Hunter rounds | Hunter |
Off | |
| Infected rounds | Infected |
Off | |
| Derbies | Derby |
Off | |
| Bus lines | BusLines |
Off |
The whole subject is Discord integration.
Whitelist
Section titled “Whitelist”| Setting | Key | Default | Meaning |
|---|---|---|---|
| Status | Enabled |
Off | On, only whitelisted players and whitelisted groups get in. |
| Players | PlayerNames |
empty | Exact names, case sensitive. |
Kept in its own file, whitelist.json, not in config.json, and re-read when it changes on
disk — so it can be edited while the server runs. BeamJoy looks for an outside edit every five
seconds, and a name may be at most 64 characters.
Welcome Screen
Section titled “Welcome Screen”Stored under IntroPanel.
| Setting | Key | Default | Meaning |
|---|---|---|---|
| State | enabled |
On | |
| Only once | onlyFirstConnection |
Off | On, it shows on a player’s first connection only. |
| Title | title |
Welcome to your server ! | |
| Content | content |
the ownership instructions | HTML. Takes {player_name}, {server_name} and {players_count}; a literal < is typed <. |
| Image | image |
none | A built-in image, or a root-relative path served from your Resources/Client/ folder. https:// URLs are not supported. |
Stored under Chat.
| Setting | Key | Default | Meaning |
|---|---|---|---|
| Server/Staff tags colour | ServerNameColor |
red | |
| Server messages colour | ServerTextColor |
light red | |
| Event messages colour | EventColor |
green | |
| Broadcasts colour | BroadcastColor |
light blue | |
| Show staff tag | ShowStaffTag |
On | |
| Welcome messages | WelcomeMessage |
per language | Sent to a player when they join. |
Broadcasts
Section titled “Broadcasts”Stored under Broadcasts.
| Setting | Key | Default | Meaning |
|---|---|---|---|
| Status | enabled |
Off | |
| Delay | delay |
120s | Between two messages. |
| Messages | messages |
empty | Each can be written per language. |
Vehicle blacklist
Section titled “Vehicle blacklist”| Setting | Key | Default | Meaning |
|---|---|---|---|
| Models | ModelBlacklist |
empty | Nobody may spawn these. BypassModelBlacklist exempts a group. |
Traffic
Section titled “Traffic”Stored under Traffic.
| Setting | Key | Default | Meaning |
|---|---|---|---|
| Traffic state | enabled |
Off | |
| Veh. amount | amount |
15 | The server-wide target. |
| Max veh./player | maxPerPlayer |
1 | What each player contributes. |
| Models | models |
simple_traffic |
Which vehicles appear. |
| Rarity | weights |
empty | Rare, medium or common, per model. |
| Smart selection | smartSelection |
Off | Weight by popularity and region instead. |
| Parked veh. amount | parkedAmount |
0 | Counted separately from moving traffic. |
| Max parked veh./player | parkedMaxPerPlayer |
1 | |
| Front plate usage | plateFrontUsage |
normal |
|
| Plate shape | plateShape |
eu |
|
| Plate design | plateDesign |
none |
Time & Environment
Section titled “Time & Environment”Not in config.json — the environment has its own file, environment.json. Needs
SetEnvironment.
| Setting | Key | Default | Meaning |
|---|---|---|---|
| Sync time of day | timeSync |
Off | |
| Day and night cycle | dayNightCycle |
Off | Whether the synced clock runs at all. |
| Full day/night cycle | dayLength |
1800s | One whole day and night at normal speed. |
| Day speed | dayScale |
1× | |
| Night speed | nightScale |
2× | Night passes twice as fast as day. |
| Sync weather | weatherSync |
Off | Turning it on shares your current weather. |
| Sync gravity | gravitySync |
Off | |
| Gravity | gravity |
−9.81 | Returns to this when the last staff member leaves. |
| Simulation speed | simSpeed |
1× | Returns to 1× when the last staff member leaves. |
| Paused | simPause |
Off | Lifted on the same condition. |
More on all of it in time, weather and the map.
Core Config
Section titled “Core Config”The server’s own identity, as the server browser sees it. Needs SetCore.
| Setting | Meaning |
|---|---|
| Name | Also the username BeamJoy’s Discord posts use. |
| Preview | The [OFFLINE] suffix shows in favourites when the server is down. |
| Description | |
| Players limit | Staff bypass it. |
| Private | Hides the server from the browser. |
| Debug mode | Developer and verbose logging. |
| Info. Packet | Lets players read the server’s details without joining. |
Where these are stored
Section titled “Where these are stored”config.json holds everything above except the whitelist, which has whitelist.json, and the
environment, which has environment.json. Permissions are in permissions.json. See
where your data lives for the full map and what to back up.
- The config window, tab by tab — the same settings in the order you meet them.
- Permission reference — who can change each of them.
- Racing — the per-race settings that are not on this page.