> ## 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 Commands and Permissions Reference

> Full reference for PrimaxBattleRoyaleX commands and permissions, including player commands, admin commands, and LuckPerms setup examples.

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

PrimaxBattleRoyaleX uses a small set of commands and a simple permissions system. Most player commands are granted by default; only admin commands require explicit permission.

## Player Commands

These commands are available to all players on your server by default and require no additional configuration.

| Command  | Description                                             | Default Permission                          |
| -------- | ------------------------------------------------------- | ------------------------------------------- |
| `/br`    | Opens the main Battle Royale menu to queue for any mode | `battleroyale.menu` (default: all players)  |
| `/leave` | Leave your current match and return to the lobby        | `battleroyale.leave` (default: all players) |
| `/spawn` | Teleport to the configured spawn point                  | No permission required                      |

## Admin Commands

These commands are restricted to server operators (or any player explicitly granted `battleroyale.admin`) and are used to configure server locations.

| Command       | Description                                                     | Permission           |
| ------------- | --------------------------------------------------------------- | -------------------- |
| `/brsetspawn` | Stand at the desired spawn point and run this command to set it | `battleroyale.admin` |
| `/brsetlobby` | Stand at the desired lobby point and run this command to set it | `battleroyale.admin` |

## Permissions Reference

Below is a complete list of all permission nodes provided by PrimaxBattleRoyaleX.

| Permission Node      | Description                                  | Default     |
| -------------------- | -------------------------------------------- | ----------- |
| `battleroyale.*`     | Grants all PrimaxBattleRoyaleX permissions   | OP only     |
| `battleroyale.menu`  | Allows opening the `/br` main menu           | All players |
| `battleroyale.leave` | Allows leaving a match with `/leave`         | All players |
| `battleroyale.admin` | Allows using `/brsetspawn` and `/brsetlobby` | OP only     |

## Setting Up Permissions

PrimaxBattleRoyaleX is compatible with any Bukkit-compatible permissions plugin, including [LuckPerms](https://luckperms.net/) and PermissionsEx.

### Granting a Permission

To grant `battleroyale.admin` to a staff rank using LuckPerms, run:

```bash theme={null}
/lp group staff permission set battleroyale.admin true
```

### Revoking a Permission

To explicitly revoke `battleroyale.leave` from a group (for example, to prevent a guest rank from leaving matches):

```bash theme={null}
/lp group default permission set battleroyale.leave false
```

### Default Permissions

`battleroyale.menu` and `battleroyale.leave` are granted to **all players by default**. You only need to explicitly grant them if your server uses a permissions plugin that revokes default permissions globally.

<Tip>
  Grant `battleroyale.admin` only to trusted staff members. This permission allows changing the server's spawn and lobby locations, which affects all players on the server.
</Tip>