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

# BattleRoyaleX Commands and Permissions Full Reference

> Full reference for all PrimaxBattleRoyaleX commands and permissions — including admin setup commands and player-facing menu and leave commands.

BattleRoyaleX has a small, focused set of commands split between everyday player actions and one-time admin setup. Most players only ever need `/br` and `/leave` — the admin commands exist solely to configure spawn and lobby locations when you first install the plugin.

***

## Player Commands

These commands are available to all players by default. No special permissions are needed for `/spawn`, and the remaining two are granted to everyone out of the box.

| Command  | Description                                      | Permission           |
| -------- | ------------------------------------------------ | -------------------- |
| `/br`    | Open the Battle Royale main menu to join matches | `battleroyale.menu`  |
| `/leave` | Leave your current match and return to the lobby | `battleroyale.leave` |
| `/spawn` | Teleport to the configured spawn location        | *(none)*             |

***

## Admin Commands

Admin commands are restricted to operators by default. Use them during initial server setup to define where players land when they join or leave a match.

| Command       | Description                                              | Permission           |
| ------------- | -------------------------------------------------------- | -------------------- |
| `/brsetspawn` | Set the server's spawn location to your current position | `battleroyale.admin` |
| `/brsetlobby` | Set the lobby location to your current position          | `battleroyale.admin` |

***

## Permissions

| Permission           | Description                           | Default |
| -------------------- | ------------------------------------- | ------- |
| `battleroyale.*`     | Grants all BattleRoyaleX permissions  | op      |
| `battleroyale.menu`  | Allows opening the Battle Royale menu | true    |
| `battleroyale.leave` | Allows leaving an active match        | true    |
| `battleroyale.admin` | Allows using admin setup commands     | op      |

<Note>
  `battleroyale.menu` and `battleroyale.leave` are granted to all players by default. You do not need to assign these through a permissions plugin unless you want to restrict them.
</Note>

<Tip>
  Before opening your server to players, run both `/brsetspawn` and `/brsetlobby` while standing at the correct locations. BattleRoyaleX will not function correctly until both locations are set.
</Tip>
