What BeamJoy is
BeamJoy is a plugin for a BeamMP server. You install it once on the server; the people who play on it install nothing.
It turns a BeamMP server from a map everyone drives around into a server with things to do on it — races with recorded times, derbies, hunts, delivery and bus routes, traffic, shared time and weather — and gives whoever runs it the controls to manage players and the map without leaving the game.
The two halves
Section titled “The two halves”BeamJoy ships as two pieces that are installed together and kept in step:
- The server plugin, which runs inside your BeamMP server’s Lua VM. It holds every setting, every recorded time and every player record, and it decides what each player is allowed to do.
- The client mod, a single zip that BeamMP hands to players automatically when they connect. It draws the in-game interface and the heads-up display.
Players never download the client mod themselves and cannot install the wrong version of it: they get whatever your server is serving, each time they join.
What you need
Section titled “What you need”- A BeamMP server you can put files on and restart.
- BeamNG.drive on the machines that will play.
That is the whole list. BeamJoy writes its own databases the first time it starts, needs no external database, and nothing else on the server has to change.
Where to go next
Section titled “Where to go next”Four doors. Pick the one that describes you.
| You want to | Start at |
|---|---|
| Get BeamJoy running | Install on your server, then first boot and ownership. |
| Run a race tonight | Your first race night — end to end, on the 315 races BeamJoy ships with. |
| Know what it does | Every feature, one row — the whole of BeamJoy, and what ships switched on. |
| Fix something | Troubleshooting — by symptom, in the words you would use. |
| See it before you install it | Try the sidebar — the in-game window, rebuilt to click through in your browser. |
If you are playing on someone’s server
Section titled “If you are playing on someone’s server”The main window is where everything happens, and reading the HUD explains every readout you will see while driving. Then the activity you are in: racing and pit stops, derby, hunter and infected, deliveries, bus routes and convoys, or drift and drag. Your own settings are yours alone.
If you are running one
Section titled “If you are running one”Groups and permissions first, then the config window tab by tab, which is the map from the in-game window to the rest: players and moderation, time, weather and the map, traffic, props and safe zones, Discord integration and chat and console commands. Also where your data lives and updating.
If you are building things to play on
Section titled “If you are building things to play on”The race editor is the deepest page in these docs, and share codes move a race between servers. Then arenas for derby, hunter and infected, delivery points and bus lines, and drift zones and drag strips.
Lookup
Section titled “Lookup”Permission reference — all 34 keys. Settings reference — every setting with its default. The plugin API — for writing plugins against BeamJoy. Compatibility — what this release expects.
The source, the releases and the issue tracker are on GitHub. BeamJoy is MIT-licensed and free.