ranks.yml
In the ranks.yml, which is located under plugins/SlimeRanks/, are the ranks of your server stored. So if you want to configure them manually, you're right here.
Now I will explain what the structure of this configuration is and what every key does.
💾 The default ranks.yml
ConfigVersion: 1
Ranks:
Admin:
Tab:
Active: true
Format: <color:#e63946>Admin</color> <dark_gray>|</dark_gray> <gray>{player}</gray>
Priority: 2
Chat:
Active: true
Format: <color:#e63946>Admin</color> <dark_gray>|</dark_gray> <gray>{player}</gray>
<dark_gray>»</dark_gray> <color:#ededed>{message}</color>
ColoredMessages: true
NameTag:
Active: true
Format: <color:#e63946>Admin</color> <dark_gray>|</dark_gray> <gray>{player}</gray>
HideOnSneak: false
RankPriority: 1
Permission: slimeranks.rank.admin
Player:
Tab:
Active: true
Format: <color:#b0b0b0>Player</color> <dark_gray>|</dark_gray> <gray>{player}</gray>
Priority: 1
Chat:
Active: true
Format: <color:#b0b0b0>Player</color> <dark_gray>|</dark_gray> <gray>{player}</gray>
<dark_gray>»</dark_gray> <color:#ededed>{message}</color>
ColoredMessages: false
NameTag:
Active: true
Format: <color:#b0b0b0>Player</color> <dark_gray>|</dark_gray> <gray>{player}</gray>
HideOnSneak: false
RankPriority: 0
📃 Every key explained
ConfigVersion
The value of this key is just for internal use. The value should NOT be changed manually!
Ranks.<Identifier>.Tab.Active
This indicator sets whether the player name should be displayed with the rank in the tablist.
To activate the feature, set the value to true, to deactivate the feature, use false.
Ranks.<Identifier>.Tab.Format
This is the format that will be used to display players with that rank in the tablist.
To show the player's name, use the {player} placeholder.
The format should be written in the MiniMessage format. I recommend using the MiniMessage Viewer.
Ranks.<Identifier>.Tab.Priority
This represents the weight for the tablist sorting. The higher the number, the higher players with the rank will be displayed in the tablist.
To deactivate the tablist sorting, simply set the value to 0.
Ranks.<Identifier>.Chat.Active
This indicator determines if the messages of players with this rank should be displayed in the specified format.
To activate the feature, set the value to true, to deactivate the feature, use false.
Ranks.<Identifier>.Chat.Format
This is the format that will be used to display players with that rank in the chat.
To show the player's name, use the {player} placeholder.
To show the player's message, use {message}.
The format should be written in the MiniMessage format. I recommend using the MiniMessage Viewer.
Ranks.<Identifier>.Chat.ColoredMessages
This indicator determines if players with this rank should be allowed to use the MiniMessage format in the chat to make their message prettier with colors and gradients.
Ranks.<Identifier>.NameTag.Active
This indicator determines if the name tag of players with this rank should be displayed in the specified format.
To activate the feature, set the value to true, to deactivate the feature, use false.
Ranks.<Identifier>.NameTag.Format
This is the format that will be used to display the player's name tag.
To show the player's name, use the {player} placeholder.
The format should be written in the MiniMessage format. I recommend using the MiniMessage Viewer.
Ranks.<Identifier>.NameTag.HideOnSneak
This indicator determines if name tags of players with this rank should be completely hidden on sneaking.
To activate the feature, set the value to true, to deactivate the feature, use false.
Rank.<Identifier>.RankPriority
This represents the weight of the rank. When players have multiple ranks, the rank with the highest value will be applied.
Rank.<Identifier>.Permission
This represents the permission that you have to give players that they obtain this rank. This key is completely optional. If you want every player to have this rank by default, just remove the entire line.
⚒️ How to create a rank
If you want to create a rank manually, you have to copy the following snippet, which you have to insert into the ranks.yml at the end of the file.
Make sure that you keep and match to the indentation of the existing ranks.
After you insert the snippet, you can configure the values. To do that, please read the instructions for every key above.
After finishing the configuration, you can run the /slimeranks reload command on the server. Now the ranks should be loaded and can be applied to players.
❓ FAQ
Last updated