Prefixes Plugin

!Banner

All information about this project can be found in our detailed documentation.

The Prefixes Plugin provides comprehensive rank management for chat, tab list and name tag displays. Groups are either defined in the plugin config or read from LuckPerms, and within a SimpleCloud network chat messages and tab list entries can be synced across servers.

Features

• LuckPerms Integration: Use the built-in config groups or let the plugin convert your LuckPerms groups into prefix groups.
• Chat, Tab List & Name Tags: Prefixes, suffixes, colors and display names are applied to chat messages, the tab list and player name tags.
• Cross-Server Sync: Share chat messages and tab list entries between all servers, selected server groups or persistent servers of your network.
• MiniMessage Formats: Prefixes, suffixes, display names and chat formats are fully customizable with placeholder support.
• Supported Server Software: Supports Paper and Forks.
• Quick Setup: Easy installation process for all supported software.

Dependency

For always up-to-date artifacts visit dev artifacts or artifacts.

Note: If you want to use the dev version, you have to use the snapshot repository.

Gradle Kotlin

implementation("app.simplecloud.plugin:prefixes-api:VERSION")

Gradle Groovy

implementation 'app.simplecloud.plugin:prefixes-api:VERSION'

Maven

<dependency>
    <groupId>app.simplecloud.plugin</groupId>
    <artifactId>prefixes-api</artifactId>
    <version>VERSION</version>
</dependency>

Contributing

Contributions to SimpleCloud are welcome and highly appreciated. However, before you jump right into it, we would like you to read our Contribution Guide.

Clone the repository with its pinned Custom Names source before building:

git clone --recurse-submodules https://github.com/simplecloudapp/prefixes-plugin.git
cd prefixes-plugin
bash ./gradlew build

License

This repository is licensed under Apache 2.0.