simply-luckperms

Simply LuckPerms

A plugin designed to easily manage chat, tab and team display using only meta-fields.
It provides a simple and intuitive way to configure player prefixes, suffixes, team colors and more without the need for complex configuration files, just luckperms builtin- and meta-fields.

Required Plugins

- LuckPerms 5.4 (or newer)

Supported platforms and versions

- Paper Versions: 1.21.10 - 26.1.2

Recommended Version: Paper 1.21.11 (or newer)
Although simple-maintenance-plugin may work on other platforms or versions, I do not guarantee for their stability or functionality.

Setup

Prefix Setup

`prefix` *(builtin)* - Sets the holder's global prefix. Supports MiniMessage.

Suffix Setup

`suffix` *(builtin)* - Sets the holder's global suffix. Supports MiniMessage.

Scoreboard Coloring

(1.21.11+)
%%MD1%%
`color-team` *(meta field)* - Sets the holder's global team color (above player color). Limited to %%MD4%%.
Defaults to `WHITE` if not set.

%%MD2%%
%%MD3%%
(1.21.11+) `color-waypoint` *(meta field)* - Sets the holder's %%MD5%% color in the %%MD6%%. Limited to %%MD7%%.
Inherits from `color-team` if not set.

Name Coloring

`color-chat` *(meta field)* - Sets the holder's name color. Supports MiniMessage, Name-Placeholder (%s).
Inherits from `prefix` if not set.

Chat Setup

`color-chat` *(meta field)* - Sets the holder's chat color. Supports MiniMessage, Message-Placeholder (%s).
Defaults to `WHITE` if not set.

`color-chat-rich` *(meta field)* - Sets whether the holder is allowed to use MiniMessage.
Defaults to `false` if not set.

Configuration file

SimplyLuckPerms uses a configuration file to enable/disable features.
If you want to make any changes to the config, create one at `plugins/simply-luckperms/config.json`.
By default, all features are enabled, you can disable them by setting the corresponding option to `false` in the configuration file.

REMOVE COMMENTS BEFORE APPLYING CONFIG

```json { "config": { "_node": { "awaitTick": 5 // The delay (in ticks) to wait after luckperms recalculates the holder's permissions. }, "display": { "chat": { "use": true, // Toggles chat formatting. "format": "%prefix%%username%%suffix%<dark_gray>: %message%" // Format to be parsed in chat. }, "name": { "use": true // Toggles display name formatting. }, "tab": { "use": true, // Toggles playerlist name (tab) formatting. "format": "%prefix%%username%%suffix%" // Format to be parsed in the playerlist (tab). }, "teams": { "use": true // Toggles scoreboard team creation & formatting. }, "waypoints": { "use": true // Toggles waypoint coloring. } }, "scoreboard": { "private": { "use": true // Toggles wether to use a private scoreboard for the holder or the bukkit default. }, "prefix": { "use": true // Toggles wether to display prefixes on scoreboard teams. }, "suffix": { "use": true // Toggles wether to display suffixes on scoreboard teams. } } } } ```

REMOVE COMMENTS BEFORE APPLYING CONFIG

Commands

`/slp-config reload` - Reloads the configuration file. (Permission `slp.config`)

Builtin Fields & Meta Fields

LuckPerm's fields are based on `holders`, which are either players or groups.
The inheritance of a field is ordered by `player` -> `group (descending weight)`, this means a group's prefix can be overridden for a player by setting player's prefix at a higher weight.
This works the same for all builtin fields.

When working with meta-fields, LuckPerms will choose the first field it finds. (`player` -> `group (descending weight)`)
If a player has multiple meta-fields with the same key, a random one will be chosen.

Setup overrides

Overrides can be used to modify specific fields for a holder such as their chat prefix without modifying the global prefix.

Prefix Overrides

`prefix-chat` *(meta field)* - Overrides the holder's chat prefix. Supports MiniMessage.
`prefix-tab` *(meta field)* - Overrides the holder's tab (playerlist) prefix. Supports MiniMessage.
`prefix-team` *(meta field)* - Overrides the holder's scoreboard team prefix. Supports MiniMessage.

Suffix Overrides

`suffix-chat` *(meta field)* - Overrides the holder's chat suffix. Supports MiniMessage.
`suffix-tab` *(meta field)* - Overrides the holder's tab (playerlist) suffix. Supports MiniMessage.
`suffix-team` *(meta field)* - Overrides the holder's scoreboard team suffix. Supports MiniMessage.