Skip to main content
This guide walks you through everything you need to get PrimaxBattleRoyaleX running on your server — from downloading the jar and installing dependencies to setting spawn and lobby locations so players can jump into their first match.

​
Requirements

Make sure your environment meets these requirements before you begin:
  • Paper 1.21+
  • BetterTeams (required) — Squad mode will not function without it
  • PlaceholderAPI (optional, but recommended for stats displays in scoreboards and chat)
  • TerraformGenerator (recommended for higher-quality match world generation)

​
Installation

1

Download the plugin

Download PrimaxBattleRoyaleX-2.0.0.jar from the plugin’s page on BuiltByBit.
2

Add the jar to your plugins folder

Place the downloaded .jar file into your server’s plugins/ directory.
3

Install BetterTeams

If BetterTeams is not already installed, download and add it to your plugins/ folder. It is required for Squad mode to work correctly.
4

Install optional dependencies

Optionally, install PlaceholderAPI and TerraformGenerator in the same plugins/ folder. PlaceholderAPI should be installed before BattleRoyaleX for the best results — see the tip below.
5

Restart your server

Perform a full server restart — do not use /reload. A clean restart ensures all plugins initialize in the correct order.
6

Verify the plugin loaded

Check your console for startup messages from PrimaxBattleRoyaleX. If you see them, the plugin loaded successfully.
7

Configure your settings

Navigate to plugins/PrimaxBattleRoyaleX/ on your server and review the generated config files: config.yml, messages.yml, game-settings.yml, world-settings.yml, and data.yml.
8

Set the spawn location

Join your server and run /brsetspawn at the location where players should spawn when entering a match.
9

Set the lobby location

Run /brsetlobby at the location where players return after a match ends or while waiting in the queue.
10

Open the main menu

Players can now run /br to open the main menu and join any available game mode.
Install PlaceholderAPI before PrimaxBattleRoyaleX so the plugin can automatically register its expansion on startup. If you add PlaceholderAPI afterward, a full restart is required.

​
Migrating from v1.x

PrimaxBattleRoyaleX v2.0 is NOT backwards compatible with v1.x. Your old configuration files cannot be reused directly. Follow these steps to migrate safely:
  1. Back up your data.yml file from plugins/PrimaxBattleRoyaleX/ before making any changes — this file contains player statistics.
  2. Remove the v1.x jar from your plugins/ folder.
  3. Install the v2.0.0 jar as described in the steps above.
  4. Reconfigure all settings from scratch using the newly generated config files — do not copy settings from v1.x configs, as the structure has changed.