User Tools

Site Tools


custom_commands

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 [2019/02/23 14:32]
ianchandler1990
custom_commands [2020/06/11 22:23] (current)
expertsonline [VIP-Exclusive Command Variables]
Line 1: Line 1:
 ===== Custom Command Variables ===== ===== Custom Command Variables =====
  
-This is a list of all available ​custom command variables.+On this page you will find the list of all the custom command variables ​that can be added into your custom commands. VIP exclusive variables have been separated so that you are aware what variables require the VIP monthly subscription.
  
 +There are also a couple of message flags you can add to your commands which will change the way the command will be delivered. These can be found below. Please note that these are also VIP Exclusive but these have been seperated due to them technically not being variables.
 +
 +^ Message Flag  ^ Info ^
 +|/​chat ​         |This will force the message to post to Twitch chat no matter where the command source is from (Discord/​Whisper/​Chat)|
 +|/​discord ​      |This will force the message to post to your Monitor Discord channel(s) you have set in Master Settings no matter where the command source is from (Discord/​Whisper/​Chat)|
 +|/​discord=CHANNELNAME |This will force the message to post to the discord server linked in Master Settings to the channel name specified no matter where the command source is from (Discord/​Whisper/​Chat)|
 +|/w USERNAME ​   |This will whisper the specified user regardless of the command source (Discord/​Whisper/​Chat). Typically in commands this is used with /w @user@. This requires whisper integration to be turned on in Master Settings.|
 +|\r\n  ​       |This is used in the middle of a message to post everything after that on a new line. I.e. This will \r\n be posted over two lines|
 Looking for community-made commands/​mini-games?​ Looking for community-made commands/​mini-games?​
  
   * **[[user_custom_commands|User Made Commands]]**   * **[[user_custom_commands|User Made Commands]]**
   * **[[custom_mini-games|Custom Command Mini-Games]]**   * **[[custom_mini-games|Custom Command Mini-Games]]**
- 
-**__Table of Contents__** 
- 
-  * **[[custom_commands#​Regular Variables|Regular Variables]]** 
-  * **[[custom_commands#​VIP Exclusive|VIP Exclusive Variables]]** 
-  * **[[custom_commands#​Custom API Examples|Custom API Examples]]** 
-  * **[[custom_commands#​Custom Command Examples|Custom Command Examples]]** 
- 
- 
  
 ---- ----
  
-=== Regular Command Variables ===+==== Regular Command Variables ​====
  
 ---- ----
Line 71: Line 70:
 ---- ----
  
-=== VIP-Exclusive Command Variables ===+==== VIP-Exclusive Command Variables ​====
  
 ---- ----
Line 80: Line 79:
 | @ctt@[InsertCustomTweet] | This generates a link to tweet out a custom message specified. E.g. Support the stream by tweeting! <​nowiki>​@ctt@[Check out expertsonline @ http://​twitch.tv/​expertsonline playing @game@]</​nowiki>​ | | @ctt@[InsertCustomTweet] | This generates a link to tweet out a custom message specified. E.g. Support the stream by tweeting! <​nowiki>​@ctt@[Check out expertsonline @ http://​twitch.tv/​expertsonline playing @game@]</​nowiki>​ |
 | @customjsonapi@[URL,​field] | Custom API support to get parts of a JSON object. For example to get the status for a channel using user input - @customjsonapi@[%%https://​api.twitch.tv/​kraken/​channels/​@target@[1]%%,​status] (Note Twitch API requests now require you to pass a Client ID along with your request. See https://​blog.twitch.tv/​client-id-required-for-kraken-api-calls-afbb8e95f843#​.qvtr401fh for more info) | | @customjsonapi@[URL,​field] | Custom API support to get parts of a JSON object. For example to get the status for a channel using user input - @customjsonapi@[%%https://​api.twitch.tv/​kraken/​channels/​@target@[1]%%,​status] (Note Twitch API requests now require you to pass a Client ID along with your request. See https://​blog.twitch.tv/​client-id-required-for-kraken-api-calls-afbb8e95f843#​.qvtr401fh for more info) |
 +| @customjsonapi2@ | Custom API support with GET/POST capability as well as custom headers. \\ Example GET \\ @customjsonapi2@[{ ​ "​url":​ "​https://​postman-echo.com/​get", ​ "​method":​ "​GET", ​ "​headers":​ \[ "​Content-Type:​ application/​json"​ \],  "​path":​ "​data.args.foo1", ​ "​showResult":​ "​true"​}] \\ Example POST \\ @customjsonapi2@[{ ​ "​url":​ "​https://​postman-echo.com/​post", ​ "​method":​ "​POST", ​ "​payload":​ { "​args":​ { "​foo1":​ "​bar1","​foo2":​ "​bar2"​}}, ​ "​headers":​ \[ "​Content-Type:​ application/​json"​ \],  "​path":​ "​data.args.foo1", ​ "​showResult":​ "​false"​}]|
 | @datetime@[format] | Formatted date/time output. Formatting Details : https://​msdn.microsoft.com/​en-us/​library/​8kb3ddd4.aspx | | @datetime@[format] | Formatted date/time output. Formatting Details : https://​msdn.microsoft.com/​en-us/​library/​8kb3ddd4.aspx |
 +| @datetime@[secs] | Convert seconds to human friendly text |
 | @editpoints@ | Silently edits users' points in chat. Only runs when the command that includes this variable has User (Elevated Access) selected. E.g. @editpoints@[@user@%%|%%10] | | @editpoints@ | Silently edits users' points in chat. Only runs when the command that includes this variable has User (Elevated Access) selected. E.g. @editpoints@[@user@%%|%%10] |
 | @exec@ | Chains one or more commands from a single command. E.g. @exec@[5,​!bot] will run !bot after 5 seconds. | | @exec@ | Chains one or more commands from a single command. E.g. @exec@[5,​!bot] will run !bot after 5 seconds. |
Line 123: Line 124:
 | @userinfo2@[username] | Display info from the user in the user database e.g. @userinfo2@[@user@] | | @userinfo2@[username] | Display info from the user in the user database e.g. @userinfo2@[@user@] |
 | @userinfo3@[username] | Display info from the user in the user database e.g. @userinfo3@[@user@] | | @userinfo3@[username] | Display info from the user in the user database e.g. @userinfo3@[@user@] |
 +| @setuserinfo1@[username%%|%%new info] | sets info1 for the user in the user database |
 +| @setuserinfo2@[username%%|%%new info] | sets info2 for the user in the user database |
 +| @setuserinfo3@[username%%|%%new info] | sets info3 for the user in the user database |
 | @weather@[city,​ country code] | Checks the weather in any part of the world. E.g. @weather@[Rome,​ 00197] or @weather@[@target@[1],​ @target@[2]] | | @weather@[city,​ country code] | Checks the weather in any part of the world. E.g. @weather@[Rome,​ 00197] or @weather@[@target@[1],​ @target@[2]] |
 | @editvip@[user%%|%%vip_rank%%|%%+days] | Add vip to a selected user. Ei. @editvip@[@target@%%|%%3%%|%%+30] | | @editvip@[user%%|%%vip_rank%%|%%+days] | Add vip to a selected user. Ei. @editvip@[@target@%%|%%3%%|%%+30] |
-| /chat or /discord | /chat for messages to post in chat or /discord for it to post into discord. Choose which channel a custom command goes to in discord with /discord channel=name | 
-| /w | /w and the users name or @user@ will whisper the user that runs the command | 
-| \r\n | Use \r\n if you would like to skip a like which will make the bot post anything after it as a new message | 
 | @obs@[StartStreaming]| Use this to make deepbot start your live stream in Obs with Obs remote | | @obs@[StartStreaming]| Use this to make deepbot start your live stream in Obs with Obs remote |
 | @obs@[StopStreaming] | Use this to make deepbot stop your live stream in Obs with Obs remote | | @obs@[StopStreaming] | Use this to make deepbot stop your live stream in Obs with Obs remote |
 +| @raffleinfo@ | Shows information about the users raffle entry status |
 ---- ----
  
-=== Custom API Examples ===+==== Custom API Examples ===
 ---- ----
  
Line 145: Line 147:
 ---- ----
  
-=== Custom Command Examples ===+==== Custom Command Examples ​====
  
 ---- ----
custom_commands.1550932330.txt.gz · Last modified: 2019/02/23 14:32 by ianchandler1990