Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision		 Previous revision
custom_commands [2021/01/03 22:14] – [Custom Command Variables] Adjusted description of @token@ to be more informative. Moved arguments for variable to variable column. dante557custom_commands [2022/11/06 17:22] (current) – Added ; to donate start of list in @savedb@ variable dante557
Line 1: Line 1:
 +{{keywords>chatbot commands,custom commands,twitch chatbot,chatbot,chatbot custom commands}}
 ===== Custom Command Variables ===== ===== Custom Command Variables =====
- +On this page you will find all the variables that are currently available for you to use in your custom commands. \\
-On this page you will find all the variables that are currently available to use in your custom commands. \\ +
-Currently, there are over **80** different variables that you can use in your commands.\\+
 Please see the table below for the full list of variables available to you.\\ Please see the table below for the full list of variables available to you.\\
  
-You can organise this list by either searching for the variable that you want or by clicking the header names to organise in ascending or descending order.\\ +You can organise this list by either searching for the keyword/variable or by clicking on one of the column names.\\ 
-You can also search for a specific variable by using keywords. This will search all the columns for the containing that word.\\ +Any variables that are exclusively for Deepbot VIP subscribers will also be listed in the table below.\\ 
-Feel some more are needed? Request them over at our Twitter or Discord.+Feel more customisation is needed? Request them over at our [[https://www.twitter.com/DeepbotSupport|Twitter]] or [[https://discord.deepbot.tv/|Discord]].
  
 <datatable order='[[2,"asc"],[0,"asc"]]'> <datatable order='[[2,"asc"],[0,"asc"]]'>
Line 94: Line 93:
 | @obs@[StartStreaming]| Use this to make deepbot start your live stream in Obs with Obs remote | Yes | | @obs@[StartStreaming]| Use this to make deepbot start your live stream in Obs with Obs remote | Yes |
 | @obs@[StopStreaming] | Use this to make deepbot stop your live stream in Obs with Obs remote | Yes | | @obs@[StopStreaming] | Use this to make deepbot stop your live stream in Obs with Obs remote | Yes |
 +| @obs@[EnableFilter%%|%%%%|%%Name of Source/Scene%%|%%%%|%%Name of Filter]| Enable a filter that you have on your specified scene or source | Yes |
 +| @obs@[DisableFilter%%|%%%%|%%Name of Source/Scene%%|%%%%|%%Name of Filter]| Disable a filter that you have on your specified scene or source | Yes |
 | @raffleinfo@ | Shows information about the users raffle entry status | Yes | | @raffleinfo@ | Shows information about the users raffle entry status | Yes |
-| @readdb@ | read from the key value store. e.g. @readdb@[slots.@user@] | Yes | +| @readdb@[Key To Read] | Reads the provided key from the key/value database. e.g. @readdb@[slots.@user@]. If the value does not exist in the database, or has expired, this variable will return with a blank value. | Yes | 
-| @savedb@ | save to the key value store. e.g. @savedb@[5m%%|%%slots.@user@%%|%%50]. This saves the value 50 to key slots.@user@ with a 5 minute time to live. After 5 mins the value expires. TTL is a value in seconds, or you can use prefixes of m, h, d for minutes, hours, days. | Yes | +| @savedb@[TTL Value%%|%%Key To Change%%|%%Value To Save] | Save the provided value to the key/value database. e.g. @savedb@[60%%|%%slots.@user@%%|%%50]. The "Time To Live" (TTL) value is the number of seconds you want the provided value to be valid for. After this time has been suppassed, it will "expire" the value. You can append the TTL value with the following letters to treat it with add a different unit of time; m (minute), h (hour), d (day). | Yes | 
-| @cleardb@ | to clear values from the key value store starting with the specified key. e.g. @cleardb@[slots.] will remove all values with the key starting with slots. | Yes |+| @cleardb@[Key to remove] | Clear the Key/Value database of any values that contain the provided key. You can also a single key by specifying the key (i.e. to clear a key called "slots.expertsonline" - @cleardb@[slots.expertsonline]) or multiple keys that share the same pattern (i.e. to clear all keys that start with "slots" - @cleardb@[slots.]) | Yes |
 | @token@[index%%|%%separator%%|%%search string] | Like @target@ except returns the position based on the separating character (%%|%% cannot be used for the separating character in any instance). Example: @token@[3%%|%%,%%|%%one,two,three] would return three. | Yes | | @token@[index%%|%%separator%%|%%search string] | Like @target@ except returns the position based on the separating character (%%|%% cannot be used for the separating character in any instance). Example: @token@[3%%|%%,%%|%%one,two,three] would return three. | Yes |
 | @stream@ | Return the streamer username that is currently connected to Deepbot (Not the Bot Name) | No | | @stream@ | Return the streamer username that is currently connected to Deepbot (Not the Bot Name) | No |
 | @streamid@ | Return the user ID of the streamer account currently connected to Deepbot (Not the Bot Name) | No | | @streamid@ | Return the user ID of the streamer account currently connected to Deepbot (Not the Bot Name) | No |
-| @queuepos[Queue Position%%|%%Queue Number] | Returns the viewer's username that is currently in the queue position stated. I.e. @queuepos@[1%%|%%1] will return the viewer in position 1 in queue 1. If no viewer is currently in that position, this will return blank | No |+| @queuepos[Queue Position%%|%%Queue Number] | Returns the viewer's username that is currently in the queue position stated. If no viewer is currently in that position, this will return blank | No | 
 +| @queuepos[Username%%|%%Queue Number] | Returns the provided viewer's position in the specified queue. | No | 
 +| @queuewait@[Queue Position%%|%%Queue Number] | Returns the current wait time of the viewer that is current at the stated queue position. | No | 
 +| @queuewait@[Username%%|%%Queue Number]  | Returns the provided viewer's current wait time in the specified queue. | No |
 | @toppoints@[X] | Returns a list of the viewers that hold the most amount of points/currency in your channel. X can be a number between 1 and 14. | No | | @toppoints@[X] | Returns a list of the viewers that hold the most amount of points/currency in your channel. X can be a number between 1 and 14. | No |
 | @topranks@[X] | Returns a list of the viewers that hold the highest ranks in your channel. X can be a number between 1 and 14. | No | | @topranks@[X] | Returns a list of the viewers that hold the highest ranks in your channel. X can be a number between 1 and 14. | No |
Line 166: Line 170:
 |!uptime|Displays the stream's uptime|Current uptime: @uptime@ or @uptime2@| |!uptime|Displays the stream's uptime|Current uptime: @uptime@ or @uptime2@|
 |!weather|Displays the current weather for the location specified|@weather@[@target@[1], @target@[2]]| |!weather|Displays the current weather for the location specified|@weather@[@target@[1], @target@[2]]|
 +|!so| A shoutout command that says the game last played|<code>
 +/me Go Follow @target@ at www.twitch.tv/@target@ right now!! They were last playing @customjsonapi2@[{  "url": "https://api.twitch.tv/helix/channels?broadcaster_id=@customjsonapi2@[{  "url": "https://api.twitch.tv/helix/users?login=@replace@[@target@[1]|@|]",  "method": "GET", "path": "data.0.id",  "showResult": "true"}]",  "method": "GET", "path": "data.0.game_name",  "showResult": "true"}]
 +</code>|