Configuration

The config.yml file is located at /plugins/PlayerList folder.

Header and footer

Example header and footer:

header:
- <red><bold>First line is red and bold
- <rainbow>Hey look this is rainbow
footer:
- 'This uses MiniPlaceholders to show player ping -> <player_ping>'

Custom name

The option player-list-name can be used to change the name shown in the player list. This is perfect, for example, displaying prefixes and suffixes.

Example custom name:

player-list-name: <luckperms_prefix><player_name>

Sorting

You can sort the player list by defining sorters in the sorters configuration section.

Example sorting configuration:

sorters:
- type: LUCKPERMS
  order: DESCENDING
  criteria: PREFIX_WEIGHT
- type: PLACEHOLDER
  order: ASCENDING
  placeholder: <player_name>
  case-sensitive: false

The example above is a very common setup where you first sort the players by prefix weight and then by the player names.

The order can be either ASCENDING or DESCENDING.

LuckPerms

The LUCKPERMS sorter has 3 different sorters available: PREFIX_WEIGHT, SUFFIX_WEIGHT, GROUP_WEIGHT.

To use the prefix weight in descending order you would do:

sorters:
- type: LUCKPERMS
  order: DESCENDING
  criteria: PREFIX_WEIGHT

Placeholder

The placeholder sorter supports both MiniMessage and PlaceholderAPI placeholders.

MiniPlaceholders example:

sorters:
- type: PLACEHOLDER
  order: ASCENDING
  placeholder: <player_name>
  case-sensitive: false

PlaceholderAPI example:

sorters:
- type: PLACEHOLDER
  order: ASCENDING
  placeholder: %player_name%
  case-sensitive: false