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

# Install PrimaxBattleRoyaleX on Your Minecraft Server

> Step-by-step guide to download PrimaxBattleRoyaleX, install required dependencies, and prepare your Paper 1.21+ server to run Battle Royale matches.

<Warning>
  **Server requirements:** PrimaxBattleRoyaleX generates a fresh world for every match and deletes it once the match ends. World generation runs on the server's main thread, so a weak CPU or low RAM will cause noticeable lag. A quality managed Minecraft host or a dedicated VPS with a strong single-thread CPU and ample RAM is strongly recommended. Shared or budget hosting is not suitable.
</Warning>

This guide walks you through the complete installation process for PrimaxBattleRoyaleX — from downloading the plugin and its dependencies to verifying that everything is running correctly on your Paper 1.21+ server.

<Steps>
  <Step title="Download the JAR">
    Download `PrimaxBattleRoyaleX-2.0.0.jar` from the official PrimaxStudios source and place it inside your server's `/plugins` folder.
  </Step>

  <Step title="Install BetterTeams (Required)">
    BetterTeams is a **required** dependency used to manage teams in Squad Battle Royale mode. Download it from [SpigotMC](https://www.spigotmc.org) and place the JAR in your server's `/plugins` folder.
  </Step>

  <Step title="Install PlaceholderAPI (Optional)">
    PlaceholderAPI unlocks 20+ stat placeholders for use in scoreboards, tab lists, and chat plugins. While optional, it is strongly recommended for a complete server experience. Download it from the [SpigotMC PlaceholderAPI resource page](https://www.spigotmc.org/resources/placeholderapi.6245/) and place it in `/plugins`.
  </Step>

  <Step title="Install TerraformGenerator (Recommended)">
    TerraformGenerator enhances world generation to produce more visually compelling and gameplay-appropriate Battle Royale maps. Download it from SpigotMC and place the JAR in your `/plugins` folder.

    <Note>
      TerraformGenerator is strongly recommended for the best-looking Battle Royale worlds. Without it, the plugin will still function, but terrain generation will rely on vanilla Minecraft's default world generator.
    </Note>
  </Step>

  <Step title="Restart Your Server">
    Perform a **full server restart** to load PrimaxBattleRoyaleX and all installed dependencies.

    <Warning>
      Do **not** use `/reload` or any reload plugin. Using `/reload` instead of a full restart can cause configuration errors and unstable plugin behaviour. Always restart your server fully when installing or updating plugins.
    </Warning>
  </Step>

  <Step title="Verify Installation">
    Once the server has started, run `/plugins` in-game or in the server console. **PrimaxBattleRoyaleX** should appear highlighted in green, indicating it loaded successfully. If it appears in red, check your server console for error messages — most commonly this means a required dependency is missing or your server version is below Paper 1.21.
  </Step>
</Steps>

## After Installation

On first startup, PrimaxBattleRoyaleX will automatically generate its configuration files in your server's plugin data folder:

```text theme={null}
plugins/
└── PrimaxBattleRoyaleX/
    ├── config.yml
    ├── messages.yml
    ├── game-settings.yml
    ├── world-settings.yml
    └── data.yml
```

Review and customise each file before running your first match. Head to the [Quickstart](/primaxbattleroyalex/primaxbattleroyalex/quickstart) guide to configure your spawn and lobby locations and get players queuing immediately.