The Basics

Implement the library

There are two ways to implement the library.

• Using maven (recommended for intermediate - Take a look at the red alert below!)
• Copy & Paste McRankings class (recommended for beginners & allows modifying)

Create a new McRankings instance

McRankings mcRankings = new McRankings(YOUR_PLUGIN_INSTANCE);

or

McRankings mcRankings = new McRankings(YOUR_PLUGIN_INSTANCE).withPluginName("BedwarsPro");

or disable logging non-important messages as well:

McRankings mcRankings = new McRankings(this)
                .withPluginName("BedwarsPro")
                .withoutLogging();

By default McRankings uses the plugin name from the plugin.yml (recommended). The plugin name should not include whitespaces.

Create a new leaderboard

McRankings mcRankings = new McRankings(YOUR_PLUGIN_INSTANCE);
McRankings.Leaderboard leaderboard = mcRankings.getLeaderboard(0, "Bedwars Wins", "Wins", true);

The code above shows you how to create a new leaderboard. It requires the following paramters:

• Integer > Leaderboard ID - This should be an identifier, unique for each leaderboard
• String > Leaderboard Title - The title of the leaderboard
  • The title should be short and easy to undestand, for example Bedwars Wins or Total Diamonds Found
• String > Metric - The metric shows up behind the score, for example 100 Wins where Wins is the metric
• Boolean > HigherIsBetter - Set this to true if a higher score is better than a lower score