SupportPac

# SupportPac !(https://img.shields.io/badge/License-MIT-yellow.svg) !(https://img.shields.io/badge/Paper-1.21+-green.svg) !(https://img.shields.io/badge/Java-21-blue.svg) (https://github.com/PacHub228/SupportPac/blob/main/READMERU.md) A lightweight and flexible Minecraft plugin for Paper (1.21+) that allows server staff (helpers, moderators, admins) to toggle their support status on and off. The plugin integrates directly with **LuckPerms** to switch player groups dynamically. ## Features - **Toggle Support Mode**: Easily switch between an active support role (e.g., `helperon`) and an inactive role (e.g., `helperoff`) with a single command. - **LuckPerms Integration**: The plugin uses LuckPerms commands to instantly update player groups. - **Permission-Based**: Fully relies on permissions to determine which groups a player can toggle, eliminating the need for hardcoded player names in the config. - **Multi-language Support**: Built-in localization support (`en`, `ru`, `uk`, `be`). - **Player Inspection**: Includes a quick `/sp check` command to view detailed player information. ## Prerequisites - Server software: **Paper 1.21+** (or forks). - Required plugin: **LuckPerms** (for group management). ## Commands - `/sp on ` - Enable support mode for a specific group. If `` is omitted, the plugin will auto-detect the first available group based on your permissions. - `/sp off ` - Disable support mode for a specific group. - `/sp help` - Show the help message. - `/sp check <player>` - View detailed information about a player (UUID, IP, World, Coordinates, Health, Gamemode). - `/sp reload` - Reload the plugin's configuration and messages. ## Permissions - `supportpac.use` - Required to use the base `/sp` command. - `supportpac.check` - Allows the use of `/sp check`. - `supportpac.reload` - Allows reloading the plugin with `/sp reload`. - `sp.<group>.on` - Allows a player to switch to the `on` state for a specific `<group>`. - `sp.<group>.off` - Allows a player to switch to the `off` state for a specific `<group>`. *Example: To allow a player to fully use the `helper` group toggle, grant them `supportpac.use`, `sp.helper.on`, and `sp.helper.off`.* ## Configuration (`config.yml`) The configuration file is extremely simple. You only need to define your language and map your plugin groups to your actual LuckPerms groups. ```yaml language: en # Available options: en, ru, uk, be groups: helper: # The internal name of the group used in permissions (sp.helper.on) on: helperon # The LuckPerms group assigned when using /sp on off: helperoff # The LuckPerms group assigned when using /sp off moder: on: moderon off: moderoff ``` ### Important Note on YAML formatting In YAML, the keys `on` and `off` are parsed as boolean values (`true` and `false`). The plugin automatically handles this internally, so you can safely use `on:` and `off:` in your configuration as shown above. ## Setup Guide 1. Drop the `SupportPac.jar` into your `plugins` folder. 2. Restart the server. 3. Configure your groups in `config.yml`. 4. Ensure you have the corresponding groups created in LuckPerms (e.g., `helperon`, `helperoff`). 5. Grant your staff the necessary permissions (e.g., `/lp group helper permission set sp.helper.on true`). 6. Reload the plugin (`/sp reload`) or restart the server. ## Building from source To build the project yourself, you need Java 21 and Maven. Run the following command in the project root: ```bash mvn clean package ``` The compiled JAR will be located in the `target/` directory.