LuckPrefix

LuckPrefix is a modern, minimalistic Minecraft plugin for managing and displaying player prefixes and groups. Designed for clarity and flexibility, it allows you to set custom prefixes, suffixes, name colors, and display formats through a simple YAML configuration.

---

Features

• Group-based Prefixes – Easily assign and manage group prefixes for players.
• Customizable Formatting – Define your own prefix, suffix, name color, and display formats for each group.
• Gradient & Hex Support – Use MiniMessage gradients and custom hex codes for prefix styles.
• Sort Order System – Control group order via sortID (lower number = higher priority).
• MiniMessage Format – Use MiniMessage for advanced color, gradients, and style customization.
• Lightweight – Minimal performance impact and easy to maintain.
• Straightforward Configuration – All group settings in one clear file.

---

Installation

1. Download LuckPrefix.
2. Place the LuckPrefix.jar file into your server’s plugins directory.
3. Restart or reload your server.

---

Configuration

LuckPrefix uses a groups.yml file in its data folder for group definitions.

Example groups.yml

groups:
  admin:
    prefix: '<gradient:#ff4444:#ff7700>[Admin]</gradient>'
    suffix: ''
    namecolor: 'RED'
    sortID: 1
    tabformat: '<prefix><player><suffix>'
    chatformat: '<prefix><player><suffix> <gray>»</gray> <message>'

  moderator:
    prefix: '<aqua>[Mod]</aqua>'
    suffix: ''
    namecolor: 'AQUA'
    sortID: 2
    tabformat: '<prefix><player><suffix>'
    chatformat: '<prefix><player><suffix> <gray>»</gray> <message>'

  vip:
    prefix: '<gradient:#ffd700:#fff700>[VIP]</gradient>'
    suffix: ''
    namecolor: 'GRAY'
    sortID: 3
    tabformat: '<prefix><player><suffix>'
    chatformat: '<prefix><player><suffix> <gray>»</gray> <message>'

  customhex:
    prefix: '<#33ccff>[HexTag]</#33ccff>'
    suffix: ''
    namecolor: 'GRAY'
    sortID: 10
    tabformat: '<prefix><player><suffix>'
    chatformat: '<prefix><player><suffix> <gray>»</gray> <message>'

  default:
    prefix: '<white>[Player]</white>'
    suffix: ''
    namecolor: 'WHITE'
    sortID: 100
    tabformat: '<prefix><player><suffix>'
    chatformat: '<prefix><player><suffix> <gray>»</gray> <message>'

Placeholders

• <prefix>: Replaced with the group prefix (MiniMessage formatted, supports gradients and hex).
• <suffix>: Replaced with the group suffix.
• <player>: The player's name, colored using namecolor (MiniMessage).
• <message>: The player's chat message (for chatformat only).

Other keys

• namecolor: MiniMessage color or hex code for the player's name (e.g., <red>, <#33ccff>, <gradient:#ffd700:#fff700>).
• sortID: Lower numbers mean higher priority. A group with sortID: 1 is chosen over one with sortID: 100 if a player is in both.

---

Contributing

Contributions are welcome. Please open issues or pull requests on GitHub.

---

License

LuckPrefix is licensed under the MIT License.