Ranks

Module info
Configuration	ranks.yml
Manager	RankManager
Support	1.8+
Free version	✔
Proxy-configurable	❌

ChatPlugin presents an integrated rank system which offers custom name tags and is used to add features to other modules, like the tablist. Every rank is composed of:

• a prefix ("&9[Founder] ") which may be displayed in chat messages
• a suffix (" &4[**]") which may be displayed in chat messages
• a tag, composed of a prefix, a suffix and a name color ("&9[F] &6Remigio07_ &4[**]"), which may be displayed in tablist
• a chat color which will colorize messages sent by that rank's members
• a description which may be displayed when hovering a member's rank
• max /tempban and /mute durations, for Staff members only

Default configuration (ranks.yml in 1.8+)

ranks:
  settings:
    luckperms-mode: false
    sorting:
      enabled: true
      from-tablist-top: true
  default:
    display-name: User
    prefix: '&8[&f&lUser&8] '
    suffix: ''
    tag:
      prefix: ''
      suffix: ''
      name-color: ''
	chat-color: ''
    descriptions:
      english: |-
        &aRank: &f&lUser
        &aType: &fdefault
      italian: |-
        &aRank: &f&lUser
        &aTipo: &fpredefinito
  vip:
    display-name: VIP
    prefix: '&8[&d&lVIP&8] '
    suffix: ' &a[*]'
    tag:
      prefix: '&8[&d&lV&8] '
      suffix: ' &a[*]'
      name-color: ''
	chat-color: ''
    descriptions:
      english: |-
        &aRank: &d&lVIP
        &aType: &fpaid &o($4.99)
      italian: |-
        &aRank: &d&lVIP
        &aTipo: &fpagato &o($4.99)
  staff:
    display-name: Staff
    prefix: '&8[&b&lStaff&8] '
    suffix: ' &4[*]'
    tag:
      prefix: '&8[&b&lS&8] '
      suffix: ' &4[*]'
      name-color: ''
    chat-color: ''
    descriptions:
      english: |-
        &aRank: &b&lStaff
        &aType: &fadmin.
      italian: |-
        &aRank: &b&lStaff
        &aTipo: &famministr.
    max-punishment-durations:
      ban: 14d
      mute: 12h

Setup

The following snippet of code represents and explains the ranks' configuration.

ranks: 
  settings:
    luckperms-mode: false # read below
    sorting:
      enabled: true # whether to sort ranks in the tablist
      from-tablist-top: true # whether to sort ranks from the tablist's top or bottom
  # ...default ranks...

LuckPerms mode

If LuckPerms is installed and the LuckPerms mode is enabled, ChatPlugin will create a rank for each valid group loaded by LuckPerms. Ranks will be assigned to players based on their most weighted (highest) group or the default group when they do not inherit from any group.

Adding ranks

It is recommended to use LuckPerm's Web Editor to add/remove ranks (/luckperms editor).

Default mode

If the LuckPerms mode is disabled, ranks will be read from ranks.yml, where they should follow this order:

1. default rank always in first position
2. less important ranks
3. more important ranks

Every rank - except the first one - requires the chatplugin.ranks.rank-id permission, where rank-id is the rank's ID. The "staff" rank, for example, will require the chatplugin.ranks.staff permission.

Adding ranks

Choose your preferred method for adding ranks based on your familiarity with YAML configurations.

In-game (easy mode, slower)

It is possible to use the /rank add <ID> <position> [display name] command to easily create ranks in-game. If the 3 default ranks are loaded, you will be able to specify a position between 0 and 3:

0. use 0 to make it the first/default rank

• default

1. use 1 to put it between default and vip

• vip

2. use 2 to put it between vip and staff

• staff

3. use 3 to make it the last/most important rank

Once you have successfully created a rank, you can start editing its properties using /rank edit. Note that /rank edit <ID> descriptions.<language ID> supports multi line strings separated by \n.

From ranks.yml (advanced mode, faster)

To add a new rank, you just need to specify its ID. Other properties are optional, most will default to an empty string if not specified. The ID has to respect the following pattern: ^(?!settings$)[a-zA-Z0-9-_+]{2,36}$. The (?!settings$) part simply means that you cannot use "settings" as a rank's ID.

  # ...ranks' settings...
  # ...default ranks...
  new-rank: # ID - required
    display-name: Mod
    prefix: '&8[&3&lMod&8] '
    suffix: ' &4[*]'
    tag:
      prefix: '&8[&3&lM&8] '
      suffix: ' &4[*]'
      name-color: ''
    chat-color: ''
    descriptions:
      english: |-
        &aRank: &3&lMod
        &aType: &fadmin.
      italian: |-
        &aRank: &3&lMod
        &aTipo: &famministr.
    max-punishment-durations:
      ban: 1M
      mute: 1d

Note that the descriptions support multi line strings.

Refer to the Getting started/Syntax/Timestamps page to find out the timestamps specifiable at ban and mute.

Ads

Every ad can be set up so that it will not show up to certain ranks. This is useful for example if you want to hide your store's ad to whoever decides to donate to the server.

Placeholders

Every player's rank has a set of placeholders available which are described here.

Commands

/rank command

It is possible to create, remove, edit and view loaded ranks using the /rank command:

Refer to the Getting started/Commands/Admin page for more info.

/rankinfo command

It is possible to check a player's rank using the /rankinfo command:

Refer to the Getting started/Commands/User page for more info.

---

ChatPlugin - A complete yet lightweight plugin which handles just too many features!
© 2025  Remigio07

This wiki is currently updated to version 1.10.0.
Please report any mistakes and misspellings as described at Home/Reporting issues.