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

# Get Started with PrimaxBattleRoyaleX in Minutes

> Configure your first Battle Royale match on a Paper 1.21+ server — set spawn, set lobby, and have players queuing within minutes.

<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 takes you from a fresh install of PrimaxBattleRoyaleX to a fully running server where players can queue for their first match. Before continuing, make sure you have completed the [Installation](/primaxbattleroyalex/primaxbattleroyalex/installation) steps and that the plugin is loaded and showing green in `/plugins`.

<Steps>
  <Step title="Open config.yml">
    The main configuration file is located at `plugins/PrimaxBattleRoyaleX/config.yml`. Open it and verify the following settings before proceeding:

    * Set `debug: false` unless you are actively troubleshooting an issue.
    * Check the `language` field matches your desired locale (default: `en_US`).

    ```yaml config.yml theme={null}
    plugin:
      debug: false
      check-for-updates: true
      language: "en_US"

    locations:
      lobby:    # Set with /brsetlobby
      spawn:    # Set with /brsetspawn
    ```
  </Step>

  <Step title="Set Your Spawn Location">
    Stand at the location you want players to spawn at when they first join the server or respawn outside a match. Then run:

    ```text theme={null}
    /brsetspawn
    ```

    This command requires the `battleroyale.admin` permission (default: op). Your current position and facing direction will be saved as the spawn point.
  </Step>

  <Step title="Set Your Lobby Location">
    Move to the location you want to serve as the main lobby — typically a dedicated hub area where players wait between matches. Then run:

    ```text theme={null}
    /brsetlobby
    ```

    This command also requires the `battleroyale.admin` permission. Players will be sent here after a match ends.
  </Step>

  <Step title="Configure Game Settings">
    Open `plugins/PrimaxBattleRoyaleX/game-settings.yml` to configure each game mode. At minimum, review and set the minimum and maximum player counts for Solo Battle Royale, Squad Battle Royale, and Deathmatch to match your expected player base.
  </Step>

  <Step title="Start Playing">
    That's it! Players can now run `/br` to open the main menu and join a queue for any available game mode. Matches will start automatically once the minimum player threshold is reached.

    <Tip>
      Grant the `battleroyale.menu` and `battleroyale.leave` permissions to all players (e.g. via your permissions plugin on the default group) so everyone can open the menu with `/br` and leave an active match with `/leave` without needing operator status.
    </Tip>
  </Step>
</Steps>

<Info>
  Once your spawn and lobby locations are set, players can immediately start queueing for matches. There is no need to pre-generate or manually set up a world — PrimaxBattleRoyaleX handles world creation automatically when a match begins.
</Info>