SimplePrefixes

# SimplePrefixes <a href="https://wakatime.com/@1f3b44b5-611a-484d-bcdc-b2084eefec1a/projects/qbgzgykwwe"><img src="https://wakatime.com/badge/user/1f3b44b5-611a-484d-bcdc-b2084eefec1a/project/dcbe04ad-7fe2-40a7-9224-5da4400ab0dc.svg" alt="wakatime"></a> A plugin aiming to allow for simple player-selected prefixes that can be used in chat! # Requirements - Paper-based Server (ie: (https://purpurmc.org/)) - This plugin takes advantage of Mini-Message from Paper. - (https://github.com/PlaceholderAPI/PlaceholderAPI) # Features <img src='https://user-images.githubusercontent.com/20095065/215312375-0cb1f307-2eae-43c4-bbf9-2b306bad5952.png' width=30%> <img src='https://user-images.githubusercontent.com/20095065/215312448-666f183a-d6a8-4aa0-a643-6694ff52b670.png' width=30%> <img src='https://github.com/Simplexity-Development/SimplePrefixes/assets/20095065/f6b57b7a-7d2b-4e24-9422-b5ede0cf589e' width=30%> - Player friendly GUI for selecting nicknames. - Does not interact with any other plugins directly. - The plugin uses and hold prefixes in a placeholder, it will not affect permission groups / meta. - Supports PlaceholderAPI Placeholders. - Supports Mini-Message formatting. - Supports multiple types of requirements: `PERMISSION`, `STATISTIC`, `ADVANCEMENT`, `COMPARE_INT` # Placeholders, Commands, and Permissions `%simpleprefixes_prefix%` > Placeholder for the prefix. Use this in your chat plugin. > > Example Usage: `%sp_prefix% %player_displayname% » {message}` `%simpleprefixes_prefix_legacy%` > Placeholder for the prefix. Still takes Mini-Message format in config.yml / prefixes.yml but converts the format to legacy (`&a` / `§a` instead of `<green>`) for other plugins. This is when you need the legacy way to display stuff, like with TAB Plugin. > > This will automatically strip `<hover>` and `<click>` tags. `/sp gui` > Opens a generated GUI that organizes the prefixes by prefix-id. `/sp reset` > Resets your prefix. `/sp set <prefix-id>` > Sets your prefix. `/sp reload` > Reloads the plugin. # Configuration ```yml saving-type: "file" mysql: ip: "localhost:3306" name: prefixes user: username1 pass: badpassword! default-prefix: "<white></white> " prefix-menu-name: "<bold>Prefix Menu</bold>" header: name: "<aqua>Click to Reset Your Prefix</aqua>" lore: material: ENDER_EYE count: 1 custom-model-data: null ``` ## Configuration Settings | Setting | Description | Valid Values | |------------------|---------------------------------------------|---------------------------| | saving-type | What type of saving system should this use? | `PDC`, `FILE`, `MYSQL` | | mysql | MySQL Connection Settings | Valid SQL Connection Info | | default-prefix | Fallback prefix, supports Placeholders. | String | | prefix-menu-name | The name of the prefix menu. | String | | header | Section for Header Item Configuration | *See Below* | ### Saving Types These are the current implementations of the saving types... __PersistentDataContainer (PDC)__ > The plugin will save the prefix ID of the currently equipped prefix on the Player themselves. > This makes the prefix inaccessible while they are offline. > > This was primarily used for initial testing of the plugin but if you don't like file systems for some reason, there. __YML File (FILE)__ > The plugin will save the prefix IDs of all players to a configuration YML file stored alongside the config. > This allows for the prefix to be available while they are offline, but any time a player's prefix is changed, > the plugin saves the prefix. > > This is default. ### Header Configuration The prefix menu header is configurable in multiple ways. ```yaml header: name: "<aqua>Click to Reset Your Prefix</aqua>" lore: material: ENDER_EYE count: 1 custom-model-data: null ``` __Name__ > This is a String representing the item's name. > > Defaults to "Click to Reset Your Prefix". > > Mini-Message and Placeholders are supported. __Lore__ > This is a list of Strings representing each lore line. > > Defaults to an empty list. > > Mini-Message and Placeholders are supported. __Material__ > This is a String representing the Material Enumerated Type from (https://jd.papermc.io/paper/1.20/org/bukkit/Material.html) > > Invalid or missing values defaults to ENDER_EYE (Eye of Ender). __Count__ > This is a String / Integer representing the item stack quantity. > > Invalid or missing values defaults to 1. Do not set to 0. > > Placeholders are supported, so long as they become an int representation. __Custom Model Data__ > This is an integer that represents the custom model data. > > Invalid or missing value leaves the item unchanged. ## Creating Prefixes Prefixes are stored in the `prefixes.ym