Pages

Configuration

Configuration

Home | Commands | Configuration

Default Configuration

This will be automatically generated when you first enable the plugin. Scroll down to the configuration explain section for more info.

#In the Ranks section:
#For the CommandsToRunOnMenuClick:
# %player% will be replaced with the players name upon being executed
# Beginning the command with a "/" will force the player to run the command as if they typed in in chat themselves.
# Beginning the command with a "!" will run the command as if it was typed into the server console.
# Beginning the command with a "*" will force the player to run the command and give them the permissions they need for the command to be successful.
# Beginning the command with a "@" will send the player the message in chat. As if the plugin is talking to them.
# **Make sure to include at least one of the above options or the command will be ignored**
#For the RanksMenuLores:
# %playerName% will be replaced with the players name.
# %rankPrice% will be replaced with that ranks price.
# %discount% will be replaced with the players discount. WARNING: if the player's discount is 0 the line containing this keyword will be removed.
# **Make sure to type these keywords exactly for them to be successful**

Ranks:
  A:
    RankPrice: 0.0 #How much it will change the player to get to this rank
    RankPrefix: '&8[&aA&8]' #Used only to make the messages look better, please also set this in your permissions plugin's group prefix
    RankInfo: #Displayed when the player types /rankup info
    - '&bWelcome to prison This is the default rank'
    - '&4Use /rankup to make your way out of the prison!'
    - '&5/rankup info &bwill tell you more about the next rank.'
    RanksMenuHasRankLore: #displayed on the lore of the item in the /ranks menu if the player has that rank
    - '&aHey %playerName%,'
    - '&byou paid &e%rankPrice% &bto earn this rank.'
    - '&dClick this item to run the commands I set :D'
    RanksMenuDoesNotHaveRankLore: #displayed on the lore of the item in the /ranks menu if the player does not have that rank
    - '&4You can buy this rank for &c%rankPrice%'
    - '&aThis price includes your %discount% discount!'
    CommandsToRunOnMenuClick:
    - '/rankup info A' #forces the player to run the command
    - '!warp A %player%' #runs the command from console replacing %player% with the players name
    - '*broadcast &bwoooooooohooooo' #player runs the command as if they have the required permissions
    - '@&bHello &e%player%&b, I am the JavaMasta!' #send the player the message
  B:
    RankPrice: 100000.0
    RankPrefix: '&8[&eB&8]'
    RankInfo:
    - '&bRankPrefix: &8[&eB&8]'
    - '&bRankPrice: &a$100,000'
    - '&eMine in a better mine and start crafting &bDIAMOND TOOLS!!!'
    RanksMenuHasRankLore:
    - '&aHey %playerName%,'
    - '&byou paid &e%rankPrice% &bto earn this rank.'
    - '&dClick this item to run the commands I set :D'
    RanksMenuDoesNotHaveRankLore:
    - '&4You can buy this rank for &c%rankPrice%'
    - '&aThis price includes your %discount% discount!'
    CommandsToRunOnMenuClick:
    - '/rankup info A'
    - '!warp A %player%'
    - '*broadcast &bwoooooooohooooo'
    - '@&bHello &e%player%&b, I am the JavaMasta! #send the player the message'
  C:
    RankPrice: 200000.0
    RankPrefix: '&8[&cC&8]'
    RankInfo:
    - '&bI think you can figure out the rest from here, and if you are a player'
    - '&breading this message, go tell the owner to configure his &eRankupPro &bplugin!'
    RanksMenuHasRankLore:
    - '&aHey %playerName%,'
    - '&byou paid &e%rankPrice% &bto earn this rank.'
    - '&dClick this item to run the commands I set :D'
    RanksMenuDoesNotHaveRankLore:
    - '&4You can buy this rank for &c%rankPrice%'
    - '&aThis price includes your %discount% discount!'
    CommandsToRunOnMenuClick:
    - '/rankup info A'
    - '!warp A %player%'
    - '*broadcast &bwoooooooohooooo'
    - '@&bHello &e%player%&b, I am the JavaMasta! #send the player the message'
  D:
    RankPrice: 1.0
    RankPrefix: ''
    RankInfo:
    - ''
    - ''
    - 'Add as many of these lines as you need for the /rankup info!'
    - ''
    RanksMenuHasRankLore:
    RanksMenuDoesNotHaveRankLore:
    CommandsToRunOnMenuClick:
    #Add as many ranks as you would like. And make sure that they are in order from lowest to highest.
    #For Example, A is the first rank and C is the top rank. If you add another rank after D it would be higher than D.

DiscountsEnabled: false #set to true to enable
Discounts:
  Killer: 10% #Players in the killer permissions group get ranks for 10% cheaper.
  Shoplifter: 5% #Player in both groups gets the larger discount, in this case 10% from killer
  
ScoreboardEnabled: true #Globally disables the rankup scoreboard. Players can individually toggle it with /rankup toggledisplay 
ScoreboardOptions:
  PlayersOnlineEnabled: false #Allows disabling of certain scoreboard sections
  CurrentRankEnabled: true #WARNING: You can only have 5 of these 6 options enabled due to scoreboard length limitations
  NextRankEnabled: true
  CurrentBalanceEnabled: true
  AmountNeededEnabled: true
  RankDiscountEnabled: true
  TitleColor: b #Takes values 0-9 and a-f
  ValueColor: d #Takes values 0-9 and a-f
  RainbowYouAreTopRankEnabled: true
  UpdateDelay: 1 #The delay in seconds between the scoreboard's value updates, if causing lag set to 2 or 3. 
  
RanksMenuOptions:
  HasRankItemType: STAINED_GLASS_PANE #Please copy and paste names from http://jd.bukkit.org/dev/apidocs/org/bukkit/Material.html
  HasRankItemDataValue: 5 #Used to set wool colors, or log types etc. If unsure set to 0 and consult the RankupPro configuration page.
  DoesNotHaveRankItemType: STAINED_GLASS_PANE
  DoesNotHaveRankItemDataValue: 14
  
#In the Messages section:
# %amtNeeded% = amount of money the player stills needs before ranking up
# %rankPrefix% = rank prefix as defined above
# %player% = players name
# **Make sure to type these key words exactly for them to be successful**

Messages:
  needMoreMoneyToRankup: '&4You need another &a%amtNeeded% &4to rankup to %rankPrefix%!'
  rankedUp: '&bCongrats! You have ranked up to %rankPrefix%&b for &a%amtNeeded%&b, Good Work!'
  playerRankedUpBroadcast: '&bHey Everyone! &e%player% &bhas ranked up to &e%rankPrefix%&b!' #Leave blank to disable the broadcast

Configuration Explained


Each rank is comprised of 6 characteristics.
RankPrice: the amount of money a player must pay to move up the from the previous rank to this rank.
RankPrefix: used to make the messages nice and pretty, support all of the minecraft format codes.
RankInfo: a list of messages that will be showed to the player when they run the /rankup info for this rank. Supports all minecraft format codes.
RanksMenuHasRankLore: a list of messages that will become the lore of this rank's item in the /ranks gui if the player has this rank.
RanksMenuDoesNotHaveRankLore: a list of messages that will become the lore of this rank's item in the /ranks gui if the player does not have the rank
CommandsToRunOnMenuClick: a list of commands that will be run when a the player clicks this rank's item in the /ranks gui.
Below is a blank template for adding a new rank, feel free to copy and paste it under the Ranks: section in your config: 

  <rankName>:
    RankPrice:
    RankPrefix: ''
    RankInfo:
    - ''
    RanksMenuHasRankLore:
    - ''
    RanksMenuDoesNotHaveRankLore:
    - ''
    CommandsToRunOnMenuClick:
    - ''


Some sections allow for the use of some keywords.
In the Ranks.CommandsToRunOnMenuClick sections:
• %player% will be replaced with the players name while the command is run.
In the Ranks.RanksMenuHasRankLore and Ranks.RanksMenuDoesNotHaveRankLore sections:
• %playerName% will be replaced with the players name
• %rankPrice% will be replaced with the rankprice, this price will be discounted accordingly if applicable
• %discount% will be replaced with the players discount if they have once. WARNING: if the players discount is 0% any lines containing this keyword will not show up.
In the Messages section:
• %player% will be replaced with the appropriate player name when the message is displayed.
• %rankPrefix% will be replaced with the appropriate rank prefix as defined in that rank's RankPrefix characteristic when the message is displayed.
• %amtNeeded% will be replaced with the amount of money the player still needs or spent in order to preform the action.

The discount section.
If DiscountsEnabled is set to false you cont have to worry about discounts at all. If you do want to use this feature here is how!
Set DiscountsEnabled to true.
Under this header set all the groups you wish to give a discount to and how much you want them to save on rank prices. If a player has more then one of these groups it will only give them the highest discount from the discounts available to them.
Set these discounts with GroupName: discount%. For example, Killer: 10% will allow for a player in the group killer to rankup to a 10$ rank for 9$.
All places where the %amtNeeded% prefix will be the discounted price if applicable.

The scoreboard section.
#WARNING: You can only have 5 of these 6 options enabled due to scoreboard length limitations
If you don't want to used the rankuppro scoreboard set ScoreboardEnabled: to false.
You can also enable/disable certain sections with the <option>Enabled: sections.
TitleColor and ValueColor take a single minecraft format code and allow for you to change the color for the scoreboard titles and values. For example TitleColor: b and ValueColor: d will make the scoreboard read:
CurrentBal:
$100
The RainbowYouAreTopRankEnabled: true means that if u are the top rank the scoreboard section that will read "You are top rank" to change colors
Lastly, the updateDelay option. Sets how often in seconds to update the scoreboard to the players new balance, rank, amount needed etc.

The RanksMenu section.
Where you can set the item that will become the icon in your /ranks gui.
The item format is very simple. Just the item type under the HasRankItemType for example STAINED_GLASS_PANE (Please copy and paste item names from Bukkit's list of materials) and for an item that supports a data value such as Stained glass use the HasRankItemDataValue to set the color according to these data values. Set to 0 if you would not like to include any datavalue and for the lime stained glass I used the value 5. These lists can be long but using ctrl+f you should have no trouble.