> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mrerrorx.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Install PrimaxBattleRoyaleX on Your Minecraft Server

> Step-by-step guide to installing PrimaxBattleRoyaleX on a Paper 1.21+ Minecraft server, including dependencies and initial location setup.

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

<Steps>
  <Step title="Download the plugin">
    Download `PrimaxBattleRoyaleX-2.0.0.jar` from the plugin's page on [BuiltByBit](https://builtbybit.com/creators/mrerrorx.469854).
  </Step>

  <Step title="Add the jar to your plugins folder">
    Place the downloaded `.jar` file into your server's `plugins/` directory.
  </Step>

  <Step title="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.
  </Step>

  <Step title="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.
  </Step>

  <Step title="Restart your server">
    Perform a full server restart — do not use `/reload`. A clean restart ensures all plugins initialize in the correct order.
  </Step>

  <Step title="Verify the plugin loaded">
    Check your console for startup messages from `PrimaxBattleRoyaleX`. If you see them, the plugin loaded successfully.
  </Step>

  <Step title="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`.
  </Step>

  <Step title="Set the spawn location">
    Join your server and run `/brsetspawn` at the location where players should spawn when entering a match.
  </Step>

  <Step title="Set the lobby location">
    Run `/brsetlobby` at the location where players return after a match ends or while waiting in the queue.
  </Step>

  <Step title="Open the main menu">
    Players can now run `/br` to open the main menu and join any available game mode.
  </Step>
</Steps>

<Tip>
  Install PlaceholderAPI **before** PrimaxBattleRoyaleX so the plugin can automatically register its expansion on startup. If you add PlaceholderAPI afterward, a full restart is required.
</Tip>

## Migrating from v1.x

<Warning>
  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.
</Warning>