Custom Leaderboards
As we know, with overrides you can create advanced setups, such as specific settings for an art category.
But the server leaderboard always shows stats based on all data recorded across the server. Custom Leaderboards are based on a subset of leaderboard data.
Custom Leaderboard Stats
Custom leaderboards work by creating custom leaderboard stats, and only recording them when specific overrides are applied.
Right now, custom leaderboard stats can be based on one of the following stats:
- Total Stars (
upvotes - downvotes) - Total Upvotes
- Total Downvotes
- Times On Starboard
- Most Starred Message
Creating Custom Leaderboards
Let’s use the following scenario:
You have a channel-based override Art that applies to 5 art-related channels. You run art competitions often and want to see leaderboards based on only the amount of stars gotten in these art channels.
-
The first thing you need to do is to create the custom leaderboard stat.
/custom-leaderboard create name Art Stars based-on Total Stars -
So far, this custom leaderboard stat exists but isn’t yet being recorded as it hasn’t been added to the override you want it to function on.
We want this stat to be recorded for the art channels, so let’s add it to the Art override.
/custom-leaderboard add stat Art Stars override Art
That’s it! Now, stars recorded in any of the art channels will add to the custom Art Stars stat. Now, if users want to view the custom Art Stars leaderboard, they can run the following command:
Reward Roles
You can also make reward roles with requirements based on custom leaderboard stats!
For example, to make it so that in order to get a specific role, a user must get a certain number of art stars (from the example above), you can run the following command: