-
Notifications
You must be signed in to change notification settings - Fork 2
Commands
Daniel Perales Mauriz edited this page Apr 20, 2022
·
48 revisions
These are the commands that HelpBot has, and whose permissions and operation can be configured through the commands.json configuration file, as described in the "Configuration" section.
The syntax notation of these commands follows the following rules:
- Square brackets: [optional argument]
- Angle brackets: <required argument>
- Curly braces: {default argument}
- Parenthesis: (miscellaneous info)
- Double quotes: "literal text argument"
- Vertical bar: possibility1 | possibility2
In this article, the command syntax is described using the default
!prefix, although this may be different if you have set a different prefix, as detailed in the "Configuration > main.json" section.
| Command | Aliases | Syntax | Description |
|---|---|---|---|
| help | commands, command, cmds, cmd, ? | !help [command name] |
It shows a list with the bot's commands, or the help for a single one. |
| ping | status | !ping |
Provides information about the state of the bot. |
| Command | Aliases | Syntax | Description |
|---|---|---|---|
| leaderboard | levels | !leaderboard [page number] |
It shows the guild XP leaderboard. |
| stats | rank | !rank [@member | id] |
Shows your or another member's XP stats. |
| xp | modifyxp | !xp <@member| id> <"set" | "add" | "addrandom" | "remove" | "clear"> <quantity> |
Modifies the amount of XP of a member. - set: Assigns a specific amount. - add: Adds a certain amount. - addrandom: Adds the XP corresponding to X number of messages. - remove: Removes a certain amount of XP. - clear: Initializes the member's XP to 0. |
| Command | Aliases | Syntax | Description |
|---|---|---|---|
| warn | !warn <@member| id> <reason> |
Adds a warning to the member. | |
| rmwarn | pardon | !rmwarn <@member| id> <warn ID | "all"> [reason] |
To remove a warning (or all) to a member. |
| infractions | warns | !infractions [@member | id] |
It shows a list with the warns of a member and their respective IDs. |
| slowmode | slow | !slowmode <"off" | seconds> [reason] |
Activates slow mode on a text channel. |
| tempmute | !tempmute <@member| id> <seconds"S" | minutes"M" | hours"H" | days"D"> [reason] |
Temporarily mutes a member from text and voice channels. | |
| mute | !mute <@member| id> [reason] |
Mutes a member from text and voice channels. | |
| unmute | !unmute <@member| id> [reason] |
Unsilences a member. | |
| kick | !kick <@member| id> [reason] |
Kicks a member. | |
| tempban | !tempban <@member| id> <seconds"S" | minutes"M" | hours"H" | days"D"> [reason] |
Bans temporarily a member. | |
| ban | !ban <@member| id> [reason] |
Bans a member. | |
| softban | !softban <@member| id> <days (1-7)> [reason] |
Bans a member, deleting X days worth of messages from him. | |
| unban | !unban <@member| id> [reason] |
Unbans a member. |
| Command | Aliases | Syntax | Description |
|---|---|---|---|
| join | j | !join |
Connects the bot to your voice channel. |
| leave | le, stop | !leave |
Causes the bot to leave your voice channel. |
| play | p, resume | !play [YouTube URL | search term] |
Searchs for a song or playlist by name or YouTube URL, or if you don't provide parameters, resumes the queue. |
| playskip | ps | !playskip <YouTube URL | search term> |
Searchs for a song or playlist by name or YouTube URL, and skips the actual track. |
| sound | snd | !sound [sound name | "list"] |
Plays a .mp3 file from the media/audios folder, or shows a list of them. |
| skip | s | !skip [amount | "all"] |
Skips the current track, or a specified amount. |
| pause | !pause |
Pauses the playback queue. | |
| nowplaying | np | !nowplaying |
Shows information about the current track. |
| queue | q | !queue [page number] |
Shows the tracks that are in the queue. |
| clear | cls | !clear |
Empties the playback queue. |
| move | mv | !move <position 1> <position 2> |
Modifies the position of a track in the queue. |
| remove | rm | !remove <position | "all"> |
Removes a track from the play queue. |
| replay | rp | !replay |
Replays the current track from the beginning. |
| loop | l | !loop |
Loops the current track. |
| loopqueue | lq | !loopqueue |
Loops the playback queue. |
| shuffle | sh | !shuffle |
Activates shuffle mode in the play queue. |
| seek | sk | !seek <HH:MM:SS> |
Changes the time of the song to a specific timestamp. |
| forward | fw | !forward <HH:MM:SS> |
Advances the moment of a song by a specified amount of time. |
| rewind | rw | !rewind <HH:MM:SS> |
Moves back the moment of a song by a certain amount of time. |
| Command | Aliases | Syntax | Description |
|---|---|---|---|
| invitation | perminvite, invite | !invitation |
Generates or retrieves a permanent invite link in the rules channel, or in the first text channel that allows it. |
| poll | !poll ["new" | "end"] [id] |
Starts an interactive wizard to create a poll, or ends an ongoing one. | |
| purge | clean | !purge <quantity> [#channel | id] |
Deletes a certain number of messages in a channel (as long as they are less than 14 days old). |
| send | !send <"embed" | "normal"> <message> |
The bot will send a message to the current text channel, with or without embedded formatting. | |
| edit | !edit <#channel | id> <message ID> <new content> |
Edits a message previously sent by the bot. | |
| dm | direct | !dm <@member | id> <"author" | "anonymous"> <"embed" | "normal"> <message> |
The bot will send a message to the member, anonymously or with the referenced author, with embedded format or not. |
| serverinfo | server, guildinfo, guild | !serverinfo |
Shows information about the guild. |
| userinfo | user, memberinfo, member | !userinfo [@member | id] |
Shows information about you or any other member. |
| roleinfo | role | !roleinfo <@role | role name | id> |
Shows information about a role. |
| run | execute, exec | !run <script> [parameter/s] |
Runs one of the pre-programmed scripts (see the "Preprogrammed scripts" section). |
💡 In case you have any questions about how to use the bot, or anything else related to this repository, you can make use of the support Discord Server.