CmdRankPlus

CmdRankPlus

CmdRankPlus is a Spigot/Paper Minecraft plugin that executes custom commands based on permissions and ranks defined in a configuration file. This plugin is designed to be flexible and easy to configure.

***

✨ Features

- Permission management: Add commands like `/shops` or `/menu` in the `config.yml` file. - Permission management: Associate specific actions with ranks (e.g., `/say {player} shop1`). - Permission management: Use `{player}` and `{rank}` to customize actions. - Permission management: Reload the configuration without restarting the server. - Permission management: Control access to features via LuckPerms or any other permission manager.

***

📂 Installation

1. Download the plugin JAR file from the Releases section. 2. Place the file in your Minecraft server's `plugins` folder. 3. Restart your server to generate the `config.yml` file. 4. Configure commands and ranks in the `config.yml` file.

***

⚙️ Configuration (`config.yml`)

Here's an example configuration:

```yaml commands: shops: rang1: "/shop {player} shop1" rang2: "/shop {player} shop2" rang3: "/shop {player} shop3" menu: rang1: "/menu {player} menu1" rang2: "/menu {player} menu2" rang3: "/menu {player} menu3" ```

Explanations:

- `rangX`: List of trigger commands (e.g., `/shops`, `/menu`). - `rangX`: Specific actions associated with each rank. - `{player}`: Corresponds to the player's username. - `{rank}`: Corresponds to the rank name.

***

🛠️ Commands

Main Commands:

| Command | Description | |------------------------|-----------------------------------------------------------------------------| | `/cmdrankplus reload` | Reloads the configuration (ranks and associated actions). | | `/cmdrankplus help` | Displays a detailed guide on how the plugin works. |

Notes:

- ⚠ Reloading trigger commands: To add new commands like `/shops`, you must restart the Minecraft server.

***

🔑 Permissions

Main Permissions:

| Permission | Description | |------------------------|-----------------------------------------------------------------------------| | `cmdrankplus.reload` | Allows execution of the `/cmdrankplus reload` command. Default for OPs. |

Rank-based permission management:

To associate a user with a rank, add a permission like `cmdrankplus.rangX` via LuckPerms or another permission manager.

Example with LuckPerms: ```bash /lp group <group_name> permission set cmdrankplus.rang1 true ```

***

📝 Usage Examples

1. A player with the `cmdrankplus.rang1` permission executes `/shops`. - The plugin executes the command configured for `rang1`, for example `/shop <player> shop1`.

2. An administrator wants to reload the configuration after modification: - They execute `/cmdrankplus reload`.

***

🛑 Limitations

- New trigger commands (e.g., `/shops`) require a server restart to be detected. - Permissions must be defined in `config.yml` before being used with LuckPerms for auto-completion.

***

📄 License

This project is licensed under the MIT License. See the LICENSE file for more information.