Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/window5000/suffixchanger

Paper plugin to change LuckPerms suffixes via a GUI.
https://github.com/window5000/suffixchanger

luckperms minecraft minecraft-plugin paper-plugin papermc

Last synced: about 1 month ago
JSON representation

Paper plugin to change LuckPerms suffixes via a GUI.

Host: GitHub
URL: https://github.com/window5000/suffixchanger
Owner: Window5000
License: gpl-2.0
Created: 2024-03-16T08:48:04.000Z (8 months ago)
Default Branch: master
Last Pushed: 2024-09-29T14:28:26.000Z (about 2 months ago)
Last Synced: 2024-10-11T03:41:00.303Z (about 1 month ago)
Topics: luckperms, minecraft, minecraft-plugin, paper-plugin, papermc
Language: Kotlin
Homepage: https://hangar.papermc.io/Window5/SuffixChanger
Size: 91.8 KB
Stars: 2
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        


  [](https://modrinth.com/plugin/suffixchanger)



# SuffixChanger

[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)

Paper plugin to change LuckPerms suffixes via a GUI.

## Table of Contents

- [Install](#install)

- [Usage](#usage)

- [Configuration](#configuration)

- [Contributing](#contributing)

- [License](#license)

# Install

[Download the plugin](https://github.com/Window5000/SuffixChanger/releases/latest) and add it to your ``plugins`` folder.

## Dependencies

This plugin obviously requires [LuckPerms](https://luckperms.net/download) to function.

For suffixes to show in chat you need another plugin to format the chat, for a simplistic formatter you can use [Vault](https://www.spigotmc.org/resources/vault.34315) and [VaultChatFormatter](https://www.spigotmc.org/resources/vaultchatformatter.49016)

# Usage

Create a group for each of your suffixes, then add them all to a track called ``suffixes``. Before players can change their suffix, you need to give them the permissions ``suffix.[group name of suffix]`` of every suffix they're allowed to use.

## Commands:

- ``/suffix`` Open the SuffixChanger GUI

- ``/reloadsuffixchanger`` Reloads the SuffixChanger config

- ``/addsuffix  `` Add a group with the specified suffix to luckperms

## Permissions:

  - ``suffix.[group name of suffix]`` for every suffix the player is allowed to use

  - ``suffixchanger.suffix`` to open the GUI

  - ``suffixchanger.addsuffix`` to add suffixes via a command

  - ``suffixchanger.reload`` to reload the SuffixChanger config

# Configuration

  - ``title`` changes the title that is used for the GUI, supports [MiniMessage](https://docs.advntr.dev/minimessage/format.html)

  - ``watermark`` set to false to disable the watermark under the leftover buttons

  - ``obfuscate`` set to true to obfuscate suffixes that the players isn't allowed to use

# Contributing

PRs accepted.

Small note: If editing the Readme, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.

# License

[GNU GPL](LICENSE) © Window5