Commands

Understand all the available commands in the bot and who can use them.

With the exception of !rank_medit, all commands in this bot are slash commands. The traditional text-based commands are no longer usable and you'll need to convert to the new system. While the internal permissions logic remains, you will have to enable the new commands via Discords' UI to use them in your server.

!rank_medit remains available for those who need it, but can only be used by @ mentioning the bot as a prefix eg @RankBot#9217 rank_medit

There are a number of commands in the bot. The majority of them are restricted due to the fact they provide certain levels of data about other users, below is a description of all these commands.

Public

The following commands are deemed to be public commands that are not specifically restricted to moderators. Please note that these are Slash Commands within Discord: they require that a user has a role that grants the permission Use Application Commands. To avoid chat clutter, these respond with an ephemeral message. An ephemeral message is one which is only displayed in the client to the user who invoked the command and do not count as an actual message.

The optout slash command exists for the purposes of complying with Discord Developer policies regarding a users' right to opt out of a ranking system. When the user uses this and opts out, the bot will warn them that doing so will prevent them gaining roles and permissions in the appropriate community.

Opt-out is on a per-guild basis: it is not global in every guild the bot is in, due to architectural design decisions of the backend.

Command	Description
rank	Displays the current post count and rank of the user that they have currently. If a user with a mod role uses this, it will additionally say the user can not rank up, if they are being excluded.
leaderboard	Toggles a users' opt-in status to being shown on any leaderboard in the server. If they are opted-in, this will opt-out and vice versa.
notify	Toggles a users' opt-in status to being notified publicly by the bot when they rank up through the system. If they are opted-in, this will opt-out and vice versa.
optout	Toggles a users' opt-out status to the entire ranking system. Users who opt-out will no longer be able to rank up through your servers' configured roles, and thus won't be able to gain permissions. If they are opted-in, this will opt-out and vice versa.

Moderator

Even if these commands are enabled for public use in Discords' UI, they can't be used unless the invoker has a defined "mod role". This is to prevent malicious use of the commands by accidental enablement of destructive functionality.

Due to Discords' UI regarding slash commands, you will be able to see what arguments you must pass to invoke the command and which arguments are optional, alongside descriptions of each. Thus, argument data is not provided below.

The following commands require the user to have a role that is defined by the "mod roles" setting described in the configuration page.

Command	Description
rank_other	Returns information about another user. This includes: The current internal post count Their current rank Whether they have the role associated to that rank Whether they've been blacklisted from ranking up When they last submitted a message

Usermod

These commands are used to modify another users' rank data internally.

All of these commands are part of a command group called /usermod and can be actioned individually via the Discord UI, which provides a brief description of what the subcommands do.

Command	Description
rank	Alters a users internal ranking in case they have become out of sync with the configuration ranks.
count	Alters a users internal post count. This is separate from the rank modifier above, in that only the counter is updated, not the rank. This can be useful if you want to manually update the count to account for missed messages.
allow	Unblocks a user from the ranking system. This is the inverse of the disallow command below. Replaces !rank_whitelist from before
disallow	Blocks a user from the ranking system, preventing them from ranking up further. Separate from exclusions, as this targets a specific user.

Stats

All of these commands are part of a group called /stats and can be actioned individually via the Discord UI, which provides a brief description of what the subcommands do.

Note that in all cases, the optional argument -- limit -- defaults to 15 records if you do not specify it in your invocation.

These commands allow you to get some basic statistics about the wider server.

Command	Description
highest	Get the users who have the highest post counts.
lowest	Get the users who have the lowest post counts. Very often this will be users with < 5 messages.
range	Get users within a range of message counts. Useful if you want to see who'll rank up next.

Utilities

Non specific restricted commands that don't fit any of the other sections

Command	Description
reload	Reload your guild configuration. You must do this after modifying the configuration using the dashboard panel, otherwise your changes will not be loaded.