Ranker

Table of Contents

Usage and Scalability

Ranker can automatically run commands to give players rewards/permissions based on their performance/stat (pvp, pve, time, and wealth) that satisfy requirements defined by server Ops/Admins. With absolutely no configuration, Ranker works as a light-weight and simple stats tracker. Ranker's features and functions depends on the data in config.yml. Unlock as much or as little features and functions as you wish. Add Vault.jar and Ranker will use your server's economy currency as a stat. Define requirements, rewards, custom messages and commands and ranker works automatically. Set commands to do anything including grant players permissions, powers, items, and/or other rewards. Ops/Admins can control Ranker completely from within the game using commands. Commands can also provide feedback of current values in config.yml. Players and Console can display both online and offline player stats as well as modify them.

Ranker config.yml

Ranker's typical config.yml is organized into the following root sections:

autorank - contains the ranks, requirements, rewards, messages, and commands
stats - contains the appearance of of /ranker stats
chatformat - contains the appearance of each rank title
general - ranker chat mode, debug mode, How Ranker affect operators
mysql - MySQL support for synchronizing player stats to database

Simple Config.yml Example

autorank: 
  world:
    Peon:
      rankupcommand1: server:/perm player setgroup {PLAYER} {RANK}
      requirement: money=10
    Citizen:
      rankupcommand1: server:/perm player setgroup {PLAYER} {RANK}
      requirement: money=20
stats:
  line2: ' &3{RANK} &2{PLAYER}'
chatformat:
  Peon: '&a{RANK} {PLAYER}&3: &9'
  Citizen: '&a{RANK} {PLAYER}&3: &9'
general:
  debug: false
  chat: false
  operator: false
mysql:
  enable: false
  ip: 127.0.0.1
  username: root
  password: password
  port: 3306
  database: minecraft
  table: ranker
  update: 45
  keepalive: true

Extended Config.yml Example

general:
  chat: false
  debug: false
  operator: false
mysql:
  enable: false
  ip: 127.0.0.1
  username: root
  password: password
  port: 3306
  database: minecraft
  table: ranker
  update: 45
  keepalive: true
autorank:
  world:
    Peon:
      rankupmessage1: '&8--------------------------------------------'
      rankupmessage2: ' You earned Peon rank!'
      rankupmessage3: '&8--------------------------------------------'
      rankdownmessage1: '&8--------------------------------------------'
      rankdownmessage2: ' You ranked down to Peon rank!'
      rankdownmessage3: '&8--------------------------------------------'
      rankupcommand1: server:/perm player setgroup {PLAYER} {RANK}
      rankupcommand2: server:/perm reload
      rankupcommand3: server:/give {PLAYER} wood 100
      rankupcommand4: server:/give {PLAYER} dirt 100
      rankdowncommand1: server:/perm player setgroup {PLAYER} {RANK}
      rankdowncommand2: server:/perm reload
      rankdowncommand3: server:/give {PLAYER} wood 1
      rankdowncommand4: server:/give {PLAYER} dirt 1
      rewardinfo: '100 stacks of wood, dirt, and some new commands!'
      requirement: money=0
    Citizen:
      rankupcommand1: server:/perm player setgroup {PLAYER} {RANK}
      rankupcommand2: server:/perm reload
      rankupcommand3: server:/give {PLAYER} wood 100
      rankupcommand4: server:/give {PLAYER} stone 100
      rankupmessage1: '&8--------------------------------------------'
      rankupmessage2: ' You earned Citizen rank!'
      rankupmessage3: '&8--------------------------------------------'
      rankdownmessage1: '&8--------------------------------------------'
      rankdownmessage2: ' You ranked down to Citizen rank!'
      rankdownmessage3: '&8--------------------------------------------'
      rankdowncommand1: server:/perm player setgroup {PLAYER} {RANK}
      rankdowncommand2: server:/perm reload
      rankdowncommand3: server:/give {PLAYER} wood 1
      rankdowncommand4: server:/give {PLAYER} dirt 1
      requirement: money=1000
    Recruit:
      requirement: money=2000
      rankupcommand1: server:/perm player setgroup {PLAYER} {RANK}
      rankupcommand2: server:/perm reload
      rankupcommand3: server:/give {PLAYER} wood 100
      rankupcommand4: server:/give {PLAYER} stone 100
      rankupcommand5: server:/give {PLAYER} stonesword 1
      rankupmessage1: '&8--------------------------------------------'
      rankupmessage2: ' You earned Recruit rank!'
      rankupmessage3: '&8--------------------------------------------'
      rankdownmessage1: '&8--------------------------------------------'
      rankdownmessage2: ' You ranked down to Recruit rank!'
      rankdownmessage3: '&8--------------------------------------------'
      rankdowncommand1: server:/perm player setgroup {PLAYER} {RANK}
      rankdowncommand2: server:/perm reload
      rankdowncommand3: server:/give {PLAYER} wood 1
      rankdowncommand4: server:/give {PLAYER} dirt 1
  world_the_end:
    Peon:
      rankupmessage1: '&8--------------------------------------------'
      rankupmessage2: ' You earned Peon rank!'
      rankupmessage3: '&8--------------------------------------------'
      rankdownmessage1: '&8--------------------------------------------'
      rankdownmessage2: ' You ranked down to Peon rank!'
      rankdownmessage3: '&8--------------------------------------------'
      rankupcommand1: server:/perm player setgroup {PLAYER} {RANK}
      rankupcommand2: server:/perm reload
      rankupcommand3: server:/give {PLAYER} wood 100
      rankupcommand4: server:/give {PLAYER} dirt 100
      rankdowncommand1: server:/perm player setgroup {PLAYER} {RANK}
      rankdowncommand2: server:/perm reload
      rankdowncommand3: server:/give {PLAYER} wood 1
      rankdowncommand4: server:/give {PLAYER} dirt 1
      rewardinfo: '100 stacks of wood, dirt, and some new commands!'
      requirement: money=0
    Citizen:
      rankupcommand1: server:/perm player setgroup {PLAYER} {RANK}
      rankupcommand2: server:/perm reload
      rankupcommand3: server:/give {PLAYER} wood 100
      rankupcommand4: server:/give {PLAYER} stone 100
      rankupmessage1: '&8--------------------------------------------'
      rankupmessage2: ' You earned Citizen rank!'
      rankupmessage3: '&8--------------------------------------------'
      rankdownmessage1: '&8--------------------------------------------'
      rankdownmessage2: ' You ranked down to Citizen rank!'
      rankdownmessage3: '&8--------------------------------------------'
      rankdowncommand1: server:/perm player setgroup {PLAYER} {RANK}
      rankdowncommand2: server:/perm reload
      rankdowncommand3: server:/give {PLAYER} wood 1
      rankdowncommand4: server:/give {PLAYER} dirt 1
      requirement: money=1000
    King:
      requirement: money=2000
      rankupcommand1: server:/perm player setgroup {PLAYER} {RANK}
      rankupcommand2: server:/perm reload
      rankupcommand3: server:/give {PLAYER} wood 100
      rankupcommand4: server:/give {PLAYER} stone 100
      rankupcommand5: server:/give {PLAYER} stonesword 1
      rankupmessage1: '&8--------------------------------------------'
      rankupmessage2: ' You earned King rank!'
      rankupmessage3: '&8--------------------------------------------'
      rankdownmessage1: '&8--------------------------------------------'
      rankdownmessage2: ' You ranked down to King rank!'
      rankdownmessage3: '&8--------------------------------------------'
      rankdowncommand1: server:/perm player setgroup {PLAYER} {RANK}
      rankdowncommand2: server:/perm reload
      rankdowncommand3: server:/give {PLAYER} wood 50
      rankdowncommand4: server:/give {PLAYER} dirt 50
stats:
  line1: '&8--------------------------------------------'
  line2: ' &3{RANK} &2{PLAYER}'
  line3: '&6 {PVP} &aplayers killed!'
  line4: ' &6{PVE} &amonsters/animals killed.'
  line5: ' &6{TIME} &aminutes played.'
  line6: ' &6${MONEY} &ain wealth.'
  line7: '&8--------------------------------------------'
chatformat:
  Peon: '&a{RANK} {PLAYER}&3: &9'

Ranker Commands allows Complete Control over config.yml

The following are 2 examples of defining requirement(s) for the Peon rank

description: (player must have atleast $1000 AND a pvp score of 4)
command: /ranker worldName.Peon.requirement money=1000+pvp=4
description: (player must have atleast $1000 AND a pvp score of 4) OR (have playtime of atleast 120 minutes) OR (have killed atleast 50 monsters) OR (have killed atleast 30 players)
command: /ranker worldName.Peon.requirement money=1000+pvp=4;time=120;pve=50;pvp=30

More on how to Modify config.yml by Commands

Command parameter corresponds directly to the format within the config.yml file. The following demonstrates a sequence of changes to the config.yml with each command used. Also Note Below: Ranker displays the current value of the config node if no value parameters are included!

permission node: ranker.* (default: op)
command: /ranker autorank.world.Peon.rankupcommand1 server:/give {PLAYER} wood 100

autorank:
  world:
    Peon:
      rankupcommand1: server:/give {PLAYER} wood 100

command: /ranker autorank.world.Peon.rankupmessage2 ' You earned Peon rank!'

autorank:
  world:
    Peon:
      rankupcommand1: server:/give {PLAYER} wood 100
      rankupmessage2: ' You earned Peon rank!'

command: /ranker autorank.world.Peon.requirement time=0

autorank:
  world:
    Peon:
      rankupcommand1: server:/give {PLAYER} wood 100
      rankupmessage2: ' You earned Peon rank!'
      requirement: time=0

command: /ranker autorank.world.Peon.requirement
displays: (existing) time=0
command: /ranker autorank.world.Peon.requirement remove

autorank:
  world:
    Peon:
      rankupcommand1: server:/give {PLAYER} wood 100
      rankupmessage2: ' You earned Peon rank!'

Commands

/ranker list 
    description: list all ranks, requirements, and rewards within a world.
/ranker stats
    description: show stats
/ranker stats <player>
    description: show stats of <player>
/ranker autorank.<worldName>.<rankName>.<options> <values>
    description: edit autorank data in config.yml
/ranker chatformat.<rankName> <values>
    description: edit chatformat in config.yml
/ranker stats.line<1-8> <values>
    description: edit stats format in config.yml
/ranker save-all
    description: saves all player's stats to server before a /reload
/ranker general.chat <true|false>
    description: turn Ranker chat mode on/off.
/ranker general.debug <true|false>
    description: turn Ranker debug mode on/off.
/ranker general.operator <true|false>
    description: include/exclude operators from calling Ranker's messages/commands, (false prevents operators from getting downranked)
/ranker reset <player> rank
    description: reset player rankName
/ranker reset <player> <pvp|pve|time> <value>
    description: reset player stats to specified value.
/ranker give <player> <pvp|pve|time> <value>
    description: add value to specified player stats.
/ranker import autorank
    description: imports autorank player's time into Ranker playerData

Permissions

  ranker.*:
        description: Allow use of op commands.
        default: op
      children:     
        ranker.stats.self: true
        ranker.stats.other: true
        ranker.list: true
        ranker.save.all: true
  ranker.stats.self:
        description: Show my stats.
  ranker.stats.other:
        description: Show other player's stats.
  ranker.list:
        description: List the ranks, requirements, and rewards within a world.
  ranker.command.rankup:
        description: Call rank commands when rank up to that rank.
  ranker.command.rankdown:
        description: Call rank commands when rank down to that rank
  ranker.message.rankup:
        description: Call rank messages when rank up to that rank.
  ranker.message.rankdown:
        description: Call rank messages when rank down to that rank.
  ranker.rankup:
        description: Change your rank when you rank up. Setting this to false will disable both message and command.
  ranker.rankdown:
        description: Change your rank when you rank down. Setting this to false will disable both message and command.
  ranker.save.all:
        description: Allow player to save all player's stats to server.

Player and Server Command Example

command: /ranker autorank.world.Peon.rankupcommand1 server:/give {PLAYER} wood 100
description: console server will send the command
command: /ranker autorank.world.Peon.rankupcommand2 player:/me just ranked!
description: the player will send the command

Mechanics with Permissions

permission node: ranker.command.rankup (default: op)
description: Call rank commands when rank up to that rank.

permission node: ranker.command.rankdown (default: op)
description: Call rank commands when rank down to that rank

permission node: ranker.message.rankup (default: op)
description: Call rank messages when rank up to that rank.

permission node: ranker.message.rankdown (default: op)
description: Call rank messages when rank down to that rank.

Like this plugin? Donate to support development and Thanks!

Comments

_ForgeUser9801179
- Join Date: 10/13/2012
- Posts: 70
- Member Details
#130 _ForgeUser9801179

View User Profile

Send Message

Posted Feb 26, 2013
@KingPyro

Plz message me your config? And permissions you are using

Rollback Post to Revision RollBack
_ForgeUser4415308
- Join Date: 5/10/2010
- Posts: 86
- Member Details
#129 _ForgeUser4415308

View User Profile

Send Message

Posted Feb 25, 2013
sometimes a players rank will go to the last rank randomly, not run any command but itll be set to the 7th rank when it shud be te first...

Rollback Post to Revision RollBack
_ForgeUser4415308
- Join Date: 5/10/2010
- Posts: 86
- Member Details
#128 _ForgeUser4415308

View User Profile

Send Message

Posted Feb 24, 2013
im only having one issue and that is after executing the command to convert autorank data to ranker. works great btw :D since autorank did not use any capital in there data saving. when someone with a capital joins it create a new file with the same name but proper capitalization and such, can u make a check that checks to see if that name exists and change the file name properly? or such Besides that everything is working great :) also where do i donate to the plugin

EDIT: is there a way to take the total minutes played and change it into hours? maybe as an option?

Last edited by _ForgeUser4415308: Feb 24, 2013

Rollback Post to Revision RollBack
_ForgeUser9801179
- Join Date: 10/13/2012
- Posts: 70
- Member Details
#127 _ForgeUser9801179

View User Profile

Send Message

Posted Feb 23, 2013
Is there anyone NOT having trouble with 1.3.1, please post a comment if you're NOT having issues. Everyone else having issues with 1.3.1, try removing the Ranker.jar and Ranker folder (or save them in another location outside of the plugins folder) and start Ranker fresh. I'm looking into this. I re-downloaded the 1.3.1 from bukkit and I'm not having any issues. Perhaps it is a permissions issue conflicting at the code level.

Rollback Post to Revision RollBack
_ForgeUser5726064
- Join Date: 9/23/2010
- Posts: 155
- Member Details
#126 _ForgeUser5726064

View User Profile

Send Message

Posted Feb 22, 2013
For some reason, after I import autorank data, as soon as a person ranks up, they are automatically ranked over and over again.

Rollback Post to Revision RollBack
_ForgeUser9801179
- Join Date: 10/13/2012
- Posts: 70
- Member Details
#125 _ForgeUser9801179

View User Profile

Send Message

Posted Feb 22, 2013
@spawnstah

thanks for the suggestion!

Rollback Post to Revision RollBack
_ForgeUser9801179
- Join Date: 10/13/2012
- Posts: 70
- Member Details
#124 _ForgeUser9801179

View User Profile

Send Message

Posted Feb 22, 2013
@Ducky_333

Linux or Windows server?

Rollback Post to Revision RollBack
_ForgeUser6898812
- Join Date: 5/26/2011
- Posts: 47
- Member Details
#123 _ForgeUser6898812

View User Profile

Send Message

Posted Feb 21, 2013
I just updated to the 1.4.7 version of ranker, and now when someone earns a rank they continue to earn it every few seconds.. the rank is simply earned by 30 minutes game time, so shouldn't be re-earnable.

Edit: They appear to be getting stuck at 31 minutes playtime.

Last edited by _ForgeUser6898812: Feb 21, 2013

Rollback Post to Revision RollBack
Forge_User_73460733
- Join Date: 8/4/2005
- Posts: 100
- Member Details
#122 Forge_User_73460733

View User Profile

Send Message

Posted Feb 20, 2013
Hi, I just resently installed Inquisitor (http://dev.bukkit.org/server-mods/inquisitor/) which keep track of a lot of playerdata. It would be cool if Ranker could coop with Inquisitor, so it could use more stats for ranking, and we wouldn't need to have multiple addons tracking the same data :)

Not sure how hard it would be to implement, but instead of having Ranks per world, could we get Ranks for a Group of Worlds, with exclusions? For example, I would like "World1, World2 and World3" to count stats and use the same Ranks. But NOT include anything done in worlds "Creative1, PVP2 or Test".

Thanks for a great addon! I live the fact that it's so easy to run custom commands on RankUp/RankDown to let PEX add and remove permissions or groups.

Rollback Post to Revision RollBack
_ForgeUser9801179
- Join Date: 10/13/2012
- Posts: 70
- Member Details
#121 _ForgeUser9801179

View User Profile

Send Message

Posted Feb 20, 2013
Ranker 1.3.1 release is out!

Fix player quit bug where Ranker tries to process a player's data, but player quits before it finishes processing.
command: /ranker import autorank
description: import autorank time format into ranker

@Zetakaeme

/ranker stats will display {TIME} in minutes
Rollback Post to Revision RollBack
_ForgeUser10562079
- Join Date: 2/13/2013
- Posts: 25
- Member Details
#120 _ForgeUser10562079

View User Profile

Send Message

Posted Feb 20, 2013
@goldftwcom

So time=120 is 120 minutes ?

Rollback Post to Revision RollBack
_ForgeUser9801179
- Join Date: 10/13/2012
- Posts: 70
- Member Details
#119 _ForgeUser9801179

View User Profile

Send Message

Posted Feb 20, 2013
@Zetakaeme

Play time is in recorded into memory in seconds, but displayed in minutes. Ranker can help you rankup your players based on how long they play. And even more if you want.

Rollback Post to Revision RollBack
_ForgeUser10562079
- Join Date: 2/13/2013
- Posts: 25
- Member Details
#118 _ForgeUser10562079

View User Profile

Send Message

Posted Feb 20, 2013
Whats the unit for the Time?

For Example:

time=120

Is it 120 Seg, Minutes, Hours or Days?

I Need a plugin that upgrade the rank of a user while pass the time :/ This plugin can help me ?

Rollback Post to Revision RollBack
_ForgeUser5726064
- Join Date: 9/23/2010
- Posts: 155
- Member Details
#117 _ForgeUser5726064

View User Profile

Send Message

Posted Feb 18, 2013
@goldftwcom

Cool, thanks!

Rollback Post to Revision RollBack
_ForgeUser9801179
- Join Date: 10/13/2012
- Posts: 70
- Member Details
#116 _ForgeUser9801179

View User Profile

Send Message

Posted Feb 18, 2013
@miningcraftlt

Great news, This error does NOT affect the mechanics of Ranker because I was able to emulate the same exact error which only occurs when Ranker starts processing an online player, but doesn't finish before the player quits. I have a fix for this!

Rollback Post to Revision RollBack
_ForgeUser9950139
- Join Date: 11/9/2012
- Posts: 56
- Member Details
#115 _ForgeUser9950139

View User Profile

Send Message

Posted Feb 18, 2013
Can you make more examples for the config making? I'm still really confused. I'm gonna have to try to read yaml without exploding.

Rollback Post to Revision RollBack
_ForgeUser9972686
- Join Date: 11/13/2012
- Posts: 95
- Member Details
#114 _ForgeUser9972686

View User Profile

Send Message

Posted Feb 18, 2013
"could not load plugin "Ranker"" :S

HELP ME!

Rollback Post to Revision RollBack
_ForgeUser9801179
- Join Date: 10/13/2012
- Posts: 70
- Member Details
#113 _ForgeUser9801179

View User Profile

Send Message

Posted Feb 17, 2013
@SDDJ Permissions

ranker.command.rankup
ranker.command.rankdown
ranker.message.rankup
ranker.message.rankdown

Since it has been requested before, I'll make a quick feature to convert autorank's time over to Ranker.
Rollback Post to Revision RollBack
_ForgeUser5726064
- Join Date: 9/23/2010
- Posts: 155
- Member Details
#112 _ForgeUser5726064

View User Profile

Send Message

Posted Feb 17, 2013
Would you mind adding a permission that players require in order to be affected by the ranking up/down? That way, people can use this on existing servers where people are already ranked up to other ranks (and not being demoted by this). Or if you could add a way top import playtime data from autorank, that'd also be awesome! :D

autorank: http://dev.bukkit.org/server-mods/autorank/

Rollback Post to Revision RollBack
_ForgeUser9801179
- Join Date: 10/13/2012
- Posts: 70
- Member Details
#111 _ForgeUser9801179

View User Profile

Send Message

Posted Feb 17, 2013
@miningcraftlt

How many players were on your server when you got this error? /ranker reset strange?

Rollback Post to Revision RollBack
To post a comment, please login or register a new account.

Project ID

46553
Created

Oct 28, 2012
Last Released File

Mar 16, 2013
Total Downloads

21,315
License

GNU Lesser General Public Lice...

v1.3.3
Mar 16, 2013
v1.3.2
Mar 11, 2013
v1.1
Dec 3, 2012

Bukkit

Ranker

Bukkit Plugins

Ranker

Table of Contents

Usage and Scalability

Ranker config.yml

Simple Config.yml Example

Extended Config.yml Example

Ranker Commands allows Complete Control over config.yml

More on how to Modify config.yml by Commands

Commands

Permissions

Player and Server Command Example

Mechanics with Permissions

Like this plugin? Donate to support development and Thanks!

Comments

Ranker 1.3.1 release is out!

About This Project

Categories

Members

Recent Files

Bukkit