Coral features an amazing rankups and prestiges module, using super-fast technology to ensure users can rankup to any amount without affecting server performance.
Settings
The following settings can be found within you CoralPrison/modules/rankups/configs/rankups.yml. An in-depth explanation of each configurable option has been provided down below, for your ease of access.
rankup-type:"AUTOMATIC"#MANUAL | AUTOMATICrankup-currency:"vault"#vault | tokens | playerpoints | experienceprestige-currency:"vault"#vault | tokens | playerpoints | experiencedefault-rank:1#Goes by indexmax-rank:100000#any long numbermax-prestige:1000000#any long numberbase-cost:1cost-increase:100prestige-base-cost:1prestige-cost-increase:100automatic-prefix-color:"&6&l#&e&l"prestige-prefix-color:"&3&l#&b&l"
The rankup-type: can have 2 modes, being AUTOMATIC or MANUAL. If the manual mode is selected, you will have the ability to configure ranks exactly to your liking, with custom names and ID's e.g Rank A, Rank B, Rank C etc. This can be altered further down in the same config, please scroll down to the manual mode section in this wiki if you require any assistance. If the automatic mode is selected, all you need specify is the default-rank:, max-rank:, and the automatic-prefix-color:. As self explanatory, the default-rank: option should specify the rank you would like all users to have on join, this should typically remain at 1, whereas the max-rank: option should specify the maximum rank users are able to rank up to. Prefix colours which you set are used throughout the module, within the messages and also action bar. It is important to note that this is a prefix meaning the rank number will be displayed after what has been set in the config.
Rankups and prestiges can take any currency which is either currently supported by AbyssLib or made using the in built economy module for coral. This should be specified in the rankup-currency: or prestige-currency:. Both base-cost and cost-increase work the same for prestiges and rankups, where the base cost represents the initial amount needed to rankup/prestige to the first level, and cost increase signifies the amount by which the cost increases with each rank/prestige.
HINT: Values such as base-cost: and cost-increase: must be specified regardless of the mode selected.
Prestige Settings
Coral allows you determine what happens to a players rank once the player has prestiged. This can be edited in CoralPrisons/modules/rankups/configs/rankups.yml under the following section:
If the reset rank on prestige is enabled, the players rank will reset to 0 after they have reached the appropriate prestige. The value for increase-max-rank-by: specifies how much the max rank should be increased by, which is attainable by the user after they have prestiged.
Manual Rankups
If you would like your rankups to have custom names you may do so by switching from automatic rankups to manual rankups. To configure a rank using the manual mode, scroll down to the manual: section in your rankups.yml. Whilst there you should follow the format below to create a rank:
"A":#id 1name:"&a&lA"
All fields here can be custom named, and do not need to follow the pattern A,B,C. First you should enter a custom key naming it whatever you like, and under it you should enter a name: field. The value specified here will be used throughout the rankup module, in various messages as well as the action bar. You may create as many ranks as you like. It is important to note that each rank you create, will be given a numerical ID internally, indexed from 1, which you may use for rankup rewards.
Rewards
With coral you have the ability to send rewards to players if htey meet the rank or prestige required. This can be done within either rankup-rewards: or prestige-rewards:, depending on your needs, contained in CoralPrison/modules/rankups/configs/rankup.yml. Here you can add rewards for any rank or prestige by simply following the format below:
"3":#ID of the rankup/prestige - "give %player% diamond 1"# All of the commands for the id milestone
If you are using AUTOMATIC mode for rankups, the id specified must be between the default rank and the max rank. If you are using manual mode, this will be the id which is internally generated as explained in the Manual Rankups section. Under the ID you should specify a list of commands to run when the user progresses to said rank. These will be run by the console, and %player% will be replaced with the players username. You may specify as many commands as you like, and set up rewards for as many ranks as you like.
Configuration Files
configs/rankups.yml
rankup-type:"AUTOMATIC"#MANUAL | AUTOMATICrankup-currency:"vault"#vault | tokens | playerpoints | experienceprestige-currency:"vault"#vault | tokens | playerpoints | experiencedefault-rank:1#Goes by indexmax-rank:100000#any long numbermax-prestige:1000000#any long numberbase-cost:1cost-increase:100prestige-base-cost:1prestige-cost-increase:100automatic-prefix-color:"&6&l#&e&l"prestige-prefix-color:"&3&l#&b&l"reset-rank-on-prestige:enabled:falseincrease-max-rank-by:5rankup-rewards:"3":#ID of the rankup - "give %player% diamond 1"# All of the commands for the id milestone"1000":#ID of the rankup - "give %player% emerald 1"# All of the commands for the id milestone"10000":#ID of the rankup - "give %player% diamond_block 1"# All of the commands for the id milestone"100000":#ID of the rankup - "give %player% emerald_block 1"# All of the commands for the id milestone"1000000":#ID of the rankup - "give %player% nether_star 1"# All of the commands for the id milestone\prestige-rewards:"3":#ID of the prestige - "give %player% diamond 1"# All of the commands for the id milestone"1000":#ID of the prestige - "give %player% emerald 1"# All of the commands for the id milestone"10000":#ID of the prestige - "give %player% diamond_block 1"# All of the commands for the id milestone"100000":#ID of the prestige - "give %player% emerald_block 1"# All of the commands for the id milestone"1000000":#ID of the prestige - "give %player% nether_star 1"# All of the commands for the id milestonemanual:"A":#id 1name:"&a&lA""B":#id 2name:"&b&lB""C":#id 3.. etc...name:"&c&lC"
