The mc-rankings.yml

Below is an example how the mc-rankings.yml looks like:

license-key: r3FGj5pF0kShI5
server-key: OzTGWrTAW1T4s
server-name: c57983b6-a59b-4ab4-97c1-035b9c932737
api-endpoint: <https://mc-rankings.com/api/v1/>
frontend-url: <https://mc-rankings.com/><serverName>/<pluginName>/<id>
enabled: true
leaderboards:
  McRankingsCoreTest:
    '0':
      title: 'Bedwars Wins'
      metric: Wins
      higherIsBetter: true
      secret-key: MusJSAHLv0A7
			enabled: true

Important

<aside> ⚠️ It is recommended to backup your original mc-rankings.yml file!

</aside>

Edit server-name

• The server-name shows up in the URL and if you change it the URL changes too!
• If another server uses your server-name it wont work - Make sure it is unique
• The server-name should not contain any whitespaces

Edit title

• You can change the title of your leaderboards - Make sure this value is not empty, or your leaderboard wont load correctly.

Disable the library completely (Only version 1.2.7+)

If you want to disable mc-rankings completly on your server, but the plugin you use does not have a setting for this, you can disable it by changing enabled to false in your mc-rankings.yml. If you want to remove the leaderboards, first set the leaderboards to disabled and then reload the server. After this steps you can disable the library.

Disable/enable leaderboards (Only version 1.2.7+)

You can now enable / disable leaderboards by setting the value enabled to true / false. If you do not have the option, add it to the config and make sure your plugin also has the newest version of mc-rankings.

What is the server-key?

• You should keep the server-key secure. Anyone with your server-key can create and modify your server-name and leaderboards.
• If you lost your server-key you have to set a new one. It can be any String but should be secure and unique - like a password

Configuration for BungeeCord