bot_commands

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
bot_commands [2021/08/29 12:20]
dante557 Shifted some sections around to flow.
bot_commands [2021/08/29 13:29] (current)
dante557 Added additional context to admin commands section
Line 1: Line 1:
-====== Deepbot Default Commands ====== 
 {{keywords>chatbot commands,custom commands,twitch chatbot,chatbot,chatbot custom 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> <color #ed1c24>Please note: This page is under reconstruction - Please be patient while this happens. Thank you.</color>
 +
 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.  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. 
  
-Please refer to the following sections for +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
  
-===== General Commands =====+====== General Commands ======
 The following commands are general commands that are available to all viewers, regardless of if they are a VIP, mod or streamer. The following commands are general commands that are available to all viewers, regardless of if they are a VIP, mod or streamer.
  
Line 17: Line 17:
 ^ !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. | ^ !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 Commands =====
 +
 +^  Commands  ^ User Access | Info    ^
 +^  !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 |
 +^  !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 |
 +^  !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 |
 +^  !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. |
 +^  !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  |
 +^  !addautohost [stream]  |This command adds a stream to the Auto Hosting feature. (e.g. !addautohost ExpertsOnline) **[Mod Level 2 only]**  |
 +^  !delautohost [stream]  |This command removes a stream from the Auto Hosting feature. (e.g. !delautohost ExpertsOnline) **[Mod Level 2 only]**  |
 +^  !addvideotoblacklist [VideoID]  |This command blacklists specific YouTube videos to prevent them from being added to the list of song requests.  |
 +^  !addusertoblacklist [Username]  |This command blocks a specific user from requesting songs.  |
 +^  !check <user>  |Check the stream currency balance for the specified user. (e.g. !check expertsonline)  |
 +^  !renameuser <old name> <new name>  |Change a user's name in the database to a different Twitch username. (e.g. !renameuser expertsoffline expertsonline) **[Mod Level 2 only]** |
 +^  !highlight <note>  |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)  |
 +^  !playnextsong  |Plays the next song in the playlist.  |
 +^  !playprevsong  |Plays the previous song in the playlist.  |
 +^  !playsong  |Starts/resumes music.  |
 +^  !pausesong  |Pauses the song currently playing.  |
 +^  !removesong [x]  |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.)  |
 +^  !permit  |Permits users to post links when link protection is enabled.  |
 +^  /r or /w  |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>  |Removes a specified number of points from a user. (e.g. !remove 100 expertsonline) **[Mod Level 2 only]**  |
 +^  !resetcounter <cmd>  |Resets the counter of a command.  |
 +^  !startarena <mode> <amount>  |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  |Starts auto-hosting. **[Mod Level 2 only]**  |
 +^  !startguessinggame [preset name]  |A command for mods to start the guessing game. (e.g. !startguessinggame [preset name])  |
 +^  !stopautohost  |Stops auto-hosting. **[Mod Level 2 only]**  |
 +^  !top [x]  |Displays [x] users with the highest amount of stream currency. [x] must be a number between 1 - 14.  |
 +^  !tophours [x]  |Displays [x] users with the most number of hours watched. [x] must be a number between 1 - 14.  |
 +^  !topranks [x]  |Displays [x] users with the highest stream ranks. [x] must be a number between 1 - 10.  |
 +^  !updategame <game>  |Updates the current stream game/activity. **[Mod Level 2 only]**  |
 +^  !updatetitle <title>  |Updates the current stream title. **[Mod Level 2 only]**  |
 +^  !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.  |
 ====== Minigame/Stream Interaction Commands ====== ====== 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. 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. These have been split into seperate sections to better group the associated commands together.
Line 118: Line 156:
 ^  !auction open <min bid> <item>  |Opens the auction. (e.g. !auction open 10 100m)  | ^  !auction open <min bid> <item>  |Opens the auction. (e.g. !auction open 10 100m)  |
 ^  !auction close  |Closes the auction.  | ^  !auction close  |Closes the auction.  |
- 
----- 
- 
-===== Betting 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)  | 
  
 ---- ----
  • bot_commands.txt
  • Last modified: 2021/08/29 13:29
  • by dante557