# Commands

## BattlePass Plugin Commands Guide

### Overview

This guide provides detailed explanations of the commands available in the BattlePass plugin, divided into Admin and Player commands. Additionally, information on customizing command aliases is included.

### Admin Commands

Admin commands require specific permissions to execute. They are essential for managing the BattlePass experience for players.

### Console Commands

* **Add Experience**: `/battlepassadmin add <playerName> <exp>`
  * *Description*: Adds experience points to a player's BattlePass.
  * *Usage*: This command is usable from the console.

### Player admin Commands

Player commands related to BattlePass administration require the `albattlepass.admin` permission.

* **Add Experience**: `/battlepassadmin add <playerName> <exp>`
  * *Description*: Adds experience points to a player's BattlePass.
* **Reload Messages**: `/battlepassadmin reload`
  * *Description*: Reloads the `messages.yml` file.
* **Open Editor**: `/battlepassadmin editor`
  * *Description*: Opens the in-game BattlePass editor.
* **Help**: `/battlepassadmin help`
  * *Description*: Displays a list of available admin commands.
* **Report**: `/battlepassadmin report`
  * *Description*: Provides information useful for developers, aiding in diagnostics and troubleshooting.

### Player Commands

Regular player commands for interacting with BattlePass.

* **Help**: `/battlepass help`
  * *Description*: Shows a list of available player commands.
* **Rewards GUI**: `/battlepass rewards`
  * *Description*: Opens the BattlePass rewards graphical interface.
* **Personal Info**: `/battlepass info`
  * *Description*: Displays information about your own BattlePass.
* **Others' Info**: `/battlepass info <playerName>`
  * *Description*: Displays information about another player's BattlePass.
  * *Permission Required*: `anotherlevel.battlepass.info.other`

### Command Aliases

Customize command aliases through the `config.yml` file. This feature is particularly useful for servers using Paper: [Download Paper](https://papermc.io/downloads/paper).

#### Example Aliases

```yaml
# Paper aliases, you can change it if you
# are using Paper: https://papermc.io/downloads/paper
aliases:
  - pp
  - ppass
  - pass
  - passbattaglia
  - bp
```