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 has different settings:

• 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

To assign a rank to a player, ChatPlugin checks if they have the permission required by the first rank specified in the file, if so it goes on checking other ranks' permissions until it finds their highest rank and applies it.

Default configuration (ranks.yml in 1.8+)

ranks:
  settings:
    default-rank-id: user
    permission-format: chatplugin.ranks.{0}
    sorting:
      enabled: true
      from-tablist-top: true
  user:
    display-name: User
    prefix: '&8[&f&lUser&8] &f'
    suffix: ''
    tag:
      prefix: ''
      suffix: ''
      name-color: ''
    descriptions:
      english: |-
        &aRank: &f&lUser
        &aType: &fdefault
      italian: |-
        &aRank: &f&lUser
        &aTipo: &fpredefinito
  vip:
    display-name: VIP
    prefix: '&8[&d&lVIP&8] &f'
    suffix: ' &a[*]'
    tag:
      prefix: '&8[&d&lV&8] &f'
      suffix: ' &a[*]'
      name-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] &f'
    suffix: ' &4[*]'
    tag:
      prefix: '&8[&b&lS&8] &f'
      suffix: ' &4[*]'
      name-color: '&f'
    chat-color: '&f'
    descriptions:
      english: |-
        &aRank: &b&lStaff
        &aType: &fadmin.
      italian: |-
        &aRank: &b&lStaff
        &aTipo: &famministr.
    max-punishment-duration:
      ban: 14d
      mute: 14d

Setup

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

ranks: 
  settings:
    default-rank-id: user # read below
    permission-format: chatplugin.ranks.{0} # format used to check ranks' permissions
    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...

Players who do not have the permission for any rank will receive the rank whose ID is specified at default-rank-id.

Adding ranks

To add a new rank, you just need to specify its ID and its descriptions. Note that they support multi line strings. Other properties are optional and will default to an empty string if not specified. The ID has to respect the following pattern: ^[a-zA-Z0-9-_]{2,14}$.

  # ...ranks' settings...
  # ...default ranks...
  new-rank: # ID - required
    display-name: Mod
    prefix: '&8[&3&lMod&8] &f'
    suffix: ' &4[*]'
    tag:
      prefix: '&8[&3&lM&8] &f'
      suffix: ' &4[*]'
      name-color: '&f'
    chat-color: '&f'
    descriptions:
      english: |- # main language's translation - required
        &aRank: &3&lMod
        &aType: &fadmin.
      italian: |- # other language's translation - optional
        &aRank: &3&lMod
        &aTipo: &famministr.
    max-punishment-duration:
      ban: 30d
      mute: 30d

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

Ads

One of the plugin's features is the ads module. 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 who has already made a donation.

Placeholders

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

/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!
© 2024  Remigio07

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