> ## 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.

# PrimaxBattleRoyaleX: Battle Royale Plugin for Minecraft

> PrimaxBattleRoyaleX brings Solo, Squad, and Deathmatch Battle Royale to your Minecraft Paper server with full customization and PlaceholderAPI support.

Welcome to the official documentation for **PrimaxBattleRoyaleX v2.0.0** by PrimaxStudios. Whether you're setting up your first Battle Royale server or migrating from an older version, this documentation covers everything you need — from initial installation to advanced configuration, game mode setup, and PlaceholderAPI integration. Get your players dropping in and fighting to be the last one standing in minutes.

<CardGroup cols={2}>
  <Card title="Introduction" icon="book" href="/primaxbattleroyalex/introduction">
    Learn what PrimaxBattleRoyaleX offers, its three game modes, and server requirements.
  </Card>

  <Card title="Installation" icon="download" href="/primaxbattleroyalex/installation">
    Download the plugin, install dependencies, and get your server ready to run.
  </Card>

  <Card title="Game Modes" icon="gamepad" href="/primaxbattleroyalex/game-modes/solo">
    Explore Solo Battle Royale, Squad Battle Royale, and Deathmatch.
  </Card>

  <Card title="Configuration" icon="gear" href="/primaxbattleroyalex/configuration/overview">
    Customize config files, messages, timers, borders, and more.
  </Card>

  <Card title="Commands & Permissions" icon="terminal" href="/primaxbattleroyalex/commands-permissions">
    Full reference for all player and admin commands and permission nodes.
  </Card>

  <Card title="PlaceholderAPI" icon="puzzle-piece" href="/primaxbattleroyalex/integrations/placeholderapi">
    Use 20+ stat placeholders in scoreboards, tab lists, and chat.
  </Card>
</CardGroup>

## Get Up and Running

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

  <Step title="Install Dependencies">
    Install **BetterTeams** (required). Optionally install **PlaceholderAPI** for stat placeholders and **TerraformGenerator** for enhanced world generation — both are strongly recommended.
  </Step>

  <Step title="Restart & Configure">
    Perform a full server restart (not `/reload`). Configuration files will be generated in `plugins/PrimaxBattleRoyaleX/`. Edit `config.yml`, `game-settings.yml`, and other files to suit your server.
  </Step>

  <Step title="Set Locations & Go Live">
    Stand at your desired spawn point and run `/brsetspawn`, then move to your lobby area and run `/brsetlobby`. Players can now open the main menu with `/br` and start queuing for matches.
  </Step>
</Steps>

<Note>
  PrimaxBattleRoyaleX requires **Paper 1.21 or newer**. Spigot and CraftBukkit are not supported and the plugin will not function correctly on those platforms.
</Note>