Updating
BeamJoy updates itself. The server checks this project’s GitHub repository for a newer version, tells its owners when there is one, and installs it on request — you do not have to download a zip or copy files unless you want to.
Checking
Section titled “Checking”The first check runs a minute after the server starts, and then every six hours. When a newer version exists, owners are told in chat:
BeamJoy version is available (this server runs current). Type /bjupdate to install it
To look without installing:
/bjupdate checkor, from the server console:
bj update checkInstalling
Section titled “Installing”In chat, as an owner:
/bjupdateOr from the server console:
bj updateThe new version runs after the server restarts. Players receive the new client mod when they next join, which is any time after that restart.
What an update replaces
Section titled “What an update replaces”Exactly three paths:
Resources/Server/BeamJoyServerResources/Server/BeamJoyServerHooksResources/Client/BJ.zip
The previous copies are moved aside into BeamJoyData/update/backup-… rather than deleted, and
if any one of them cannot be moved the whole install is rolled back, so a half-updated server is
not a state you can land in.
BeamJoyData is never touched. Your races, leaderboards, settings, groups and player
records survive every update — see where your data lives.
Channels
Section titled “Channels”Updates come from releases by default. The development branch is available for testing:
/bjupdate channel release/bjupdate channel developmentThe choice is saved in BeamJoyData/update/state.json. On the release channel BeamJoy installs
the newest published release’s BeamJoy-Revived-<version>.zip; on the development channel it
installs the branch’s latest commit whenever that is not the one installed last, building the
client mod from source as it goes.
What has to be present
Section titled “What has to be present”BeamMP’s plugin Lua has no HTTP client, so BeamJoy shells out:
curlfor the GitHub requests. Built into Windows 10 1803 and later; install it from your package manager on Linux.- Unpacking: PowerShell’s built-in zip support on Windows,
unzipon Linux. On the development channel Linux also needszip, because the client mod is built there rather than downloaded.
Each of these runs as a short background job, so the server thread never waits on a download. If a tool is missing, BeamJoy tells whoever asked for the update, and says what to install.
Downloads only ever come from this project’s own repository.
Updating by hand
Section titled “Updating by hand”Nothing stops you doing it the manual way, and it is the same operation: stop the server, unpack
the release over Resources exactly as in install, start again. Keep
BeamJoyData where it is.