Bukkit

PrisonRankup

The highest-rated and most practical rankup plugin designed specifically for the ever-popular Prison server is finally here. This plugin features a unique database built into the config to house each individual player’s rank to prevent losing ranks, glitching out of the system, and allowing multiple groups to be compatible with popular permissions plugins, including PermissionsEX and GroupManager. Accessing player’s information has never been easier, as one can simply type “/rankup get (name)” to retrieve the player’s display name, rank, and current balance. In order for the balance feature to work, as well as the plugin itself, Vault is required.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Commands:

/rankup - Ranks the sender up to the next available rank (prisonrankup.rankup)

/rankup set (player) (rank) - Sets the given player to the given rank (prisonrankup.set)

/rankup stats (rank) - Receive statistics of a rank given (prisonrankup.stats)

/rankup create (rank) (price) - Create a rank in-game (prisonrankup.stats)

/rankup get (player) - Retrieve a player profile (prisonrankup.get)

/rankup reload - Reloads the config.yml (prisonrankup.reload)

/rankup update - Update PrisonRankup (prisonrankup.update)

/ranks - Shows you available ranks (prisonrankup.ranks)

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Default Configuration File:

# Welcome to configuring PrisonRankup, I will be here to guide you through this config setup
# First let me introduce myself, I am Mazen. I consider myself an expert in configuring Plugins and YAML configs and an advanced Java developer
# First thing I want you to do is to set the prefix (What comes before the message) for the plugin to use. Keep the speech marks please to avoid errors.
Prefix: '&a[&bPrison&6-&bRankup&a]'
#Do not touch this!
version: 3.0
# Next thing I want you to do is set the message you want it to be when somebody ranks up. Keep the speech marks here as well.
# The %player% will be replaced with the players name, and the %rank% will be replaced with the rank they ranked up to.
Rankup BC Message: '&3%player% &6has ranked up to &3%rank%'
# Now, the most important part of this plugin is the rankup ladder
groups:
#Heres an example of the format of how it should be:
# rank name:price
#DO NOT REMOVE THE # FROM THE ABOVE!
- A:30
- B:100
- C:300
#Here, I will be asking you to put the first rank on the ladder in this example A
First Rank: 'A'
# As well as the last rank to assure that we can message the player that he is at the end of the ladder
Last Rank: 'C'
# This message is the message we will send to the player if he is the highest rank.
Highest Rank MSG: '&6 You are already the highest rank!'
# This next one is if you want to use a timed requirement for your rankup system, set it to true if yes. Default is false;
Timed Requirement: false
# Now we're if you set it to true you will have to set a certain time that you want to be done for the rank requirement
Time Interval: 0.0
# Here you will write what the time is based on, seconds, minutes or hours. Spelling does matter!
Time type: Seconds
# If you want, I added an option where you can choose if you want to make it so that the interval is added to every Rankup Sequence
Interval on all ranks: false
# Now you're almost there! Theres just one last part, If you're switching from Rankup and/or majority of Rankup plugins set this to true. If not, set it to false.
# What this does is check if the player has a rank that is listed in groups (Every minute) and if so, makes a profile with that rank.
Transfer ranks to profile: false
# Set the next item to false if you do not want to use the updater
update: true
# Set this to true if you wish to enable debug mode
debug: false
# This is the format of the ranks which will appear when a player does /ranks
#Variables are: %price%, %rank%
ranks-format: '&5[&3%rank%&5]&6: %price%'
# Here, is the message the player will recieve when he doesn't have enough money to rankup
#Varaibles are the same as the ones shown above
not-enough-money: '&6You need &2$%price% &6 to rankup to &2%rank%'

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Switching

Are you switching from another Rankup plugin? Simple! Set the “Transfer ranks to profile” option to “true” in the config.yml!

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

1.8 Compatibility

1.8 compatibilities with UUIDs have been implemented in version 2.0

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Using the Sign Integration

You can make signs that work for PrisonRankup like this (You require the permission prisonrankup.sign):

Then, once you place it you will get something like this:

And congratulations! Now you have a sign that be used to Rankup!

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Plugin Updater

As of Version 1.3 I have integrated an updater to the plugin, just do /rankup update to Update the plugin. You may disable this feature by setting updater to false in the config.yml

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

PrisonRankup Connects to Mojangs Servers

As of the UUID Update, PrisonRankup connects to 'sessionserver.mojang.org' as well as 'api.mojang.com' to fetch UUIDs and names.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Found a bug? Report it!

Have a bug you ran into? You want something added to the plugin? Click here!

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Source (for educational purposes only)

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

JavaDocs

PrisonRankup now has JavaDocs for v3.0+! You can check it out here!

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~