Skip to content

Configure a tournament leaderboards in a room

Agustín San Román edited this page May 25, 2025 · 1 revision

Currently, there are two modules that can be used in order to configure a tournament leaderboards for a room: The Tour Leaderboards Module and the Custom Leaderboards Module.

Depending on your requirements, you may use one of them, or both, for a room.

Basic / Historical Leaderboards

If you want to keep a registry of the tournament stats of the users, you can go to the bot's control panel, in the Tour Leaderboards section, and add the room you want there.

You can configure the following after adding the room:

  • How points are calculated (amount of points that each result gives) and, optionally, the option to adjust the points by multiplying by the win/lose ratio.
  • If you want to count all tournaments (default), or if you prefer deciding manually by using the official command
  • You can also ban users from appearing in the leaderboards.

Make sure to check the commands for this module: https://github.com/AgustinSRG/Showdown-ChatBot/wiki/Commands-List#tour-leaderboards-module

Custom leaderboards

For a more customizable table, go to the bot's control panel, in the Tour Leaderboards (Custom) section, and add the room you want there.

You can configure the following after adding the room:

  • The room you want the table to be active on. You can have multiple tables in the same room. Use the same name as the name of the room to be able to use the commands like top or toursrank in the room without specifying the table name.
  • How points are calculated (amount of points that each result gives).
  • A custom title for the table. You can also change it by using the command tourldbcustom title, <Table>, <Title>.
  • A custom description for the table (appears below the title). You can also change it by using the command tourldbcustom description, <Table>, <Description>.
  • A list of aliases for the table, so you can use the commands with a shorter name.
  • A list of users to ban from appearing in the table.
  • To automatically make all tournaments official (if you want all tournaments in the room to count for the table), or if you prefer deciding manually by using the official command
  • If the bot should announce the results after a tournament ends (including the current table), or not.

A custom table has an Extra points column. These points are added or removed manually by the staff of the room, using the extrapoints <table>, <user:points>, [...] command. Example:

extrapoints Tournaments, ExampleUser:5
extrapoints Tournaments, BoTTT:+15, ExampleUser:-20

Additionally, room owners can use the following commands:

  • tourldbcustom title, <Table>, <Title> - Change the title of the table
  • tourldbcustom description, <Table>, <Description> - Changes the description of the table
  • tourldbcustom reset, <Table> - Resets the table

Make sure to check the commands for this module: https://github.com/AgustinSRG/Showdown-ChatBot/wiki/Commands-List#custom-leaderboards-module

Clone this wiki locally