Leaderboard Tutorials
Invite the Discord Bot
To get started with Team Up Bot, invite it to your Discord server by visiting the official Discord App Store and clicking the "Add App" button at the top right corner of the page or by clicking the "Invite the Bot" button below. The bot will be added to your server with the required permissions.
Permissions
The bot requires certain permissions to function properly. If you prefer, you can grant the minimum required permissions. Without any permissions, Discord will not create a role for the bot, and you'll need to create and associate a new role manually if you wish to grant permissions later.
Manage Roles
This permission allows Team Up to assign Discord roles to players when they reach a certain Elo rating. Only roles listed below Team Up's role in the server settings will be assignable. This is required to assign tiers (Discord roles) to players based on their Elo rating.
Embed Links
This permission allows Team Up to embed links to the leaderboard website. It is needed only if the channel where commands are used does not have embed links enabled.
Send Messages
This permission allows Team Up to send and edit messages in a Discord channel. It is required if you want to use the bot in a channel that does not have the "Send Messages" permission enabled.
Create your first leaderboard
To create your first leaderboard, you'll need to record a match. You can do this by using the /record_match slash command. This will create a leaderboard if one does not exist and update a leaderboard if it does exist. Players must be a member of your Discord server and be mentioned in the match recording. Here are some examples of how to record a match. Replace @player1, @player2, etc. with @ mentions of the players in your Discord server.
Record a 1v1 match with a winner and loser
Record a 1v1 tie
Record a 2v2 match with a winning team and losing team
Record a 2v2 tie
Monitor Leaderboard from Discord Channel
To monitor a leaderboard from a Discord channel, you can use the /monitor_leaderboard slash command. This creates a message with the leaderboard rankings that will update automatically when a match is recorded. It is recommended to create a separate Discord channel just for the leaderboard so that the leaderboard is easy to find and access. Here are some examples of how to monitor a leaderboard.
Monitor overall player rating
Monitor 2v2 team rating
Monitor 2s team rating
Create Tiers
To create tiers, you'll need to create Discord roles that will be assigned to members when they reach a certain Elo rating. Every role that you want Team Up to assign to a member must be sorted below Team Up's role in the Discord server settings. This will give the bot permission to assign the roles to the members. Go to Server Settings -> Roles and drag Team Up's Discord role above the Discord roles that you want to assign to members via the bot.
Then you can use the /set_tier slash command to set the tier. Here is an example of how to set a tier. Replace @discord_role with the Discord role that you want to assign to the member when they reach the required Elo rating.
Set a tier using the overall player rating (Default)
Set a tier using the 1v1 leaderboard
Rating Types
Team Up tracks multiple Elo ratings for players and teams. Here are the different rating types that are available.
Overall Player Rating
A combined rating that takes into account the performance of a player across multiple game types, such as 1v1, 2v2, 3v3v3, and more. This only takes even matches into account. For instance, a 1v2 match would not be included in the overall player rating. This is the default rating type.
Distinct Player Rating
This leaderboard ranks individual players based on their performance in distinct match types. For instance their ratings in 1v1, 1v2, 1v1v1, 2v2, and 2v2v2 matches would all be tracked separately.
Combined Player Rating
A rating based on the performance of individual players in matches with a team of a certain size. For instance a player would have a 2s combined rating that would take into account their performance in 2v2 and 2v2v2... matches. They would have a separate 3s rating for 3v3 and 3v3v3... matches.
Distinct Team Rating
This leaderboard ranks teams based on their performance in distinct match types. For instance their ratings in 2v2 and 2v2v2... matches would all be tracked separately.
Combined Team Rating
A rating based on the performance of teams in matches. For instance a team of 2 would have a 2s combined rating that would take into account 2v2 and 2v2v2... matches.
Versus
The versus field is used in many of the Team Up commands to specify the the number of teams and how many players are on each team. Versus is used in conjunction with the rating type to define a leaderboard. Here are some examples of how to use the versus field with the different rating types.
Overall Player Rating
The overall player rating type does not need the versus field. This is because the overall player rating takes into account all even matches regardless of the number of players on each team.
Distinct Player Rating
The versus field is needed for distinct player rating types. For instance, if you want to monitor a 2v2 player leaderboard, you would use the following command
Combined Player Rating
The versus field is needed for combined player rating types. For instance, if you want to monitor a 2s player leaderboard, you would use the following command
Distinct Team Rating
The versus field is needed for distinct team rating types. For instance, if you want to monitor a 2v2 team leaderboard, you would use the following command
Combined Team Rating
The versus field is needed for combined team rating types. For instance, if you want to monitor a 2s team leaderboard, you would use the following command