Ranks

Count your blocks and get ranks!

Info

Please post a ticket, if you encounter any issue!

Overview:

This plugin will count many things, your players are doing and display them on a website:

Players can track their stats server-independent and can compete on a more global level. Later on, players can use the site to show it as a portfolio and proof of work/experience!

Players can view their statistics ingame with "/ranks".
You can change and localize all output of the plugin in locale.dat
For adding a sign with your name:

Line 0:[Ranks]
Line 1:yourname
Line 2:Will be Block-Break
Line 3:Will be Block-Place

Configuration

All plugin settings can be configured in config.yml.

Here is the default configuration as of Version 2.1.11:

#Bukkit deletes comments if you change something, this it the default-configuration!
#enable the plugin?
enabled: true

#enable stats-tracking
#if false, this renders the plugin useless!
stats-tracking: true
#auto-updates the plugin. Old versions will not be supported after some time!
auto-update: true
#if you prefer to give me usage-informations, please enable this. Has no effect on the plugin!
enable-metrics: true

#prints out optional data
verbose: false
#prints out debugging informations
debug: false

#here you can select your method of storage
#MySQL is prefered, if false, sqlite will be used!
Use MySQL: false

#If used, here you can set your mysql-login!
MySQL:
  MySQL-Database: DB
  MySQL-Hostname: localhost
  MySQL-User: user
  MySQL-Password: pw

You can see how the plugin interprets this configuration in the image below:

Stats tracking

This plugin depends on tracking your data. And i want to make this process as transparent as possible!

Below you can find all things i will track and for what they are used. If you have any question, feel free to drop me a pm!

All public view-able data can be seen at http://mcranks.org and there you can see, how your data will be displayed! If you have set enabled or stats-tracking to false in the config.yml nothing will be tracked by my plugin!

Name	Since Version	Used for	visibility
Server IP	2.0.1	Fraud protection	private
Broken blocks per Player and Block type	2.0.1	Stats tracking	public
Placed blocks per Player and Block type	2.0.1	Stats tracking	public
Online Players	2.0.3	Stats tracking online time	public
Plugin Version (server<->BukkitDev)	2.0.3	Update Checking	on your server
Player Movement	2.0.4	Stats tracking Blocks walked	public
Experience gained per Player	2.0.4	Stats tracking	public
Downloading newest ranking	2.0.5	Ingame commands	on your server
Killed entities per Player	2.1.15	Stats tracking	public
Damaged entities per Player	2.1.15	Stats tracking	public

Performance

SQLite in its nature is much slower than MySQL, so if you have a server with many players, you should consider using MySQL!

My plugin has to track many events that are happening on your server. It also has to upload all this data. This task can bring in many performance issues if implemented poorly (I/O in main thread etc.). I am trying to create a plugin, that in no way will impact the performance of any server you run it on. But there will be things i did not thought about, so if your server has issues with my plugin, please post a ticket explaining the problem.

Rest assured, that no networking is done on the Bukkit main thread and stats are highly cached, so it is normal for them to take some time, until they are viewed on the server.

Plugin Metrics

Also, beginning with version 2.1.1 there will be PluginMetrics included. The data collected by Metrics can be viewed at http://mcstats.org/ and you can always opt-out by changing enable-metrics to false in config.yml!

What is exactly read/sent by Metrics? (Copy from the metrics website)

It is not possible for Metrics to control the plugin in any way except for plugin-specific code the plugin author implements. Nothing is downloaded, so what you get is what the plugin author implemented.

The following data is read from the server in some way or another:

File Contents of plugins/Plugin Metrics/config.yml (created if not existent)
Players currently online (not max player count)
Server version string (the same version string you see in /version)
Plugin version of the metrics-supported plugin
Mineshafter status - it does not properly propagate Metrics requests however it is a very simple check and does not read the filesystem

The following data is sent to http://mcstats.org:

Metrics revision of the implementing class
Server's GUID
Players currently online (not max player count)
Server version string (the same version string you see in /version)
Plugin version of the metrics-supported plugin
Any custom data the supporting plugin implements. This is variable and I am not responsible for this however usually it is just plugin-specific data (e.g for LWC, the database type: MySQL or SQLite, and Locale used (english, german)).

Update checking:

This plugin will automatically check for updates and keep your version up to date. You can disable this in the config by setting auto-update to false. But since api-features will change, after some time, old versions will not work anymore! So please update!

View on the future

If you dislike this change, go ahead and download my 1.1.0 Release and you have the last offline-version of my plugin.
http://dev.bukkit.org/bukkit-plugins/ranks/files/3-version-1-1-0/

This change is the first one in a series of bigger changes! I stated, that i want this plugin to be more a stats/ranks-plugin than simple counting of blocks. Your rank is now server-independent! And i will track more things like, kills, deaths, distance walked, exp collected, objects crafted, drops collected etc. I think, there are many things worth counted. And server-owners can give People rewards/permissions based on how high their rank is.

Features:

Counts several statistics
Dynamic scoring based on all players
Will auto-check on startup for new updates!
Players can view their score ingame
You can place signs who will display your Rank to all Players passing by

ToDo:

Rise custom levels (and get something from it)
Add new things to track
Overhaul Website to get detailed statistics!

KnownIssues:

none of today