You can host a Broke Protocol server with ZapX on your own VPS. Broke Protocol is not (yet) available in the Game Server Installer, so you’ll need to set up the server manually. The developer provides the server files on their website for both Windows and Linux. This guide explains what you need, how to install and start the server, and which ports to open.
| Requirement | Broke Protocol |
|---|---|
| Operating system | Windows Server or Linux (64-bit), such as Debian or Ubuntu |
| Memory | About 3 to 4 GB (developer’s recommendation) |
| Server files | Download from brokeprotocol.com |
| Access | Windows: Remote Desktop · Linux: SSH |
Broke Protocol is not (yet) available in the Game Server Installer, so you’ll need to install the server yourself. To use a different operating system, install another template under Settings > Reinstallation. This deletes all data on your VPS. For details, see Server Reinstallation.
- Connect to your VPS using Remote Desktop.
- Download the Windows package
game.zipfrom brokeprotocol.com and extract it, for example, toC:\GameServers\brokeprotocol.
- Connect to your VPS using SSH.
- Download Linux Server x64 (
game.tar.gz) from brokeprotocol.com and extract it to a dedicated folder. - Install
screen, which is required by the startup script:sudo apt-get install screen.
On Windows, start the server by running Server.bat in the server folder. On Linux, run ./start.sh.
The first time a map starts, the server generates a NavMesh. This takes about 5 to 10 minutes. After that, it uses a cache and starts much faster.
To have the server start automatically after your VPS restarts, create a task in Task Scheduler on Windows that runs Server.bat at system startup. On Linux, you can use a systemd service or a cron entry with @reboot.
The settings are stored in several files in the server folder. Stop the server before editing them, then restart it afterward.
| File | Contents |
|---|---|
settings.json | Basic settings such as ServerName, player slots (Players), port, Whitelist, and restart interval (timeLimit) |
server_info.txt | Information about your server for players |
announcements.txt | Announcements on the server |
groups.json | Groups and permissions |
To become an admin, add your player name under Members in the owner group in groups.json. Setting "Whitelist": true in settings.json allows only players listed in whitelist.txt to join the server.
Updates are not installed automatically. After a game update, download the new version from brokeprotocol.com, back up your configuration files, and replace the other server files. Otherwise, players with a newer game version won’t be able to connect.
| Port | Protocol | Use |
|---|---|---|
| 5557 | UDP | Game (value of port in settings.json) |
| 5558 | UDP | Query |
Open the ports in your operating system’s firewall: on Windows, use the Windows Firewall (Manage Windows Defender Firewall rules); on Linux, follow the instructions in Configure a Linux firewall, for example. Also open them in the ZapX dashboard under the Network Firewall tab for your VPS. Allow pings (ICMP) as well, or the server list won’t show a ping for your server.
Back up the server folder regularly, especially settings.json, groups.json, and your text files. Your entire VPS is also backed up automatically every day. With an active ZapX Pass, you can restore these backups yourself and create your own. Learn more in Daily backups, restores, and blocked actions.
Find the official guide on brokeprotocol.com, and details about all settings in the official wiki on GitHub.
Your Broke Protocol server is now running on your VPS. If everything is set up correctly, it will appear in the server list with a “+”. To learn how to connect, see Broke Protocol: Connect to the server. If you have questions or need help, our support team is here for you every day! 🙂