Skip to main content

What is a Leaderboard

Leaderboards are a way to track the progress of your users. They are a great way to encourage users to compete amongst each other to climb the leaderboard and to be rewarded for their efforts. Tourney Bot offers a way to do this directly, which we will get into later!

How to create a Leaderboard​

To create a leaderboard, you must first have Tourney Bot Premium. If you do not have it, you can look into getting it here

Now that you have Tourney Bot Premium, you can create a leaderboard by using the /leaderboard create. When using this command, it will ask you for a name for the leaderboard and a channel to post the leaderboard in. The name is simply just the name that you want to have for the leaderboard, but the channel is a little different. The channel option, though optional, will allow you choose which channel the leaderboard will be posted in.

/leaderboard create

This command has two parameters, name and channel. The name is a required option, while the channel is optional. If you do not specify a channel, the leaderboard will be posted in the channel that the command was used in.

Once the leaderboard is created, it will send a basic, empty embed to the channel that you specified, or the channel that you ran the command in. This depends on if you specified a channel or not. The embed will look something like this:

How to configure a Leaderboard​

Now that you have created a leaderboard, you can configure it to your liking.

To do this, you will use the /leaderboard config. This has one required parameter, which is the name of the leaderboard that you want to configure. Thankfully, you don't need to remember the exact spelling of the leaderboard name since all leaderboards that are active in your server will appear in an autocomplete box which you can select from. Once you've selected the name of the leaderboard, you will see a new message appear that shows all of your current configuration options.

This message will look something like this:

Leaderboard Config Embed

This embed will show 5 different configurable options and two buttons which are explained below.

Note: When you enter the config menu form, you will see that each option has a "value" inside of the text box, these are just the default values and do not reflect the current value of the option. Also, you do not need to fill in a value for each option, you can just fill in the ones that you want to change and the others will remain unchanged.

Configurable Options​

  • Name: This option will allow you to change the name of your leaderboard.
  • Entries Per Page: This option will allow you to change the amount of entries that are shown per page. (Default: 25)
  • Win Points: This option will allow you to change the amount of points that a user will within the leaderboard after they win a match. (Default: 2)
  • Tie Points: This option will allow you to change the amount of points that a user will within the leaderboard after they tie a match. (Default: 1)
  • Loss Points: This option will allow you to change the amount of points that a user will within the leaderboard after they lose a match. (Default: 0)

Configurable Buttons​

  • Basic Config: This button will allow you to change the basic configuration options of the leaderboard which are listed above.
  • Reset: This button will reset the configuration of the leaderboard to the default values. (Does not change the name of the leaderboard)

How to add users to a Leaderboard​

There are two ways to add users to a leaderboard, manually and automatically! Both offer their own benefits and drawbacks, so it's up to you to decide which one you want to use.

Adding Users Manually​

To add users manually, you will use the /leaderboard edit command. This command has several uses, but in this instance we will be using to add a user to the leaderboard.

/leaderboard edit has five (5) total parameters. leaderboard_name, action, and points are all required parameters, while player and team are optional. The leaderboard_name parameter is the name of the leaderboard that you want to edit. The action parameter is the action that you want to perform, and gives us three options; Add Points, Remove Points, and Set Points. In this case we either want to use the Add Points or Set Points action. The points parameter is the amount of points that you want to add/set for the user. The player parameter is the user that you want to add to the leaderboard. The team parameter is the team that you want to add to the leaderboard.

So, to add a user to the leaderboard, we would use the /leaderboard edit command like this:

  • /leaderboard edit leaderboard_name: Test Leaderboard action: Add Points points: 12 player: @diaboli
  • /leaderboard edit leaderboard_name: Test Leaderboard action: Set Points points: 4 player: 321776668605939715
  • /leaderboard edit leaderboard_name: Test Leaderboard action: Add Points points: 9 team: Best Team Ever
/leaderboard edit

For the player parameter, you can either use a mention, a user ID, or a username. The command will attempt to autocomplete names for you, so if you don't see the user you want to add you should try using their user ID instead.

For the team parameter, you can only use plain text and the command will attempt to autocomplete the team name for you. If the team name you entered does not exist, it will create a new team with that name.

Adding Users Automatically​

To add users automatically, along with updating their scores automatically, you will need to use the /leaderboard link command. This command only has one parameter, which is the name of the leaderboard that you want to link to the tournament. You will need to run this command within the #admin channel of a given tournament. Once you've properly run this command, it will automatically add all of the users that are in the tournament to the leaderboard and will update their scores automatically as they play matches! Yay for automation!

So, linking a tournament would look like this:

  • /leaderboard link leaderboard_name: Test Leaderboard
How many tournaments can I link to a leaderboard?

You can link as many tournaments as you want to a leaderboard, but you can only link one leaderboard to a tournament.

Role Rewards​

Role rewards are a great way to reward your users for their efforts in your tournaments. You can set up a role reward by using the /leaderboard ranking command. This command has three (3) total parameters. leaderboard_name and points are both required while role is not. The leaderboard_name parameter is the name of the leaderboard that you want to add a role reward to. The points parameter is the amount of points that the user needs to have in order to receive the role. The role parameter is the role that you want to give to the user, however if you do not specify a role the command will remove the role reward from specified leaderboard.

So, to add a role reward to a leaderboard, we would use the /leaderboard ranking command like this:

  • /leaderboard ranking leaderboard_name: Test Leaderboard points: 10 role: @LeaderboardSlayer
/leaderboard ranking

For the role parameter, you can either use a role ID, or a role name. The command will attempt to autocomplete names for you, so if you don't see the role you want to add you should try using their role ID instead.

Also, if a user falls below the point threshold to receive the role, the role will be removed from them.

Additional Commands​

Here are some additional commands that you can use to manage your leaderboards that were not special enough to get their own section.

/leaderboard delete​

This command will allow you to delete a leaderboard. This command has one required parameter, which is the name of the leaderboard that you want to delete. Thankfully, you don't need to remember the exact spelling of the leaderboard name since all leaderboards that are active in your server will appear in an autocomplete box which you can select from.

So, to delete a leaderboard, we would use the /leaderboard delete command like this:

  • /leaderboard delete leaderboard_name: Test Leaderboard

/leaderboard move​

This command will allow you to move a leaderboard to a different channel. This command has two required parameters, which are the name of the leaderboard that you want to move and the channel that you want to move it to. Again, all leaderboards that are active in your server will appear in an autocomplete box which you can select from. The channel parameter is the channel that you want to move the leaderboard to.

So, to move a leaderboard, we would use the /leaderboard move command like this:

  • /leaderboard move leaderboard_name: Mega Leaderboard channel: #leaderboard

/leaderboard export​

This command will allow you to export a leaderboard to a CSV file which includes the player/team name and the points each entry has. This command has one required parameter, which is the name of the leaderboard that you want to export. Again, all leaderboards that are active in your server will appear in an autocomplete box which you can select from.

So, to export a leaderboard, we would use the /leaderboard export command like this:

  • /leaderboard export leaderboard_name: Mega Leaderboard

Conclusion​

That's all there is to know about leaderboards! If you have any additional questions, feel free to join our Discord Server and ask in our #support channel!