Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revisionLast revisionBoth sides next revision | ||
custom_commands [2021/01/03 22:06] – [Custom Command Variables] Adjusted description of @calc@. Added % and mod operators. dante557 | custom_commands [2022/11/06 17:21] – Adjusted the db related variables (@savedb@, @readdb@, @cleardb@) descriptions to reflect purpose. Need to have a full look through to determine if the descriptions match the expectations of the values dante557 | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | {{keywords> | ||
===== Custom Command Variables ===== | ===== Custom Command Variables ===== | ||
- | + | On this page you will find all the variables that are currently available | |
- | On this page you will find all the variables that are currently available to use in your custom | + | |
- | 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 | + | You can organise this list by either searching for the keyword/variable or by clicking |
- | You can also search | + | Any variables that are exclusively |
- | Feel some more are needed? Request them over at our Twitter or Discord. | + | Feel more customisation is needed? Request them over at our [[https:// |
< | < | ||
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/ | ||
+ | | @obs@[DisableFilter%%|%%%%|%%Name of Source/ | ||
| @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. |
- | | @savedb@ | save to the key value store. e.g. @savedb@[5m%%|%%slots.@user@%%|%%50]. | + | | @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]. |
- | | @cleardb@ | + | | @cleardb@[Key to remove] | Clear the Key/Value database of any values |
- | | @token@ | parse strings like @target@ | + | | @token@[index%%|%%separator%%|%%search string] |
| @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' | + | | @queuepos[Queue Position%%|%%Queue Number] | Returns the viewer' |
+ | | @queuepos[Username%%|%%Queue Number] | Returns | ||
+ | | @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] | ||
| @toppoints@[X] | Returns a list of the viewers that hold the most amount of points/ | | @toppoints@[X] | Returns a list of the viewers that hold the most amount of points/ | ||
| @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' | |!uptime|Displays the stream' | ||
|!weather|Displays the current weather for the location specified|@weather@[@target@[1], | |!weather|Displays the current weather for the location specified|@weather@[@target@[1], | ||
+ | |!so| A shoutout command that says the game last played|< | ||
+ | /me Go Follow @target@ at www.twitch.tv/ | ||
+ | </ |