Configuration Tutorial
This page is currently being expanded. All examples will use the PEX permissions system which is my permissions system of choice but can be adapted for whatever permissions you are using. I will provide guidance throughout where pex specific information is used. All tutorials are provided as examples of usage and should be adapted for your server as appropriate.
Basic configuration
This is the basic configuration for a simple rank stream that will work with most plugins (slight variations may be required for different permissions plugins particularly in terms of commands that will be executed but I will not this where appropriate). For the basic setup I will propose a simple scenario where new players are in the "default" group, this would rank up to "member" then "supermember". Bellow is an extract from the config of how this will be achieved:
#Defined ranks ranks: #This is a "default" rank that players start with default: #We now define what player require to rankup FROM "default". It is important to note that the plugin matches which group you are ranking up from. requirements: #We want players to have 500 money money: 500 #We don't require them to have any experience health or hunger for this first rankup exp: 0 health: 0 hunger: 0 #Commands to execute when ranking up the player commands: # Adding a user to the group member then removing from their old group in 2 commands - pex user {player} group add member # This should be replaced with the appropriate command to place {player} in the group "member" - pex user {player} group remove {rank} # This should be replace with the appropriate command to remove the user from "default". It is important that they are removed from the group default otherwise next time they execute "/rankup" this rule will match and these commands will be re-executed. The {rank} is the current matched rank: this makes copy and paste easier. # Just a simple message to announce to the server that the player ranked up announcement: "{player} has ranked up from default to member" #This is for players in the "member" group member: #We now define what player require to rankup FROM "default". It is important to note that the plugin matches which group you are ranking up from. requirements: #We want players to have 5000 money as well as 500 exp money: 5000 exp: 500 # The player must have full health and 3/4 hunger when ranking up. Remember these are out of 20. health: 20 hunger: 15 #Commands to execute when ranking up the player commands: # Adding a user to the group member then removing from their old group in 2 commands - pex user {player} group add supermember # This should be replaced with the appropriate command to place {player} in the group "supermember" - pex user {player} group remove {rank} # This should be replace with the appropriate command to remove the user from "member". It is important that they are removed from the group default otherwise next time they execute "/rankup" this rule will match and these commands will be re-executed. The {rank} is the current matched rank: this makes copy and paste easier. # Just a simple message to announce to the server that the player ranked up announcement: "{player} has ranked up from member to super member" # Configure how we want requirements to be treated in our setup use-requirements: # We want money and experience to be taken from the player when they rankup money: true exp: true # However when checking health and hunger, we just want them to have it rather than take it as well. Be careful taking health as you can kill the player doing this if you take all their health - but maybe you want to do that? health: false hunger: false
Group Manager Compatibility
Group manager appears to be a little funny in how it works; group manager only allows player to be in 1 group and will automatically remove their old on when you add a new one however, if the new one inherits from the old, CmdRank will still match the player as being in the odl rank meaning when rankup is called again it will try to do both rankups. Being used to PEX I didn't even for see this as a problem but after some feedback from users of the plugin I have made it possible by config to get the functionality to work just right.
Here are the config changes you should make:
# Do not let players rank any match more than once rerank: false hide-messages: # Hide the message about reranking but make sure the player is told something if no rankup takes place. rankup: rerank: true failure: false # Hide old ranks from showing in /rankcheck rankcheck: matches: rerank: true
Comments