| Both sides previous revision Previous revision Next revision | Previous revision |
| bot_commands [2017/12/31 11:57] – Added !internal_songchange_event to the list of commands under music dante557 | bot_commands [2021/12/13 08:59] (current) – Adding missing user access column to first section of Admin/Mod commands. Descriptions to be changed later dante557 |
|---|
| ====== Built-In Commands ====== | {{keywords>chatbot commands,custom commands,twitch chatbot,chatbot,chatbot custom commands}} |
| | ====== Built-In Channel Commands ====== |
| | <color #ed1c24>Please note: This page is under reconstruction - Please be patient while this happens. Thank you.</color> |
| |
| **__Table of Contents__** | Deepbot comes with a number of built-in commands that allow various tasks to be performed via chat. These can range from giving currency to your viewers to adding a quote which can be retrieved at a later point. |
| |
| * **[[bot_commands#All Users Commands|All Users Commands]]** | The following sections should hopefully show everything that can be done command wise out of the box. If any commands are missing please let us know |
| * **[[bot_commands#Music Commands|Music Commands]]** | |
| * **[[bot_commands#Admin Commands|Admin/Mod Commands]]** | |
| * **[[bot_commands#Raffle/Betting/Giveaway Commands|Raffle/Betting/Giveaway Commands]]** | |
| * **[[bot_commands#Auction Commands|Auction Commands]]** | |
| * **[[bot_commands#Betting Commands|Betting Commands]]** | |
| * **[[bot_commands#Custom Join Message Commands|Custom Join Message Commands]]** | |
| * **[[bot_commands#Keyword Raffle Commands|Keyword Raffle Commands]]** | |
| * **[[bot_commands#Quote Commands|Quote Commands]]** | |
| * **[[bot_commands#Ticket Raffle Commands|Ticket Raffle Commands]]** | |
| * **[[bot_commands#Custom Commands|Custom Commands]]** | |
| |
| ---- | ===== All Viewers Commands ===== |
| | Below are a list of commands that are available for all your viewers to use. For Convinience, these have been split into seperate sections that relates the most to the purpose of the command. |
| | ====== General Commands ====== |
| | A list of general commands that are available to be used by all viewersThe following commands are general commands that are available to all viewers, regardless of if they are a VIP, mod or streamer. |
| |
| ==== All Users Commands ==== | ^ Commands ^ User Access Required ^ Info ^ |
| | ^ !bot | All Viewers | Displays the current software version and a link to the Deepbot website. | |
| | ^ !cmdlist | All Viewers | Displays custom commands that have been added to the bot where "Hide from command list" has not been ticked. The way this is displayed to change will be different depending on settings set in "Master Settings"\\ \\ **//If "Show Full Command List On Deepbot Web Dashboard/Pastebin" is ticked//** - Link to Deepbot command dashboard (VIP Feature) or Pastebin (Non-VIP) is displayed.\\ **//If "Show Full Command List On Deepbot Web Dashboard/Pastebin" is not ticked//** - Subset of commands is posted to chat, up to the 500 character limit for a single message imposed by Twitch. | |
| | ^ !<currency name> | All Viewers | Returns information in the format set in **//Master Settings > Default Points String//**.\\ If you wish to use a custom command version that contains your currency name ensure that **//Master Settings > Only Allow Points To Be Checked On Bot Chat//** is ticked\\ When this option is ticked it will instead only return the format that is set in Master Settings if the viewer calls the points command in your bot's Twitch channel | |
| | ^ !hscard <card_name> | All Viewers | Returns information regarding the card in Hearthstone. If no card exists of the name in question the command will return nothing. \\ \\ **Card_Name** - The name of the Hearthstone card that you want further information on | |
| | ^ !vip | All Viewers | Return VIP information (Bronze/Silver/Gold) as well as when it is due to expire. Returns nothing if the viewer in question isn't VIP Bronze, Silver or Gold. | |
| |
| ---- | ---- |
| | ====== Admin/Mod Commands ====== |
| | The following are the list of mod only commands that are in Deepbot by default.\\ |
| | With any of these commands you can make them accessable to users that are not marked as mods in Deepbot by creating a custom command version which calls the mod command you require.\\ |
| | For these circumstances, you will need to set the "Run As" option when editing the custom command to **User (Elevated Access)** |
| |
| ^ Commands ^ Info ^ | ^ Commands ^ User Access Required ^ Info ^ |
| ^ !bankheist [x] |[x] is the number of points you want to risk. You can use this command to start a bank heist and gamble some of your points against the bot. Survive, and you will walk away rich! (e.g. !bankheist 100) | | ^ !addcmd <cmd> [%level] <message> | Mod Level 1 | Adds a custom command to Deepbot that can be executed by all viewers (Unless the optional level value is passed across).\\ \\ **<cmd>** is the name of the command that a viewer would need to call. i.e. !testCommand\\ \\ **[%level]** is an optional value that can be passed across to restrict the command to a specific user group. For this value you will need to add the % sign in front of the numeric user group value\\ The numberic levels are; 1. All viewers; 2. All VIP; 3. All VIP + Mods; 4. VIP Silver + VIP Gold; 5. VIP Silver + VIP Gold + Mods; 6. VIP Gold; 7. VIP Gold + Mods; 8. Mod Only; 9. Bot & Streamer Only.\\ \\ **<message>** is the message that should be posted to chat. Most [[custom command variables|Custom Command Variables]] are supported. \\ \\ **Examples of Usage**\\ !addcmd !exampleCommand This is a custom command for all viewers \\ !addcmd !exampleCommand %2 This is a custom command for all VIP viewers | |
| ^ !bets [x] [y] |When betting pools are open, it enters your bet of [x] points on option [y] (e.g. !bets 100 2). | | ^ !delcmd <cmd> | Mod Level 1 | Deletes the specified channel command from Deepbot\\ \\ **<cmd>** is the name of the command that you wish to delete. i.e. !testCommand | |
| ^ !betting help |Command to show users status of current betting pool. | | ^ !editcmd <cmd> <message> | Mod Level 1 | Edits the specified channel command in Deepbot.\\ \\ **<cmd>** is the name of the command that you wish to edit. i.e. !testCommand | |
| ^ !bid [x] |Enters a bid during an open auction. (e.g. !bid 400 to bid 400 points) | | ^ !add <points or %> <user/all> | Mod Level 2 | Add a specified amount of currency or a percentage of a user's current currency total to a specified user or to everyone in currently in chat. | |
| ^ !bot |Displays the current version of DeepBot and the link to the website. | | ^ !add custom <online/all> <user class id> <amount or %> | Mod Level 2 | Add a specified amount of currency or a percentage of a user's current currency total to a specified user group.\\ This can be to either everyone or to all online viewers that are a part of that user group. \\ \\ User Class options: 1. All Viewers, 2. All VIP, 3. All VIP + Mods, 4. VIP Silver + VIP Gold, 5. VIP Silver + VIP Gold + Mods, 6. VIP Gold, 7. VIP Gold + Mods, 8. Mod Only | |
| ^ !cmdlist |Display active channel commands for the stream. | | ^ !addautohost <stream> | Mod Level 2 | This command adds a stream to the Auto Hosting feature. \\ \\ **stream** The name of the Twithc channel that you want to add to the list. | |
| ^ !<currency name> |Displays the current points a user holds. (e.g. If the currency name is Karma, then the command is !karma.) | | ^ !delautohost <stream> | Mod Level 2 | This command removes a stream from the Auto Hosting feature. \\ \\ **stream** The name of the Twitch channel that you want to remove from the list | |
| ^ !dragrace [type] [x] [y] |Command to start/enter a drag race. [type] can be "win", "top2" or "top3" as detailed **[[dragrace|here]]**. Choose wisely! [x] is the number of points to bet and [y] is a number between 1-8 for the car you are betting on. | | ^ !addvideotoblacklist [VideoID] | Mod Level 1 | This command blacklists a specific YouTube video to prevent them from being added to the list of song requests. | |
| ^ !dragrace myinfo |Shows info about the bets you have placed on the running drag race. | | ^ !addusertoblacklist [Username] | Mod Level 1 | This command blacklists a specific Twitch user from being able to request songs/videos | |
| ^ !give <user> <amount> |Gives points from your account to another viewer. Can be restricted to Mods, VIPs or even opened up to regular viewers depending on the streamer's discretion. (This must be enabled in the Master Settings first in order for this command to work.) | | ^ !check <user> | Mod Level 1 | Check the stream currency balance for the specified user. (e.g. !check expertsonline) | |
| ^ !hscard [card_name] |Display details about Hearthstone cards. | | ^ !renameuser <old name> <new name> | Mod Level 2 | Change a user's name in the database to a different Twitch username. (e.g. !renameuser expertsoffline expertsonline) **[Mod Level 2 only]** | |
| ^ !poll help |Displays all options for the current poll. | | ^ !highlight <note> | Mod Level 1 | Timestamps a certain part of your stream for stream highlights. It saves it to the highlights log in your Deepbot Folder > Log folder. (e.g. !highlight FunnyMoment) | |
| ^ !<queuename> <message/note> |A command for viewers to join a queue with optional message/note. | | ^ !playnextsong | Mod Level 1 | Plays the next song in the playlist. | |
| ^ !<queuename> leave | A command for viewers to leave a queue. (e.g. !testqueue leave) | | ^ !playprevsong | Mod Level 1 | Plays the previous song in the playlist. | |
| ^ !<queuename> <message> | A command for viewers to update their queue note. (e.g. !testqueue new note) | | ^ !playsong | Mod Level 1 | Starts/resumes music. | |
| ^ !raffle help |A command to show users' status of current raffles. | | ^ !pausesong | Mod Level 1 | Pauses the song currently playing. | |
| ^ !ticket [x] |Enters an open raffle with specified number of tickets (e.g. !ticket 4 to purchase 4 tickets) | | ^ !removesong [x] | Mod Level 1 | Removes a song from the playlist by its number in the queue. For example, !removesong 5 will remove the 5th song that was requested. (This only works if you are using the internal YouTube player.) | |
| ^ !vip |Displays VIP info with rank and subscription expiry date. (Only works for VIPs.) | | ^ !permit | Mod Level 1 | Permits users to post links when link protection is enabled. | |
| ^ !vote [x] [y] |Vote for an option in a running poll. [x] is the option you want to vote on and [y] is an optional input for the number of votes (if multiple voting is allowed). | | ^ /r or /w | Streamer (Within Bot) | Respond to whispers in the Chat tab. (e.g. /r will respond to the last whisper, while /w <username> will whisper a specific user.) (VIP Exclusive) (In order for this to work, this must be enabled in the Master Settings by clicking the check box next to Enable Whisper messaging (Streamer)) | |
| | ^ !remove <points> <user> | Mod Level 2 | Removes a specified number of points from a user. (e.g. !remove 100 expertsonline) **[Mod Level 2 only]** | |
| | ^ !resetcounter <cmd> | Mod Level 1 | Resets the counter of a command. | |
| | ^ !startarena <mode> <amount> | Mod Level 2 | Mode 1 is Knockout Arena, where <amount> is the max wager, and Mode 2 is Tournament Arena, where <amount> is the entry cost into the tournament. (e.g. !startarena 1 100) **[Mod Level 2 Only]** | |
| | ^ !startautohost | Mod Level 2 | Starts auto-hosting. **[Mod Level 2 only]** | |
| | ^ !startguessinggame [preset name] | Mod Level 1 | A command for mods to start the guessing game. (e.g. !startguessinggame [preset name]) | |
| | ^ !stopautohost | Mod Level 2 | Stops auto-hosting. **[Mod Level 2 only]** | |
| | ^ !top [x] | Mod Level 1 | Displays [x] users with the highest amount of stream currency. [x] must be a number between 1 - 14. | |
| | ^ !tophours [x] | Mod Level 1 | Displays [x] users with the most number of hours watched. [x] must be a number between 1 - 14. | |
| | ^ !topranks [x] | Mod Level 1 | Displays [x] users with the highest stream ranks. [x] must be a number between 1 - 10. | |
| | ^ !updategame <game> | Mod Level 2 | Updates the current stream game/activity. **[Mod Level 2 only]** | |
| | ^ !updatetitle <title> | Mod Level 2 | Updates the current stream title. **[Mod Level 2 only]** | |
| | ^ !volume | Mod Level 1 | Checks the current volume of the internal YouTube player. | |
| | ^ !volume [x] | Mod Level 1 | Sets the volume of the internal YouTube player. [x] must be a value between 1 and 100. | |
| | ====== Minigame/Stream Interaction Commands ====== |
| | The following contains information regarding the commands that can be used with the minigames and stream interaction tools that are built into the bot. |
| | |
| | These are all located on the "Stream Interaction" tab within the bot. |
| | |
| | These have been split into seperate sections to better group the associated commands together. |
| | |
| | For any custom minigames that you can add to the bot please refer to the following page [[Custom Minigames|Community Made Mini-Games]] |
| | |
| | ===== Betting Commands ===== |
| | Betting is a minigame that allows viewers to use their accrued currency to predict a winning option\\ |
| | For more information on the betting module - [[betting|Betting]] |
| | ^ Commands ^ User Access ^ Info ^ |
| | ^ !bets [x] [y] | All Viewers | Command to place a bet when betting is open. [x] is the amount of points to bet and [y] is the option to select. I.e. !bets 100 2 | |
| | ^ !betting help | All Viewers | Command to show users status in the current betting pool. | |
| | ^ !betting start <maxbets> <housecut> <betting_on> <option1> <option2> | Mod Level 1 | Starts the betting system. (e.g. !betting start 100 0 This_is_a_test_bet yes no maybe ) [Use _ for space in text] | |
| | ^ !betting close | Mod Level 1 | Closes the betting pool. | |
| | ^ !betting cancel | Mod Level 1 | Cancels the betting pool. | |
| | ^ !betting winoption [x] | Mod Level 1 | Selects the winning option, where [x] is the winning option. (e.g. !betting winoption 2) | |
| | |
| | ^ Commands ^ User Access ^ Info ^ |
| | ^ !bankheist [x] | All Viewers | Defalt command to trigger the Bankheist minigame (If it is enabled).\\ [x] is the number of points to invest into the heist. I.e. !bankheist 100 \\ Default command can be changed if the streamer is a [[https://deepbot.tv/services|VIP Subscriber]] | |
| | ^ !bid [x] | Minigame/Stream Interaction | Custom | Command to put a bid in an open action. Command access can be filtered to just include viewers who are on Bronze, Silver or Gold in Deepbot's User Database. [x] is the amount of points to bid. I.e. !bid 100 | |
| | ^ !dragrace [type] [x] [y] | Minigame/Stream Interaction | All Viewers | **VIP COMMAND** - Command to start/enter a drag race. [type] can be "win", "top2" or "top3" as detailed **[[dragrace|here]]**. [x] is the number of points to bet and [y] is a number between 1-8 for the car you are betting on. I.e. !dragrace win 100 8 | |
| | ^ !dragrace myinfo | Minigame/Stream Interaction | All Viewers | **VIP COMMAND** - Command to show info about the bets you have placed on the running drag race. | |
| | ^ !give <user> <amount> | Minigame/Stream Interaction | Custom | Command to give points from one viewer to another. Command can be restricted access wises in Master Settings. Default: No one can use !give. I.e. !give dante557 100. | |
| | ^ !poll help | Minigame/Stream Interaction | All Viewers | Command to display all the available options on a currently running poll. | |
| | ^ !<queuename> <message/note> | Minigame/Stream Interaction | Custom | Command to enter a currently running queue with an optional message. Command can be access restricted when opening the queue. Running this command again will update the message currently held. I.e. !bestqueue You are the best | |
| | ^ !<queuename> leave | Minigame/Stream Interaction | Custom | Command to leave the currently running quue. I.e. !bestqueue leave A command for viewers to leave a queue. (e.g. !testqueue leave) | |
| | ^ !raffle help | Minigame/Stream Interaction | All Viewers | Command to she the user's status on current open raffles. | |
| | ^ !ticket [x] | Minigame/Stream Interaction | Custom | Command which allows the user to purchase tickets in order to enter the raffle. [x] refers to the number of tickets they require. I.e. !ticket 4 | |
| | ^ !vote [x] [y] | Minigame/Stream Interaction | All Viewers | Command to vote for an option on the currently running poll. [x] is the option Vote for an option in a running poll. [x] is the option you want to vote on and [y] is an optional input for the number of votes (if multiple voting is allowed). | |
| |
| |
| ---- | ---- |
| |
| ==== Music Commands ==== | ===== Music Commands ===== |
| |
| ---- | ---- |
| ^ !skipsong [x] |This is similar to the command above except that a user can skip the song by paying the veto cost, [x]. *Note: Veto powers may be expensive!* | | ^ !skipsong [x] |This is similar to the command above except that a user can skip the song by paying the veto cost, [x]. *Note: Veto powers may be expensive!* | |
| ^ !removesong |This command will remove the last song from the user that runs it. | | ^ !removesong |This command will remove the last song from the user that runs it. | |
| ^ !internal_songchange_event |This command is called whenever the song currently playing is changed. The song name is passed through as a @target@. You can create a custom version of this command to have the song playing be displayed on screen via the use of widgets. | | ^ !internal_songchange_event |This command is called whenever the song currently playing is changed. The song name is passed through as a @target@. You can create a custom version of this command to have the song playing be displayed on screen via the use of widgets. *Note:* This command will only be trigger when your stream is live. | |
| |
| ---- | ---- |
| ^ !volume |Checks the current volume of the internal YouTube player. | | ^ !volume |Checks the current volume of the internal YouTube player. | |
| ^ !volume [x] |Sets the volume of the internal YouTube player. [x] must be a value between 1 and 100. | | ^ !volume [x] |Sets the volume of the internal YouTube player. [x] must be a value between 1 and 100. | |
| |
| |
| |
| ---- | ---- |
| |
| ==== Raffle/Betting/Giveaway Commands ==== | ===== Auction Commands ===== |
| |
| ---- | ---- |
| |
| === Auction Commands === | |
| |
| ---- | |
| |
| |
| ^ Commands ^ Info ^ | ^ Commands ^ Info ^ |
| ---- | ---- |
| |
| === Betting Commands === | ===== Custom Join Message Commands ===== |
| | |
| ---- | |
| | |
| ^ Commands ^ Info ^ | |
| ^ !betting start <maxbets> <housecut> <betting_on> <option1> <option2> |Starts the betting system. (e.g. !betting start 100 0 This_is_a_test_bet yes no maybe ) [Use _ for space in text] | | |
| ^ !betting close |Closes the betting pool. | | |
| ^ !betting cancel |Cancels the betting pool. | | |
| ^ !betting winoption [x] |Selects the winning option, where [x] is the winning option. (e.g. !betting winoption 2) | | |
| | |
| ---- | |
| | |
| === Custom Join Message Commands === | |
| |
| ---- | ---- |
| ---- | ---- |
| |
| === Keyword Raffle Commands === | ===== Keyword Raffle Commands ===== |
| |
| ---- | ---- |
| ---- | ---- |
| |
| === Quote Commands === | ===== Quote Commands ===== |
| |
| ---- | ---- |
| ---- | ---- |
| |
| === Ticket Raffle Commands === | ===== Ticket Raffle Commands ===== |
| |
| ---- | ---- |
| ---- | ---- |
| |
| === Custom Commands === | ===== Custom Commands ===== |
| |
| ---- | ---- |