Documentation Twitch

Transcript

1 Streamlabs Chatbot Documentation

2 HOW TO SETUP STREAML ABS CHATBOT?! ... ... ... 4 ... ... B ... ... ... ... ... 4 WITCH T OT S TREAMER ... ... ... ... ... ... 5 T WITCH ISCORD B ... ... ... ... ... ... 7 D OT ... AME ... ... ... ... ISP ... 11 G W TREAMLABS ... ... ... ... ... ... 13 S LOUD C ... ... ... ... ... 14 ... ... ... ... ... ... EMOTE ... 16 OBS R MPORTING D ATA FROM ANOTHER B OT ... ... ... ... ... 17 I ... ... ... ... 19 ... FEATURES ONSOLE ... ... ... ... ... ... 19 C ... ASHBOARD ... ... ... ... D 20 ... C OMMANDS ... ... ... ... ... ... 21 T IMERS ... ... ... ... ... ... 23 ... UOTES ... ... ... ... ... 24 Q XTR A Q UOTES ... ... ... ... ... ... 25 E OUNTER C ... ... ... ... ... ... 26 ... IVE WAY ... ... ... G ... ... 27 A S OUND F ILES ... ... ... ... ... ... 28 C URRENCY ... ... ... ... ... ... 29 ... B ... ... ... ... ... 31 ETTING P OLL ... ... ... ... ... ... 32 ... M - H EIST ... INIGAMES ... ... ... .. 33 M INIGAMES – D UEL ... ... ... ... ... . 34 ... ... 35 M INIGAMES – F REE FOR A LL ... ... ... M INIGAMES B OSS B ATTLE ... ... ... ... ... 36 – ... VENTS ... ... ... ... ... 38 E ONGREQUEST ... ... ... ... ... ... 39 S UEUE Q ... ... ... ... ... 40 ... ... N ... ... ... ... ... 41 OTIFICATIONS M OD T OOLS ... ... ... ... ... ... 42 D ISCORD ... ... ... ... ... ... 43 SERS ... ... ... ... U ... ... 44 ... ... ... ... ... 45 SETTINGS G ENERAL ... ... ... ... ... ... 45 ... L ... ... ... ... ... 46 OCALIZATION U SAGE ... ... ... ... ... ... 46 M ACROS ... ... ... ... ... ... 47 H OTKEYS ... ... ... ... ... ... 47 ... TYLE ... ... ... ... 48 S ... HANGE L OGS ... ... ... ... ... ... 48 C ... PERMISSION LEVELS ... ... ... 49 ... ... ... ... ... USAGE LEVELS 49 ... PARAMETERS ... ... ... ... ... 50 B ASIC P ARAMETERS ... ... ... ... ... .. 50 C URRENCY ARAMETERS ... ... ... ... ... 54 P ... WITCH P ARAMETERS ... T ... ... ... 55 API F ILE R EADING P ARAMETERS ... ... ... ... ... 57 C API R EADING P ARAMETER ... ... ... ... ... 57 USTOM ... S F ILE P ARAMETERS AVE ... ... ... ... 57 ... ... 58 M ISCELLANEOUS P ARAMETERS ... ... ... ©Streamlabs.com 2

3 ... ERATED TEXT FILES ... ... GEN ... .. 58 . 61 STREAMLABS CHATBOT P YTHON SCRIPTING ... ... ... ... ... ETUP ... ... S ... ... 61 ... 62 FAQ ... ... ... ... ©Streamlabs.com 3

4 How to setup ?! Streamlabs Chatbot Twitch Bot Step 1: Make sure you’ve made a Twitch.tv account for the bot Go to Twitch.tv and create a new account for the bot to use. Step 2 : Go to Connections Simply navigate to the bottom left corner of the screen and click on which will open the Connections window and then click on " Twitch Bot " . Step 3 : Generating a Token Click on Generate Oauth Token , this will open a the Authorization page on the bot. - Step 4 : Click Authorize " Click Authorize " and this will automatically fill in the token in to the token field. Step 5 : Picking your Connection Type . If you connect under Regular you will be Regular or Secu re " There are two options here " connecting through Port 80. If you decide to connect under Secure you will be connecting through Port 443. ©Streamlabs.com 4

5 Step : Click Connect 6 If you’ve done everything correctly your account will be connected to chat. If yo u get a pop up telling you the token does not belong to the Twitch name you typed into the username field then you were probably logged into the wrong account on Twitch.tv. Twitch Streamer 1 : Go to Connections Step Simply navigate to the bottom left corner of the screen and click on which will open the Connections window and then click on " Twitch Streamer ". Step 2 : Generating a Token Click on Generate Oauth Token , this will open a the Authorization page on the bot. - 3 : Click Authorize Step Click " Authorize " and this will automatically fill in the token in to the token field. Step : Click Connect 4 If you’ve done everything correctly your account will be connected to chat. If you get a pop up telling you the token does not belong to the Twitch name y ou typed into the username field then you were probably logged into the wrong account on Twitch.tv. Step 5 : Access to Features ) Notifications require your Streamlabs Account to be Follow, Host, Subscription ( Chat connected. Cheer Notifications require you to have your Streamer Account connected. ©Streamlabs.com 5

6 ©Streamlabs.com 6

7 Discord Bot Step 1: Go to this website Go to https://discordapp.com/developers/applications/me Step 2: Click on New App Click on to star New App t the creation process. " " Step 3: Create your Application In order for the bot to connect to Discord you’ll have to setup an application. This is what this will be the name of your bot on you will be doing on this page. Fill in the AppName Discord. I suggest using the same name on Twitch so it’s easier for your viewers. If you want the bot to have a nice little icon be sure to set it as well. The Description doesn’t nything you like in there. matter too much but you can just put a ©Streamlabs.com 7

8 Step 4: Create a Bot User After you have clicked " Create App " you will be redirected to the next page. Here you will Create a Bot User " " have to Click on . This will create a Bot account for you using the AppName as the Bot’s Username. Step 5: Changing Settings After you’ve created the Bot User you will see a few more options have appeared above. Right under the App Bot User you will have to Uncheck Public bot since the bot will only work in the First channel it does not support usage in connects to. Streamlabs Chatbot multiple Discord channels. ©Streamlabs.com 8

9 Step 5: Client ID & Token Click on " click to reveal " right next to the Token of the App Bot User. You will need the Client ID & Token in the next few steps so be sure to keep this page open. Step 6: Go to Connections Simply navigate to the bottom left corner of the screen and click on which will open the Connections window and then click on " . Discord Bot " Step 7: Enter Client ID & Token Enter your Client ID into th e Client ID field, the Token into the Oauth - Token field. Next up enter the channel the bot will moderate in, by default this is " . This requires the text " bot channel to actually exist on your discord server. ©Streamlabs.com 9

10 Step 8: Joining your Discord Server You’ve done all the hard work now. The only thing that remains to be done is to have the bot Join your Discord Server. After filling out the fields as specified in the previous step click on " Join Server " . This will open a web page in which you will be abl e to pick which server the bot connects to. Pick the server and finally click on " Authorize " . On a side note the bot will only work in the first server it connects to. So be sure it’s the right one otherwise you’ll have to ask the server owner to kick the bot from their server or you have to restart the process by creating a new Application and App Bot User. Step 9: Connecting the Bot to your Discord Server Simply click on " Connect " and the bot should connect to Discord if you’ve done everything correctl y. Step 10: Linking Twitch & Discord Accounts to use Commands The bot will not reply to users that are attempting to use commands if they’ve not linked their Twitch and Discord account. This is especially important seeing as the bot needs to ctual user of the command is on Twitch to Display their points, handle know who the a permissions, etc... This process can be started by DMing the bot on Discord with !linkdiscord. The bot will tell correctly the you to message it something through Twitch Whispers. If that has been done accounts will be linked together and the user can use commands just as they would on twitch. In case a user wants to unlink their accounts they can simply DM the bot !unlinkdiscord and it will be done. ©Streamlabs.com 10

11 GameWisp Step 1: Make sure you have a GameWisp account If you’re not partnered on Twitch but you want a way for your Viewers to Subscribe to you and support you then GameWisp is a good idea. Simply go to http://GameWisp.com and c reate an account. If you already have one simply go to Step 2. Step 2: Go to Connections which will Simply navigate to the bottom left corner of the screen and click on " . " open the Connections window and then click on GameWisp Step 3 : Generating a Token Click on . on the bot " Generate Token " this will open the Authorization page ©Streamlabs.com 11

12 : Click Authorize Step 4 " Click " Authorize and this will automatically fill in the token in to the token field. Step 5 : Click Connect In case you’re also partnered on Twitch an d want GameWisp subscribers to be able to join he Twitch Subscriber giveaways and make use of Twitch Subscriber commands check t checkbox. " click " Connect Finally and if everything went well then your GameWisp will be connected. Step 6: Refreshing the Database tab on the Main UI and click the Refresh button to grab all your Next go to the Subscribers current GameWisp Subscribers. ©Streamlabs.com 12

13 Streamlabs Step 1: Go to Connections Simply navigate to the bottom left corner of the screen and click on which will n the Connections window and then click on " Streamlabs ". ope Step 2: Generating a Token Click on " Generate Token " this will open the Authorization page in on the bot . Step 3: Click Authorize Approve to the token field. and this will automatically fill in the token in Click " " Click Connect Step 4: Finally click " Connect " and if everything went well then your Streamlabs will be connected. Now you can set how much someone gains for every $/€/... someone donates under the currency system. to post an in chat notification then go to Notifications and enable the If you wish for the bot Streamlabs Donate Notification. Step 5: Enable Chatbot pages on your Streamlabs Tipping Page Go to Settings - > General - > Scroll to Show Chatbot Tab on Donations Page and enable it. Af > Streamlabs and - terwards pick which tabs you want to show. Next go to Connections click Sync to sync your Commands & Quotes. The Playlist, Songlist and Queue auto sync every 2.5 minutes so no need to manually sync those. ©Streamlabs.com 13

14 Cloud Step 1: Disclaimer er to use this you will either have to have Dropbox, Google Drive or another similar In ord Cloud service’s c lient installed on your system. These services usually come with a dedicated server on your Computer from where data will loud. automatically be synced to the c You’ll have to set these up on your own seeing as there are more than enough tutorials on youtube. Dropbox: https://www.dropbox.com/install Google Drive: https://www.google.com/drive/download/ Step 2: Go to Connections Simply navigate to the bottom left corner of the screen and click on which will open the Connections window and then click on " Cloud " . Step 3: Picking your Cloud Folder Path click " . " Click on " Pick Folder " and Navigate to Cloud Service of Choice’s Local folder and Save This is where the bot will be able to output Automated Backups and Excel files which you can share with the stream. In case you want the bot to create automated backups check the box and set the interval of the backups. Do mind though that the bot does not delete older backups so this is your responsibility. Once in a while be sure to delete some of the older ones so your Cloud data doesn’t get capped out. Click " Save Settings " to finish the process. Step 4: Sharing a Link to Excel Files Click " Create Excel Files " this will generate 3 excel files based on your data. The Data.xlxs will contain your Commands, Timers, SFX, Events, Points, Ranks, ... As for the Songlist.xlsx this will contain your Songlist. The Queue.xlsx will contain your Queue. Now that those files exist navigate to your Cloud folder, right click on the file for which you want a link. have a link copied to your " this will In case you’re using Dropbox click on " Copy Dropbox Link clipboard. ©Streamlabs.com 14

15 - " " In case you’re using Google Drive click on " Google Drive " - > " Share " Get Shareable Link > and copy the link. http://tinyurl.com Now you can either a short link using or use the full link in your commands. Create Read Only Excel Files " . The Data files only get created whenever you click " ©Streamlabs.com 15

16 OBS Remote Step 1: Open your Browser Nex t up make sure you have the OBS Remote Plugin installed if you do not then go here: of https://obsproject.com/forum/resources/obs - websocket - remote - control - - obs - studio - made - easy.466/ and install the plugin. Step 2: Open OBS > Websocket Server Settings inside of OBS and it will pop up a small window - Go to Tools that allows you to configure the OBS Remote Plugin. Set which port you wish to use there and Enable Authentication. After doing so plug in a password that you wish to use so only authorized clients may connect to your OBS. Once you are done just click OK to save your settings. Step 3: Go to Connections which will Simply navigate to the bottom left co rner of the screen and click on OBS Remote ". open the Connections window and then click on " Step 4: Fill in the fields If Streamlabs Chatbot is running on the same PC as your OBS then simply leave the IP to 127.0.0.1 if you are running a two PC setup and OBS is on another system the fill in the IP of your second PC which is running OBS. ngs then change it here as well. If If you changed the port in the OBS Websocket Server Setti you are using Authentication then fill in your password. Step 5: Click Connect Finally click connect and the bot will connect to your OBS allowing you to create commands te your mic when you're being a dummy, and scripts which hide/show specific sources, Unmu Stop your stream when you pass out directly from chat so people can't watch you snooze away,... ©Streamlabs.com 16

17 Importing Data from another Bot - > Open External Bot Importer Simply click on the ? in the top Right DeepBot In order to import Data from Deepbot you need to have Deepbot Premium. If you have DeepBot Premium follow these simple steps in order: 1. Open DeepBot 2. Navigate to your Master Settings 3. Look for your API Secret 4. If the secret is empty simply refresh it 5. API Secret Copy your 6. Click Save in the Master Settings 7. Then open Streamlabs Chatbot Plug your API Secret into the API Key Field 8. 9. Select what type of data you wish to Import 10. Click Import to start Importing data PhantomBot In order to Import Data from Phantombot you need to navigate to your phantombot.db file. Once you have done that select which data you want to import and afterwards start the import by clicking on Import Data. ©Streamlabs.com 17

18 StreamElements In order to Import Data from StreamElements you have to retrieve your JWT token from your StreamElements account page. After you have done this place it in to the JWT Token field, select which data you want to import and start the process by clicking Import Data. Other In case you are importing data from a service we are n ot supporting make use of the Other tab. Here you will be able to import .txt files for both Quotes & Points. Once you have select the files that you want to import start the process by clicking Import Data Points.txt Structure ankhheart 8500 momo 3450 torr91 500 cas Quotes.txt Structure "I am a cat ! " – AnkhHeart "I am a cow ! " – Momo AnkhHeart – "This is me saying something stupid/funny ! " ©Streamlabs.com 18

19 Features Console On the console you will see all the incoming chat messages and the viewer list. In case you dislike seeing who’s watching you can simply click the small button left of the viewer list to dock it to the side. Aside from this at the top of the console you h ave access to Macro buttons which you can document this will be explained in more detail bind commands to. Further in the . ©Streamlabs.com 19

20 Dashboard In order to access the full capability of the Dashboard you need to have your own Twitch tions - > Twitch Streamer. This should be done if you account connected under Connec followed the entire setup guide in the beginning. This is where you will be able to change your Title & Game, run commercials if you’re our choosing and where partnered with Twitch, have the bot automatically host streams of y the bot will track news Followers, Subscribers, Raiders, Hosts and GameWisp Subscribers. We also have Raid Assist which is a system which allows you to reward viewers for joining you on a raid. The Session Event View which is located at the bottom of the Dashboard will have to be manually cleared before each stream by right clicking and Clearing the data. Otherwise new by the same person. Hosts, Raids, Subs/Resubs won't be logged if they're done ! Sta tus ( m e s sa ge ) [ EDITOR] Example ! S tatus [24h] Charity Stream! > Title has been updated: [24h] Charity Stream! Response {user} - ! Gam e ( m e ss age ) [ EDITOR] ame The Last of Us ! G Example {user} -- > Game has been updated: The Last of Us Response ! Star tHo st [ EDITOR] Example !StartHost Response {user} -- > Started Automated Hosting! ! Stop Hos t [ EDITOR] Example !StopHost Response -- {user} > Stopped Automated Hosting! ©Streamlabs.com 20

21 Commands This is where you would start off if you want to create Commands. There are $parameters the commands to achieve various result. More information on these that you can use in parameters can be found on page XYZ. $ Parameters & Permission levels can be found further in to the documentation. There is also support for Command Grouping any group starting with [GAME] w ill only work when you're actually playing the game which is defined behind the tag ex: [GAME] Pokemon Go ! Com m an d A d d ( com m a nd) ( p e rm lv l) ( re sp on se ) [ EDITOR] Example !Command Add !Cookie +r All your cookies belong to me! - Response -- > Successfully added !Cookie. Permission: Regular {user} Message: All your cookies belong to me! ! Com m an d E di t ( com m a nd) ( p e rm lv l) a n d/or ( re sp onse ) [ EDITOR] Example !Command Edit !Cookie +a /me ate $count cookies! Response {user} -- > Successfully edited !Cooki e. Permission: Everyone. Message: /me ate $count cookies! [ EDITOR] ! Com m an d Re m ov e ( com m an d) Example ! C ommand R emove !Cookie Response {user} -- > Successfully removed !Cookie. ! Com m an d Co un t ( com m an d) ( n um ) [ EDITOR] Example !Command Count !cookie 10 {user} Response -- > Successfully set the count for !cookie to 10. B,D C, DW ,D B,C B, WB ,A ! ( com m an d) ( u sa ge e x : S C, S W, S Com m an d Us a ge ) [ EDITOR] Example !Command Usage !cookie S C {user} > Successfully set the usage of $command to $value. -- Response ©Streamlabs.com 21

22 ! Enab le [ EDITOR] ( com m a nd) ( true /f a lse ) !Enable !cookie true Example {user} -- > Succesfully enabled !Cookie Response ! Com m an d Coo ldow n ( c om m an d) ( m i n ute s) [ EDITOR] Example !Command Cooldown !cookie 2 Response {user} -- > Successfully set the cooldown of !cookie to 2. ! Com m an d Use rC ool dow n ( com m a n d) ( m i nu te s) [ EDITOR] Example !Command Cooldown !cookie 5 Response {user} -- > Successfully set the user cooldown of !cookie to 5. Sharing Commands If you wish to share commands with your fellow streamer you can export them as .abcom ( Command) or .abcomg ( Streamlabs Chatbot Command Group) Streamlabs Chatbot by right clicking on a command. You have two options Export Command to export the single command or Export Group to Export all commands in that specific Gr oup. Importing Commands the Command Tab in , Importing a script is simple. Simply click the Import Button Navigate to the Zip File and Open it. Afterwards the bot will import the script for you and reload your scripts so it's ready to go. ©Streamlabs.com 22

23 Timers This is where you will create your own Timers. These are messages that the bot will automatically post into chat after an interval of X minutes. The interval is completely based on the Setting at the top. All the timers will follow this same interval so this me ans the bot will post the first timer after the interval passes. Then it will start timing again, once the interval passes again it will post the second timer and so on eventually going through all of them and then starting back at the top. There is also s upport for Timer Grouping any group starting with [GAME] will only trigger when you're actually playing the game which is defined behind the tag ex: [GAME] Pokemon Go ! Tim e r A d d ( n am e ) ( re sp onse ) [ EDITOR] Example ! Timer A dd !Meow /me meows at $randuser na me Response {user} -- > Successfully added !meow. Permission: Everyone - Message: /me meows at $ randuser name ! Tim e r Ed it ( nam e ) ( re sp onse ) [ EDITOR] Example !Timer Edit !Meow /me growls at $ randuser name -- Response > Successfully edited !Meow. Message: /me growls at {user} $ randuser name !timer remove (name) / Doesn’t remove command [Ed ! Tim e r Re m ov e ( nam e ) [ EDITOR] Example !Timer Remove !Meow Response {user} -- > Successfully removed !Meow. ! A ctiv ate ( n am e ) ( tr ue /f alse ) [ EDITOR] Example !Activate !Meow false {user} activated !Cookie - > Succesfully de -- Response ©Streamlabs.com 23

24 Quotes This is where things you’ve said on stream can be stored. You can change the permission on who can request a random quote and who can add them for you through chat. You can also set the Cooldown and the Date Format. Every quote that gets added will automatically contain the Game & Date when the quote was created. So whenever someone at you were playing at the calls upon the random quote they’ll see when it happened and wh time. ! Quote A dd ( te xt) [ A DD PE RMISSIO N] I am a cat! !Quote A dd " " - AnkhHeart Example – Response {user} -- > Succesfully added Quote #0: " I am a cat! " AnkhHeart [Thief] [01/01/2015] ! Quote E di t ( i d) ( te xt) [ EDITOR] Example !Quote Edit 0 " I am not a cat! " – AnkhHeart [Thief] [02/01/2015] {user} AnkhHeart – > Successfully edited Response -- " Quote #0: " I am not a cat! [Thief] [02/01/2015] ! Quote Re m ov e ( i d) [ EDITOR] Example !Quote Remove 0 Response {user} -- > Successfully deleted Quote #0 ! Quote [ VIEW PE RMISSIO N ] Example !Quote Response Quote #2: " Duct tape solves all problems! " - AnkhHeart ! Quote ( i d) [ VIEW PE RMISSIO N] Example !Quote 0 - AnkhHeart Response Quote #0: " I am not a cat! " ©Streamlabs.com 24

25 Extra Quotes Using the Extra Quotes you can create your own version of the Quote System to store things that aren’t specifically quotes. You can change the command, decide whether you want the Game & Date to show or not, change the Permissions and Response. ds function the same way except if you do change the The underlying chat comman s is !Gif if you change it command you will also have to adjust the commands. By default thi to !P un then you will have to u se the commands starting with !Pun instead of !G if. ! Gif A dd ( te x t) [ A DD PE RMIS SIO N] Example !Gif Add http://tinyurl.com/randomGif.gif Response {user} -- > Succesfully added Gif #0: http://tinyurl.com/randomGif.gif ! Gif E di t ( i d) ( te xt) [ EDITOR] Example !Gif Edit 0 http://tinyurl.com/randomGif2.gif edited Gif #0: http://tinyurl.com/randomGif2.gif Response > Successfully {user} -- ! Gif Re m ov e ( i d) [ EDITOR] Example !Gif Remove 0 Response {user} -- > Successfully deleted Gif #0 [ VIEW PE RMISSIO N] ! Gif !Gif Example Gif #2: http://randomURL.com/randomGif15.gif Response ! Gif ( i d) [ VIEW PE RMISSIO N] Example !Gif 0 Gif #0: http://randomURL.com/randomGif2.gif Response ©Streamlabs.com 25

26 Counter You can use the Counter to create a Death Counter, Hug Counter, Cookie Counter, etc.. It’s used to count anything. You can change the settings to your liking just be sure to keep a # in the Msg Template since this will be replaced by the number. u want to use the Counter but do not want to Capture the Display Area you can In case yo make use of a Death.txt file that is Located in the Bot’s Install Directory - > Services - > Twitch - > Files Folder. This file will be generated when you’ve added your first death . If you want to manually create this file then simply type !death 0 in chat. This will create the file with 0 Deaths inside. Do mind though if you changed the Command to something else you will have to use that instead. [ MOD ] ! De at h + !Death + Example Response [Increased] Deaths: 124 ! De at h [ MOD ] - !Death - Example [Decreased] Deaths: 123 Response ! De at h ( n um ) [ MOD ] Example !Death 10 Response [Set] Deaths: 10 [ EVERY ONE] ! De at h Example !Death Deaths: 10 Response ©Streamlabs.com 26

27 Give Away This is where you will be able to start Give Aways. You can either have people join the Give Away for free or have them pay a fee to enter or have them pay per ticket using in Channel Currency. in the Give Away and how many On the left side you will find all the people that are entered tickets they possess. At the bottom of the window you will see all the messages posted by the Winner when one has been picked. That way you’ll know if the user is active in case chat is moving really quickly. ! Giv e aw a y S t art Com m a nd |Pr ize |Ma xE ntr ie sPe r U se r|E ntr yCos t| Pe rm is sio n [ EDITOR ] Example !Giveaway Start !raffle|cookies|1|25|regular Description This starts a giveaway through chat with your own settings ! Giv e A wa y S tar t Com m a nd |Pr ize |Pe rm iss ion [ EDITOR] Example !Giveaway Start !raffle|cookies|everyone Description This starts a very simple give away without tickets and entry costs ! Giv e A wa y Cl ose [ EDITOR] Example !Giveaway Close Description Prevents anyone from entering past this point ! Giv e A wa y W i nne r [ EDITOR] Example !Giveaway Winner Randomly picks the winner for the Give Away Description ©Streamlabs.com 27

28 Sound Files The Sound Files tab allows you to add sounds to the bot which you can attach to and notifications and commands. From within this tab you are able to control the Volume Votes. The votes option only applies to commands as it determines how many times a command has to be used before the sound goes off. ©Streamlabs.com 28

29 Currency If the currency System is enabled everyone in your chat will start earning points based on your settings. These can be spent using the various other Systems in the bot such as Give Aways, SFX, Bet/Vote and enter Minigames. The bot also supports Streamlabs currency. For this you need to connect Streamlabs and enable this functionality in your currency settings inside of the bot. You can create up to four Ranking Trees: One for Viewers, Subscribers, Mods and GameWisp Subscribers. Ranks are only assigned whene ver the bot pays out points or when you use !points add +viewers 1 for example. There is also room for customizing your own Payout amounts and intervals. This way you have full control over how many points people can accumulate in your stream. If the Offli ne Payout amount is set to 0 the bot will not pay out any points with the stream is offline. Also replace !points with your own custom currency command. ! Poin ts A dd ( n am e ) ( am oun t) [ EDITOR] Example !Points Add AnkhHeart 10000 Response {user} -- > Successfully given AnkhHeart 10000 Points [ EDITOR] ! Poin ts Re m ov e ( n am e ) ( am ou nt) Example !Points Remove AnkhHeart 1234 -- > Successfully removed 1234 Points from AnkhHeart Response {user} ! Poin ts A dd +Vie we r s ( am o u nt) [ EDITOR] / +ac tiv e Example !Points Add +viewers 100 Response {user} -- > Done giving 100 Points to everyone in chat ! Poin ts Re m ov e +V ie we r s / + act iv e ( am o un t) [ EDITOR] Example !Points Remove +viewers 100 Response > Done removing 50 Points from everyone in chat -- {user} ©Streamlabs.com 29

30 [ ! Poin ts EVERY ONE ] Example !Points - Points: 1337 Hours: 13 Response AnkhHeart [Ninja Kitty] - EDITOR ! Tran sf e r [ ] Example !Transfer AnkhHeart MohammedBaraax1 > Successfully transferred currency from AnkhHeart to {user} Response -- MohammedBaraax1 ©Streamlabs.com 30

31 Betting bet on the outcome of Using the Betting System you can open up the ability for Viewers to situations . These options can be saved into a present and loaded later in case you are playing the same game again. If you wish to pick a winning option sim ply right click on the option and Pick it as the Winner. In case there are multiple correct Options this can be done for each of them. [ EVERY ONE] ! Be t ( i d) ( am o un t) Example !Bet 0 1000 Response [None to prevent chat spam from the bot] ! Be tti n g St ar t [ EDITOR ] Be t ti ng On |P ayo ut Pe rce n t |Mi n| Ma x |Mu lt iBe tt in g |Op ti ons !B etting S tart Will Ankh Survive?|35|1|100|true|Yes|No|Maybe Example Description This starts a custom betting session with custom settings EDITOR ] [ ! Be tti n g St ar t Be t ti ng On |Op t ion s Example tting Start Will Ankh Survive?|Yes|No|Maybe !Be Description This starts a custom betting session that will use the settings that have been set in the UI [ EDITOR ] ! Be tti n g Stop !Betting Stop Example Description Prevents anyone from betting once used ! Be tti n g A b ort [ EDITOR ] Example !Betting Abort Description Cancels betting entirely and refunds anyone that has bet ] ! Be tti n g W in ne r ( i d) [ EDITOR Example !Betting Winner 0 Picks the winning option and pay out points to everyone that bet on Description it ©Streamlabs.com 31

32 Poll The Poll System allows you to start a poll in your channel and have your viewers vote. In case you want people to spend points for each vote they cast then you can enable this by checking Allow Multi Voting and increase the limit. [V OTE PERMI SSIO N] ! Vote ( i d) Example !Vote 1 Response [None to prevent chat spam from the bot] ! Poll St art Vo t in gO n|Co s t|M ax Vote s |M ul ti Vot in g |Op t ion s [ EDITOR] !poll start What Game should I play Next?|10|1|false|Witcher III|Pokemon Example Description This starts a custom poll with your own settings (overwrites UI settings) [ EDITOR] ! Poll St art Vo t in gO n|Op t ion s Example !poll start What Game should I play Next?|Witcher III|Pokemon This starts a custom poll that will use the settings that have been set in Description the UI ! Poll Stop [ EDITOR] !Poll Stop Example Ends the poll and posts the result in chat Description ©Streamlabs.com 32

33 Heist - Minigames The Group Minigame allows you to create your own Minigame. You can start the customization by determining the Command that will be used, what the cooldown is, how many users have to enter before it starts, the Max amount someone can invest and who can Join. Aside from all those options you can set the Probability for each usergroup. This determines t usergroup have to survive. The Payout can also be set how much chance people within tha that way you can choose how much someone gets ontop of the amount they invested in the minigame. Finally you can fully customize all the messages that the bot will be posting in chat depending on the situation and how well/bad things are going for the ones that have joined. So if you wanted you could turn it into something completely different and not use the default Heist preset. ! He is t ( am o un t) [ JOIN PERMIS SION] Example !Heist 123 Response(1x) {user} is trying to get a team together in order to hit the nearest bank. - - In order to join type !Heist (amount). Everyone can Join! ©Streamlabs.com 33

34 Minigames – Duel to a battle. The bot will process a The Duel minigame allows viewers to challenge each other secretive battle in the background, the winner will receive twice the cost. The loser will get nothing. Aside from this both the challenger and challenged will go on cooldown once their fight concludes and can no longer challenge or be challen ged till their cooldown expires. ! cha lle nge ( nam e ) [ JOIN PERMIS SION] !challenge ankhheart Example Response(1x) {user} has challenged {target} to a fight! Type !challenge {user} to accept the challenge! ©Streamlabs.com 34

35 Free f Minigames – or All All minigame multiple viewers can face off against one another. You can In the Free for determine how many people end up surviving. The more people join the larger the prize survive pool becomes and the winner walks away with the pot. In more than one person can then it gets split amongst the survivors. ! f f a [ JOIN PERMIS SION] !ffa Example The arena is now open! Type !ffa to join! Response(1x) ©Streamlabs.com 35

36 Minigames Boss Battle – people This allows you to create custom bosses for your viewers to fight based on how many join. The difficulty / loot is completely up to you do mind that balancing it fairly is also your responsibility. The Basics: Balancing of the minigame is completely up to you so let's go down some of the basic in the background. That way you can determine what concepts so you know how it functions values would be best. 1) Players sign up for the battle and get a Stat sheet assigned based on their permission 2) Boss gets picked based on the group size (Between Min Max Entries) – 3) The fight starts agains t the boss Damage Calculation: (User Attack – 4) 5 def = 5 dmg that the Target Defense) ex: 10 att – target will receive Attack order: The boss has to be attacked 3 times before it counters the last attacker. So 5) let's say we have a group with Ankh, Momo an d Gooru and Ankh attacks first and then Momo and then Gooru. After Gooru finishes his attack he would get countered by the boss and be the only person to receive damage. Now prior to every attack phase taking ffled so it's not always the same person place the order of people attacking will be shu getting countered. ©Streamlabs.com 36

37 Make sure to keep the Boss's Defense lower than Player's Attack at all times so they at 6) least have a chance to beat him 7) Balance the health based on the Min – Max Entries for this you will have to do a bit of math yourself based on the prior information given such as: Dmg Calculation and Attack Order 8) The Max Defense a player/boss can have is half their attack if this is higher than it will be capped out during calculation at 50% 9) Loot will get dis tributed evenly amongst all of the survivors at the end. In case no one survives then there is no loot to be distributed ! b oss [ JOIN PERMIS SION] Example !boss Response(1x) {user} is trying to get a group of adventurers together to fight a boss! Type !boss to join him! ©Streamlabs.com 37

38 Events The Event System will allow the bot to automatically Greet/Shoutout the person of your choice and play a SFX if you wish. The system consists of two modes Join events and Speak events. Join Event he person of your choice joins the channel. Then it will perform its action when t s will post its message and/or play its SFX. s Speak Event w ill perform its action when the person of your choice speaks in your channel for the first time. Then it will post its message and/or play its SFX. execute the events it has to be restarted. So the best thing is to - In order for the bot to re restart it before a cast. ©Streamlabs.com 38

39 Songrequest playlist through the bot The Song Request System allow you to create your own youtube have them play whenever you want. Aside from that your viewers can request songs and spend currency to do so. [ REQUES T PERMI SSIO N] ! Son gre q ue st ( url /to ke n ) !Songrequest TY9cSlOhqTk Example {user} -- > The song Amv - Response [MEP] Ѕο Lοng Ѕеntimеnt 720p has been added to the queue ! Skip SK IP PERMI SSION] [ Example !Skip Response {user} -- > Your vote to skip has been successfully registered! ! Ve to [ VETO PERMI SSIO N] Example !Veto Amv 720p has been successfully skipped! [MEP] Ѕο Lοng Ѕеntimеnt Response - [ EDITOR ] Son gb la ckl is t a d d ( i d) ! !songblacklist add dQw4w9WgXcQ Example Response {user} -- > dQw4w9WgXcQ has been successfully Blacklisted! ! Son gb la ckl is t re m ov e ( i d) [ EDITOR] !songblacklist remove dQw4w9WgXcQ Example {user} -- > dQw4w9WgXcQ has been successfully Un - Blacklisted! Response ! Wron gSo n g [ EVERY ONE] Example !WrongSong Response {user}, Successfully removed the last song you requested. ! Son gl ist !Songlist Example Create this yourself and point it to Note https://streamlabs.com/#/chatbot/songlist ©Streamlabs.com 39

40 ! Volum e ( num b e r) [ EDITOR ] !Volume 50 Example {user}, Volume set to 50 Response Queue You can setup a Game Queue using this which allows your viewers to sign up to join you in a multiplayer game. You can have them spend currency to enter and you can even set it to Sub only in case you only want Subscribers to be able to sign up. ! Joi n < note > [ EVERY ONE] Example !Join AnkhHe art#4798 Response [None unless enabled under Settings - > Localization] ! Que ue l is t [ EVERY ONE] Example !QueueList Note Create this yourself and point it to https://streamlabs.com/#/chatbot/queue ! Que ue Op e n < g am e > [ EDITOR ] Example ! Queue Open Warframe - Response - Cost: 0 points A queue has opened up for: Warframe Type !join (optional:Note) to join! ! Que ue Clo se [ EDITOR ] Example !Queue Close Response The queue has been closed! You can no longer enter! ! Que ue Cle ar [ EDITOR ] Example !Queue Clear Response The Queue has been cleared! ! Que ue < n um b e r > [ EDITOR ] P ick Pick 3 !Queue Example Response Next up: AnkhHeart, Castorr91, Must13 ©Streamlabs.com 40

41 EDITOR R an dom < num b e r > [ ! Que ue ] Example !Queue Random 3 Response Next up: FurRiffic, WellBrained, Ocgineer [ EDITOR ] ! Le av e Example ! Leave Response AnkhHeart has left the queue. Notifications You will find various in Chat Notifications here ranging from Follower, Host, Subscriber Notifications to GameWisp Notifications. You can customize each of these to your liking. The Follow, Subscriber, Host & Streamlabs notifications require you to have your Streamlabs account connected. The Cheer Notifications require you to have your Streamer Account connected. The Extra Life Notifications require you to connect your Extra Life Parcipant ID. ification is only available if you have connected your The GameWisp Subscriber Not Gamewisp Account. ©Streamlabs.com 41

42 Mod Tools Using the Mod Tools you can have the bot punish viewers that post Links without permission, Spam Caps/Symbols or very offensive words/sentences. Each of these can be ful ly customized. When it comes to Link Protection you can exempt certain websites from being punished. For the Word/Sentence Blacklist you can also make use wildcards such as * or ?. More information about Wildcards can be found on the internet ex: https://en.wikipedia.org/wiki/Wildcard_character ©Streamlabs.com 42

43 Discord The Discord tab will allow you to activate specific functionality to work in Discord in regards to everyone and even announcing when you go live. to Timers, automatically assigning a role ©Streamlabs.com 43

44 Users In the Users tab you can see every user’s id, name, whether they’re an editor, external sub or regular. What they’ve been blacklisted from, how many times they’ve raided you and when they were las t in your channel. From here you are also able to assign the Editor status to users whom you trust. They are then able to use Editor based chat commands to add, edit, remove commands, currency, start giveaways, etc... ©Streamlabs.com 44

45 Settings General In the General Settings you will find some basic functionality such as the delay between bot messages , Auto connecting all your accounts when you launch it, etc... Aside from this you can also setup a !raider command that can be used by Mods to save out a list of users tha t have raided your channel. These users will also get added to the Data.xlsx file in your Cloud folder if you have set that up. ! Re g A d d/ Re m ov e ( Nam e ) [ EDITOR ] Reg Remove AnkhHeart Example ! Reg Add AnkhHeart / ! AnkhHeart has become a Regular! / AnkhHeart is no longer a Regular. Response ! Sub A d d/ Re m ov e ( Nam e ) [ EDITOR] !Sub Add AnkhHeart / !Sub Remove AnkhHeart Example Response AnkhHeart has become a Subscriber! / AnkhHeart is no longer a Subscriber. ! Bla ckl is t A d d/ Re m ov e ( Nam e ) [ EDITOR] !Blacklist Add AnkhHeart / !Blacklist Remove AnkhHeart Example AnkhHeart has been Blacklisted! / AnkhHeart has been removed from the Response Blacklist. ©Streamlabs.com 45

46 Localization Within the Localization you have the ability to change any of the default responses though try to keep most of the $parameters unless you really don’t want them to be there. Usage Within the Usage you can change where and how commands can be used. Whether it be spers or Discord or everywhere. Chat, Whi e to be in your Channel to use Whisper commands In the Core you can determine if users hav with the bot or not. ©Streamlabs.com 46

47 Macros This is where you are able to setup Macros for the 7 buttons in the Console UI. It’s a simple way to setup a few buttons to automatically post commands / messages in chat for you when you click them. Hotkeys Using the Hotkeys you can set up Global Hotkeys for various actions within the bot such as Pausing a song, adding it to your playlist, skipping, increasing the volume,... Aside from this you’re also able to setup Hotkeys for t he previously Mentioned Macros so you don’t have to Also click the buttons yourself. You can just hit your hotkey and it will execute them for you. don't forget to click Apply at the bottom to save your Hotkeys ©Streamlabs.com 47

48 Style urs of Streamlabs Chatbot ’s UI then this is where you In case you’re unhappy with the colo would go. You can change every single colour here though you have to set the Style to Custom. Once you’re done with your changes and you like the result simply click on Save Custom Style and it will be saved. ChangeLogs This is where you will be to read up on the Changelogs in case you didn't read them prior to updating to a newer version. ©Streamlabs.com 48

49 Permission Levels +a Everyone Description +r Regular Description +s Subscriber Description +gw GameWisp Subscriber Description +m Moderator Description +e Description Editor +i Description Invisible +u( n am e ) e x : + u( a nkh he art) Description User_Specific: AnkhHeart +r( Mi nRa nk) e x: +r( L ion ) Description Min_Rank: Lion +p ( Min Poi nt s) e x: +p ( 10 00) Description Min_Points: 1000 +h( Mi n Hour s) e x : +h( 13 ) Description Min_Hours: 13 Usage Levels S C Description Stream Chat S W Description Stream Whisper S B Description Stream Both DC Description Discord Chat DW Description Discord Whisper DB Description Discord Both CB Description Chat Both WB Description Whisper Both A All Description ©Streamlabs.com 49

50 Parameters Basic Parameters $ de sc( de scr ip t io n) Description Special parameter that can be placed on the first line of a command to sync a custom description to the web $desc(This command does an API call somewhere!) Example $readapi(https://randomapi.com/thing) id $use r ’s id, in case of Twitch it’s the user’s name in lower case Displays the user Description characters. Make sure to use $userid when using $addpoints, $removepoints, $givepoints parameters. /me steals a cookie from $user id | !test Example Response Bot steals a cookie from ankhheart $ use r nam e Displays the Description user’s display name. Make use of this parameter when you just want to output a good looking version of their name to chat. Example /me steals a cookie from $ username | !test Response Bot steals a cookie from AnkhHeart $ ta rge ti d Description Displays the target’s id, in case of Twitch it’s the target’s name in lower case characters. Make sure to use $targetid when using $addpoints, $removepoints, $givepoints parameters. Example /me kicks $ targetid in the face! | !kick AnkhHeart Response ankhheart in the face! Bot kicks $ ta rge tn am e Description Displays the target’s display name. Make use of this parameter when you just want to output a good looking version of their name to chat. Example /me kicks $ targetid in the face! | !kick ankhheart Response Bot kicks AnkhHeart in the face! $ to use ri d Description Displays the target’s or user’s id, in case of Twitch it’s the target’s or user’s name in lower case characters. Make sure to use $touserid when using $addpoints, $removepoints, $givepoints parameters. /me kicks $ Example r or !kick touserid in the face! | !kick Chai or Bot kicks ankhheart in the face Response Bot kicks chair in the face! $ to use rn am e Description Displays the target’s or user’s display name. Make use of this parameter when you just want to output a good looking version of their name to t. cha Example tousername in the face! | !kick thunderceptor11 or !kick /me kicks $ Bot kicks Thunderceptor11 in the face! or Bot kicks AnkhHeart in the face! Response $ra nd use r id . In case of Twitch Displays a random user that has spoken in chat recently Description it’s the random user’s name in lower case characters. Make sure to use ©Streamlabs.com 50

51 $randuserid when using $addpoints, $removepoints, $givepoints parameters. /me gives $randuser a hug! | !hug Example id Bot gives ankhheart Response a hug! $ ra nd use r nam e Displays a random user that has spoken in chat recently . Make use of this Description parameter when you just want to output a good looking version of their name to chat. Example /me gives $randuser name a hug! | !hug Bot gives Ankh Heart a hug! Response $b otn am e Description Displays the bot’s name Hello I am $botname | !name Example Response StreamlabsBot ! Bot: Hello I am $m sg Displays the text after the command Description Example name rolls a $randnum(1,21) for $msg | !msg I wish I had 9 lives! $user Response Bot: AnkhHeart rolls a 18 for I wish I had 9 lives! $m yc ha nne l This will be replaced by the channelname where the bot is connected Description Example Connected to $mychannel |!mychannel Response Bot: Connected to AnkhHeart $d um m yorm sg Description This will get replaced by anything behind the command. If there is nothing it be cleared from the response message. http://api.com/$dummyormsg | !test Cats or !test Example Response http://api.com Bot: http://api.com/Cats or $d um m y Description This is a Dummy that will not post the message if there is nothing behind the command Example $dummy $readrandline(C: \ Users \ Ankh \ Blah.txt) | !8ball Am I green? Response Bot: Perhaps?! $ ar g1 to $ arg 9 Description $arg1 will give you the first word after the command and $arg9 the ninth. If these parameters are in the command it expects them to be there if they are not entered the command will not post. arg1 Example /me hugs says $ $ arg2 ! | ! argtest Hi Meow? Cookies? Res ponse Bot Hi Meow?! ar gl 1 to $ ar g l9 $ Description $argl1 will give you the first word after the command and $argl9 the ninth but all in lower case. If these parameters are in the command it expects them to be there if they are not entered the command will not post. Example /me hugs says $ arg1 $ arg2 ! | ! argtest Hi Meow? Cookies? Response Bot hi meow?! $n um 1 to $n um 9 Expects a valid integer Description ©Streamlabs.com 51

52 Example $num2 times! | !hug ankhheart 10 /me hugs $target name Bot hugs AnkhHeart 10 times! Response $ra nd n um ( m a x) or $r a n dn um ( m i n ,m a x) Displays a random number in a specified range Description /me rolls a $randnum(1,7)! | !roll Example Bot rolls a 3! Response $ra nd q uote Displays a random quote Description $randquote | !randquote Example Bot: I am not a cat! – Response AnkhHeart [Thief] [01/01/2015] $randextra $ra nde xtr a Description Displays a random value from the extra quotes $randextra | !randgif Example Bot: http://randomURL.com/gif12.gif Response $q uote s Description Displays the amount of quotes Example There are $quotes quotes. | !quotes Response Bot: There are 123 quotes. $m a xq uote s Description Displays the highest number quote Example There are $quotes quotes. Ranging from 0 to $maxquotes. | !quotes quotes. Ranging from 0 to 122. Response Bot: There are 123 $cou nt Description Counts amount of times a command has been used /me has $count jars of salt. | !count Example Response Bot has 3 jars of salt. | Bot has 4 jars of salt. | Bot has 5 jars of salt | etc... $che ck cou nt ( com m a n d) Description Displays the count of a specific command Example Cookie Count: $checkcount(!cookie) | !check Response Bot: Cookie Count: 10 $com m a n ds( N um Com m a nd sPe rP age ) Description Displays a list of all available commands for the user Example Commands: $commands(3) | !commands or !commands (PageNumber) Bot: Commands: !Cookie, !Slap, !Caster [Page 0/2] Response $q ue ue p os( t ar ge t ) id Description This will display the target’s position in the queue $user name Example you are in Position $queuep os($ userid ) | !MyPos Response AnkhHeart you are in Position 1 $q ue ue ( am ou nt) Description This will display the first X amount of people in the queue Example Next Up in Queue: $queue(3) | !NextUp Response Next Up in Queue: #0 mohammedbaraax1, #1 ankhheart, #2 gamegooru21 $tim e r s( N um Tim e rs Pe rP age ) Displays a list of all available Timers Description Example Timers: $timers(3) | !timers or !timers (PageNumber) ©Streamlabs.com 52

53 Response Bot: Timers: !ctt, !twitter, !youtube [Page 0/1] $d ate Displays the Date based on the format under Quote Settings Description Currently it is $date Example Response Bot: Currently it is 08/09/2015 $sf x( Num SFX Pe rPa ge ) Displays a list of all available SFX for the user Description Example SFX: $sfx(3) | !sfx or !sfx (PageNumber ) Bot: SFX: !scream, !pika, !morph [Page 0/0] Response $tim e Description Displays the caster’s time Currently it is $time over at AnkhHeart’s part of the world. Example Response Bot: Currently it is 10:20 PM over at AnkhHeart’s part of the world. curre nc yn am e $ Displays currencyname Description Example In this channel you can collect $currencyname | !currency Response Bot: In this channel you can collect Cookies! $curre nt son g an d $re qu e ste db y Description Return the current song that is being played through songrequest Example Current Song: $currentsong – Requested By $requestedby| !currentsong Response Bot: Current song: ONE MORE FIGHT – Requested By AnkhHeart $ne xtso n g a n d $ne xt re q ue ste db y Description Return the current song that is next in queue Example Requested By $nextrequestedby| !nextsong Next Song: $nextsong – Response – Requested By AnkhHeart Bot: Next song: ONE MORE FIGHT $cou nt dow n( 1 2: 00 A M) or $co un tdow n( 0 4/ 05 /2 015 12: 00 A M) Allows you to start a countdown from the current time to the set Description time/date $countdown(04/05/2015 12:00 AM) | !sleep Example Bot: 1 day 2 hours 48 minutes 36 seconds Response $cou nt up ( 1 2: 00 A M) or $cou nt up ( 0 4/0 5/ 20 15 1 2 :00 A M) set a start date for when the bot should start counting Description Allows you to $countup(07/03/2016 12:00 AM) | !Using Example Streamlabs Chatbot Response Bot: 1 day 2 hours 48 minutes 36 seconds $m at h[ Ma thF u nct io n] Description Allows you to perform math functions inside of St reamlabs Chatbot Example $math[10+5/2] | !Math Response Bot: 12 e xtr a lif e goa l $ Description Grabs your Extra Life goal Example $extralifegoal | ! goal Response Bot: 5000 $ e xtr a lif e am ou nt Description Grabs the amount you currently raised for Extra Life amount Example $extralifeamount | ! Response Bot: 100 ©Streamlabs.com 53

54 Currency Parameters $p oin ts Displays the num of points of the user or target Description $user name has $points $currencyname | !cookies or !cookies ankhheart Example Bot: AnkhHeart has 1234 Cookies! Response $p oin ts te x t Displays the num of points of the user or target nicely formatted Description name has $pointstext $currencyname | !cookies or !cookies $user Example ankhheart Bot: AnkhHeart has 1,234 Cookies! Response $ra id s Description Displays amount of times the user or target has raided the channel Example $user name has raided the channel $raids time(s) so far! | !raids or !raids AnkhHeart Response Bot: AnkhHeart has raided the channel 3 time(s) so far! $ra nk Description Displays the users rank Example $user name is Rank: $rank | !rank or !rank AnkhHeart Response Bot: AnkhHeart is Rank: Ninja Kitty $ho urs Description Displays amount of hours the user has been in the stream for Example $user name spent $ hours in the stream! | ! hrs Response Bot: AnkhHeart spent 10.5 hrs in the stream! $le v e l level Description Displays the users $user Example is Level $level! | ! Lvl name Response Bot: AnkhHeart is Level 10 $top p oi nts( n um ) Description Displays top X amount of users based on points (Except Caster & Bots) Example Top 3: $toppoints(3) } !top3 Response Bot: Top 3: #1 Promouse(10000), #2 Gamegooru21(9999), #3 EdeMonster(9998) $top ho urs( num ) Caster & Bots) Description Displays top X amount of users based on hours(Except Example Top 2: $tophours(2) | !top2 Response Bot: Top 2: #1 KrystalRayne(123 Hrs), #2 Pixelmonkey (120 Hrs) $p oin tsp os Description Displays the users position in the ranking based on amount of points Example $user name is ranked #$ pointspos | !mypos Response Bot: AnkhHeart is ranked #1 $ho ursp os Description Displays the users position in the ranking based on amount of hours Example $user name is ranked #$hourspos | !hrspos Response Bot: AnkhHeart is ranked #2 $n xtr an kre q Description Displays the amount of points/hours the user requires for his next rank ©Streamlabs.com 54

55 Example , You need $nxtrankreq points to become a $nxtrank! $user name Bot: AnkhHeart, You need 13 points to become a Ninja Kitty! Response $n xtr an k Description Displays the next rank that the user can achieve name , The next rank that you can achieve is $nxtrank! Example $user Bot: AnkhHeart, The next rank that you can achieve is Ninja Kitty! Response ", " m in" ,"m ax ", "su cce e d" ,"f ai l") $a ddp o in ts( " tar ge t id Adds points to a certain user and sends a message upon succeeding / Description failing Example " ankhheart","10","50","ankhheart Got $value points","Failed to $addpoints( give points!") | !addpoints Bot: AnkhHeart got 25 points Response id $re m ov e p oin ts( "t ar ge t ) ","m in" ,"m a x", "su cce e d ","f ai l" ,"f orce re m ov e tr ue or f a lse " Removes points from a certain user and sends a message upon Description succeeding/failing. Force remove(true/false) removes points even if the user doesn’t have enough. $removepoints ("ankhheart","10","100","Removed $value points from Example ankhheart.","Unable To remove $value points from ankhheart!","false") |!removepoints Bot: Removed 85 points from ankhheart. Response f r om i d " ,"t o id "," n um ", "s ucce e d ","f ai l" ,"f orce giv e t rue or f a lse ") $g iv e p oin ts( " Gives points from one person to another. Description name $givepoints("$user id ","$target id ","50","$user Example gave $value points to $target name name didn't have enough points to give to ","$user name !","false") | !give gamegooru21 $target Bot: AnkhHeart gave 50 amegooru21 Response points to G $v al ue [ O nl y Wo rks i ns i de of $ ad dp oi nt s, $g iv e p oint s or $re m ov e p oi nt s ] Description Gets replaced with the random value between min & max $givepoints("$user Example ","$target id ","50","$user name gave $value points to id $target ","$user name didn't have enough points to give to name name $target !","false")| !give gamegooru21 Response Bot: AnkhHeart gave 50 gamegooru21 $ ne wb a la nce ( tar ge t id ) [ Onl y W orks in si de of $ a ddp o in ts , $ giv e p oi n ts or $re m ov e p oin ts ] Description Gets replaced with the remaining balance after a $removepoints, $addpoints or $givepoints transaction $givepoints("$user id ","$target Example ","50","$user name gave $value points to id $target name . $target name : $newbalance($target id ) points re ","false")| !give gamegooru21 maining.","fail Response Bot: AnkhHeart gave 50 gamegooru21 . AnkhHeart 50 remaining Twitch API Parameters User Channel Data $use r url Displays the user’s twitch channel URL Description Example userurl | !userurl $user’s twitch channel is: $ ©Streamlabs.com 55

56 Response Bot: AnkhHeart’s twitch channel is: http://twitch.tv/AnkhHeart $use r gam e Displays the user’s last played/current game Description $user’s was/is playing: $usergame | !usergame Example Bot: AnkhHeart was/is playing: Bloodborne Response $use rs ta t us Description Displays the user’s stream title $user’s Stream title is: $userstatus | !userstatus Example Bot: AnkhHeart’s Stream title is: [720p] Fable: The Lost Chapters [PC] Response Channel Data Target $ur l Description Displays the target’s twitch channel URL $target name Example can be found streaming at: $url | !url AnkhHeart Response Bot: AnkhHeart can be found streaming at: http://twitch.tv/AnkhHeart $g am e Description Displays the target’s current/last played game Example $ target name has last played: $game | !game AnkhHeart Response Bot: AnkhHeart has last played: Bloodborne $st at us Description Displays the target’s stream title Example target name Stream title is: $title | !title AnkhHeart $ Response Bot: AnkhHeart Stream title is: [720p] Fable: The Lost Chapters [PC] My Channel Data $m y url Description Displays the twitch channel URL for your stream Example My channel is: $myurl. | !myurl Response Bot: My channel is: http://twitch.tv/AnkhHeart $m y gam e Description Displays the game you are currently playing Example I am playing: $mygame | !currentgame Response Bot: I am playing: Bloodborne $m ys ta tu s Description Displays your stream title Status: $mystatus Example | !mystatus Response Bot: Status: [720p] Fable: The Lost Chapters [PC] $up t im e Description Displays for how long the stream has been Live Example The stream has been live for: $uptime | !uptime Response Bot: The stream has been live for: 1 hour 25 minutes 58 seconds Sub / Follower Counts $f ol lowe rco un t Displays your streams follower count Description AnkhHeart has $followercount followers! !followercount Example ©Streamlabs.com 56

57 Response Bot: AnkhHeart has 1070 followers! $sub co u nt Displays your streams sub count Description Example AnkhHeart has $subcount subs! !subcount Bot: AnkhHeart has 0 subs! Response $gws ub co un t Displays your gamewisp sub count Description Example AnkhHeart has $gwsubcount subs! !gwsubcount Bot: AnkhHeart has 0 gamewisp subs! Response Miscellaneous $curre nt hos ts( N um Host s Pe rPa ge ) Description Displays everyone that is currently hosting the stream (Only works when you’re live) Example Current Hosts: $currenthosts(2) Response Bot: Current Hosts: EdeMonster, Promouse [Page 0/1] $ se t gam e ( gam e ) an d $se tti tle ( ti tle ) Description Allows you to set the game & title through a command and create presets for certain games Example $setgame(Dungeon Defenders II) $settitle(MMO Mornings)| !dd2 Response No response as the bot will simply upd ate the game & title File Reading Parameters $re a dl ine ( F i le Loc at io n) Description Reads the first line of the document Example \ test.txt) | !currentsong $readline(C: Bot: Currently playing: Popskyy Response Rize Up - $re a dra n dl ine ( F i le Loc at i on) Description Reads a random line from the file \ Example /me slaps $ randuser name with a $readrandline(C: test2.txt)! | !slap Response Bot slaps AnkhHeart with a Tuna! | Bot slaps AnkhHeart with a Brick! | etc.. $re a dsp e cif ic li ne ( Fi le L oc at ion , Li ne N um ) Description Reads a specific line from the file (Starts from 0) test2.txt,3)! | !slap randuser name with a $readspecificline(C: \ /me slaps $ Example Response Bot slaps AnkhHeart with a Shovel! Custom API Reading Parameter $re a dap i( UR L) Description Displays the text on the U RL’s page. Max 500 characters Example $readapi(https://nightdev.com/hosted/followers.php?channel=ankhheart &limit=5) Bot: 1. BensGaming808, 2. Gamakuro, 3. GENERAL_XROS, 4. wulleybully, 5. Response NorQuel Save File Parameters $ sav e t of i le ( "Fi le L oca ti o n", "Te x t") $sav e t of i le ( "Fi le L oca ti o n", "Te x t" ,"S ucce e dMs g" ,"F ai lMs g") ©Streamlabs.com 57

58 Description Adds to the end of the file $savetofile("C: test.txt","$msg","Succeeded :D","Failed! ") | !save I am a cat Example \ Bot: Succeeded! Response $ov e rwrit e f ile ( " Fi le Lo ca tio n" , "Te x t") ( " Fi le Lo ca tio n" ,"Te x t" ,"S ucce e dMs g" ,"F ai lMs g") $ov e rwrite f ile Description Overwrites all the data in the .txt file with the added text \ test.txt","$msg","Succeeded :D","Failed! ") | !save I am a Example $overwritefile("C: cat Bot: Succeeded! Response Miscellaneous Parameters $tie r Description Only usable in the GameWisp Chat Notification name just subbed Tier: $tier! Example $user Response Bot: AnkhHeart just subbed Tier: 1! $m on ths Description Only usable in the GameWisp Chat Resub / Twitch Resub Notification just subbed for $months months in a row! Example $user name Response Bot: AnkhHeart just subbed for 3 months in a row! $re war d Only usable in the GameWisp Chat Notification Description Example name just subbed for $months months in a row and received $user $reward points! Bot: AnkhHeart just subbed for 3 months in a row and received 10,000 Response points! $b its / $ tot alb its Description Only usable in the Cheer Chat Notification Example $user name just cheered $bits bits for a total of $totalbits bits! Response Bot: AnkhHeart just cheered 100 bits for a total of 1234 bits! $do na ti onm s g Description Only usable in the Streamlabs Chat Notification name just donated $amount USD! Message: $donationmsg Example $user Response Bot: AnkhHeart just donated 10 USD! Message: Harro <3 $v ie we rs Description Only usable in the Host Chat Notification Example $user name just hosted you for $viewers viewer(s)! Response Bot: AnkhHeart just hosted you for 10 viewer(s)! Generated Text Files The bot automatically generates text files that can be used to display information on stream. > Files folder. I f - > Twitch - These files can be found in the Bot's Install Directory - > Services you don't remember where you installed the bot just Right click on its shortcut and select ©Streamlabs.com 58

59 Open File Location. If this leads you to the Startup folder instead do it once more on the shortcut there and eventually you will end up in the Bot's install Direc tory. Foll owe r A m ou nt ( p e r se ssio n) File AmountOfFollowers.txt Ne w Fol lowe r L is t ( p e r se ssio n) Followers.txt File Las t Fo llowe r RecentFollower.txt File Gam e Wisp S ub A m ou nt ( p e r se ssio n) File AmountOfGameWispSubs.txt Ne w G am e Wi sp Sub s ( p e r se ssio n) File GameWispSubs.txt Las t G am e W isp S ub File RecentGameWispSub.txt Hos t A m ou nt ( p e r se ss io n) File AmountOfHosts.txt Ne w Hos ts ( p e r se ss ion) File Hosts.txt Las t Host File RecentHost.txt Twit ch S ub A m ou nt ( p e r se ssio n) AmountOfSubs.txt File Ne w Sub s ( p e r se ss io n) Subs.txt File Las t S ub File RecentSub.txt Curre n t So ng File CurrentSong.txt Re que s te d By RequestedBy.txt File Com p le te Curre nt Son g + Re q ue ste d B y CurrentlyPlaying .txt File De at h Co un te r File Deaths.txt Re ce nt Don at or Streamlabs_Recent_Donator.txt File ©Streamlabs.com 59

60 ( R aise d / Go al ) Extr a Lif e File ExtraLife .txt Extr a Lif e Te am ( Ra ise d / Go al) ExtraLife_Team .txt File ( p e r Se ssio n) Extr a Lif e D on at ion s ExtraLife_Donators File .txt Extr a Lif e L as t Do n ator ExtraLife_Recent_Donator .txt File ©Streamlabs.com 60

61 Python Streamlabs Chatbot Scripting Setup In order to properly use Python Scripts within Streamlabs Chatbot you need to have Python 2.7 installed: https://www.python.org/ftp/python/2.7.13/python - 2.7.13.msi > Folder k and Once you've done that click on the Settings Icon inside of the Scripts tab - Pic \ Python27 \ Lib folder on your System. This can vary from the one that I am navigate to your C: referring to since it all depends on where you installed Python. Once you've found the Lib folder select it and hit Save. Afterwards you can right cli ck within the Scripts View and reload any scripts. At the bottom of the page you will see Errors being logged from the Python Scr ipts that you're trying to load in case they are not considered valid or have bugs in them. Importing in simple. Simply click the Import Button , the Scripts Tab Importing a script is Navigate to the Zip File and Open it. Afterwards the bot will import the script for you and reload your scripts so it's ready to go. ©Streamlabs.com 61

62 Assigning API Key to Script Whenever you right click on a scr ipt you’re able to select `Insert Api Key` which will put a small .js file in the script’s folder that will give it access to connect to the chatbot’s websocket server. The Api Key in question can be refreshed whenever you wish. Though in this case you w ill need to update each client.js file so it uses the appropriate key. This key is used as a password so only clients which you have granted access may connect to the server. Creating your own script? If you want to create your own scripts please checkout the Chatbot boilerplate over at: Boilerplate/wiki - https://github.com/AnkhHeart/Streamlabs Python Wiki: - - Chatbot https://github.com/AnkhHeart/Streamlabs Chatbot Python Code: - - Boilerplate - FAQ For the FAQ please check the website! .com/faq/ Streamlabs Chatbot http://www. ©Streamlabs.com 62

Related documents