Heads Leaderboards

Heads LeaderBoards

VERSION 4.0 HAS BEEN RELEASED
This update brings some major changes to Heads Leaderboards. But don't worry, it's still backwards compatible with your old leaderboards!!

The first change you will notice is that the leaderboard.yml is gone and replaced with a Leaderboards directory containing a separate file for each leaderboard.

Everything else is related to MySQL leaderboards.

In the new yml's for the leaderboards you will notice plenty of new options.

First, Database is now a variable for each leaderboard. This will allow you to connect different leaderboards to different databases. Solving one of the most requested features.

Second, you will notice a variable for usingUUID. When set to true, you can use a UUID column instead of playernames and the plugin will pull the playername from Mojang.

Third, you will notice the variable for multiStat. When enabled and setup this will allow you to show two stats on one table. For instance you could have a pvp leaderboard that shows both Kills and Deaths of the leaders. The leaderboard will still be sorted by the first stat.

INFO FROM PREVIOUS UPDATE
FFS - Head's Leaderboards Finally Supports Flat File Storage. You don't have MySQL, NO WORRIES. Supports both JSON and YML filetypes. Supports files named by UUID or PlayerName.

Heads Leaderboards has continued to build Flat File support by adding the ability to use SQLite flat file databases (like ScoreboardStats uses). You can do this by creating a SQL leaderboard and enabling flatFileDB in the leaderboard.yml. You will also have to set the path to the db file in the leaderboard.yml. This is the path from the server directory including the filename. (ie. For ScoreboardStats this would be: \plugins\scoreboardstats\scoreboardstats.db)

One point about using .db files is that you still need to know the table and column names. To find these you can use a SQlite DB Browser!

What does this Plugin Do?
This plugin allows you to create sign leaderboards (with heads) using data in a MySQL database OR Flat File Storage. This plugin does not track any player data!! It merely gives you another way to display the data stored in your MySQL database OR store by minecraft or other plugins in Flat File Storage (Such as Kills, Wins, etc...).

Installation

1. Copy the Jar file to your plugins directory.
2. Edit the created config or use the Setup command to enter the required information for the MySQL database.
3. Enable the plugin using the Enable command or by updating the config.
4. Create your leaderboard(s).
5. Edit the leadarboards.yml or use the Setup command to enter the required information for your leaderboard.
6. Enable your leaderboard using the Enable command.
7. Create leaderboard signs and place heads above them.

Basic Tutorial


Advanced Tutorial


Customizing Signs



Sample MySQL Leaderboard.yml (Enemy Kills from "Stats" by Lolmewn)

Code (Text):

kills_pve:
  enabled: true
  separateNameTable:
    enabled: true
    nameTable: statsplayers
    sepNameCol: name
    sepIdCol: player_id
  sortByWorld:
    enabled: false
    worldCol: world
    worldName: world
  customColumn:
    enabled: true
    customCol: type
    rowValues: Skeleton, Creeper, Spider, Zombie, Ghast, Slime, Pig_zombie, Cave_spider, Silverfish, Enderman, Blaze, Magma_cube, Witch, Endermite, Guardian
  customColumn2:
    enabled: false
    customCol: customCol
    rowValues: rowValues
  statTable: statskill
  statName: amount
  statDisplay: Kills
  nameColumn: player_id
  hlbSize: 5
  reverseOrder: false
  statOnSameLine: true
  line0Format: red, bold, name
  line1Format: pink, magic, custom, sdfasdsafdsfadsdfd
  line2Format: pink, magic, custom, sdfasdsafdsfadsdfd
  line3Format: dark blue, bold, stat
 

Sample Flat File Storage Leaderboard.yml

Code (Text):

PVPKills:
  enabled: true
  filePath: \world\stats\
  usingUUID: true
  statName: stat.playerKills
  statDisplay: PVP Kills
  hlbSize: 5
  reverseOrder: false
  statOnSameLine: false
  line0Format: black, bold, header
  line1Format: dark blue, normal, name
  line2Format: dark red, bold, statdisplay
  line3Format: dark purple, bold, stat

Sample SQLite Flat File Storage Leaderboard.yml

Code (Text):

mob_kills:
  enabled: true
  separateNameTable:
    enabled: false
    nameTable: player_stats
    sepNameCol: name
    sepIdCol: player_id
  sortByWorld:
    enabled: false
    worldCol: world
    worldName: world
  customColumn:
    enabled: false
    customCol: type
    rowValues: values
  customColumn2:
    enabled: false
    customCol: customCol
    rowValues: rowValues
  statTable: player_stats
  statName: mobkills
  statDisplay: Mob Kills
  nameColumn: playername
  hlbSize: 5
  reverseOrder: false
  statOnSameLine: false
  line0Format: black, bold, header
  line1Format: dark blue, normal, name
  line2Format: dark red, bold, statdisplay
  line3Format: dark purple, bold, stat
  flatFileDB:
    enabled: true
    flatFilePath: \plugins\scoreboardstats\scoreboardstats.db

Commands

• /hlb setup - Start the setup utility to enter the Database information in Config.yml
• /hlb enable - Enables or disables the plugin
• /hlb create <leaderboard> <leaderboard type> - Creates a new leaderboard named <leaderboard>. Type must be either "sql" for MySQL or "ffs" for Flat File Storage.
• /hlb delete <leaderboard> - Deletes the leaderboard named <leaderboard>
• /hlb list - Lists all of your created leaderboards
• /hlb setup <leaderboard> - Starts the setup utility for the selected leaderboard
• /hlb enable <leaderboard> - Enables or disables the selected leaderboard
• /hlb reload - Reloads the plugin config files
• /hlbupdate - Updates all enabled leaderboards

Permissions

• hlb.commands - Allows user to use all hlb commands except hlb.update
• hlb.signs - Allows user to create and destroy HLB signs
• hlb.update - Allows user to use /hlbupdate command.

Color Codes for Signs
You can use either the "color name" or the "Minecraft Color Code", but do not use the &: black(0), dark blue(1), dark green(2), dark aqua(3), dark red(4), dark purple(5), gold(6), gray(7), dark gray(8), blue(9), green(a), aqua(b), red(c), light purple(d), yellow(e), white(f)

HLB Signs

Place a sign, putting [hlb] on the first line, <the leaderboard name> on the second line, and the position you want to display on the sign on the third line. Optional: Place a Skull above the sign (either directly above or on top of the block the sign is on). Run /hlbupdate or wait for the leaderboard to update!!|

Plugin Metrics
This plugin now uses Metrics. This will help me keep track of how many servers are using the plugin. The plugins metrics can be viewed using the link above. To opt out of metrics, set opt-out: to "true" in the metrics config in your plugins directory.

GitHub