Streamlabs Chatbot meets SC2 - Scripts for Streamers

Brainyac

Germany199 Posts

August 06 2017 19:29 GMT

Important note (06 January 2018):
Streamlabs announced on the 22. November 2017 that the streaming bot software AnkhBot joins the family.
Announcement: https://blog.streamlabs.com/ankhbot-is-joining-the-streamlabs-family-1c71dfc26690

AnkhBot became officially Streamlabs Chatbot and with that especially one big thing stood out for us: "Premium features which would have cost something in the near future will stay free". That means we can go wild on creating scripts for it and it will never cost you anything!

With that in mind we reworked and overhauled all our scripts and made them even better but look for yourself below.

Hello fellow nerds, gamers but especially you Streamers out there,

Streamlabs Chatbot (formerly AnkhBot) has an integrated Python API which allows us to create outstanding scripts and tools for you streamers. Among other ideas we were especially fixated on the usage of the StarCraft II Client API since my friend Burny and me both like to play as well as stream that game.

We worked on some tools which work for StarCraft II exclusively and some other scripts which might be interesting for streamers in general. But let's stop talking too much and get started with a quick overview of what we created and now offer:

OBS Scene Switcher (SC2 only)
MatchInfo (SC2 only)
Betting System (SC2 only)
StreamTimers
TTS Announcer
Update Notifier
Upcoming: Betting System (For casters)
Upcoming: Stats’n’Track
Upcoming: ReplayManager

Watching it live is always a good thing. Here's a list of Twitch streamers who use our scripts:

I assume every streamer who worked with OBS knows about the OBS SceneSwitcher Plugin from R1CH which switched the Scenes in OBS depending on if you're ingame or in the menu.
We recreated that in Chatbot and added a bit more functionality to it. Seperate overlays for each scene in the game itself (In Menu, In Game, In Replay) and also a Casting Mode which let's you set up three additional scenes when you are also casting games.

To give you an idea how the settings would look:

This script gathers informations from the matches you play and you can use them either in your Twitch title or in textfiles so you're able to show those infos in your overlay.

Accessible infos:

For both players: Name, Race and MMR
Matchup
Region/Server
Ingame time in minutes and seconds

Thanks to the cooperation with SC2Unmasked we're also able to offer those two features:

Identify barcodes and replace the barcode with the real playername in real-time
Let the bot do custom shoutouts in chat when the opponents streams right now as well

The proper usage with examples and proper "documentation" is within the new Readme which you can access per button on top in the menu.

To give you an idea how the settings look like:

A lot of bots have the option to do bettings in chat but nobody really uses that feature since it's quite a hassle to always set them up manually and for StarCraft II even more so. It's a great idea to do that for every game but .. let's be honest: It's a pain in the ass to do and hence nobody does it.

However! What would happen if that process of creating a bet, letting people do the betting, closes it and actually select winners was automated?

That's where our betting system comes into play since that's exactly what it does! This means you only need to set it up once and decide if you want to enable it this stream or not. Easy, right?

You: "Well, yea... but that's a chat-only thing again, right?"

Mh... well, have a look at these two screenshots:

It's not! We also offer overlays which you can use for your stream and decide on some customizations such as the labels, betting commands for the viewers and animation you want and if the overlay should hide again after the time is up where people can bet so it only fades in again to announce the winner of the match.

Big update for version 1.2.0:
Voting: If you don't like to use a currency for your stream then don't do it. Switch the betting system to a voting system and let them vote without any currency at all. The overlay will be displayed with percentages then instead of total amount of points then.
You like the voting system more but also want to use your currency? We got you covered: Set an amount of points every vote will cost and viewers can vote with just the commands.

Overlays/Themes: We created a theme system for Chatbot and our script so you can go ahead and create your own betting overlay with just a bit of HTML, CSS and JS knowledge. Afterwards just select the theme you'd like to use within the script and change them up on the fly.

A quick look at the menu here as well:

There are two timers which streamers and viewers care about: First a countdown which usually runs before the actual stream starts and second a timer that displays the uptime of the stream.
Both normally require an installation of another program but we want all of it in one solution - so we created StreamTimers.

It looks like that:

It creates both timers as a textfile and you can customize them in some ways like the time format. Here's a screenshot of our tooltip for the time zone textfield:

[image loading]

You can also display a custom text after the countdown finished like "Starting soon(TM)" which I personally really like.
The uptime will start automatically when it detects that your stream went online and the "Max Sleep Timer" is a safety option when your stream disconnects, OBS crashes, etc. It will stop the uptime and continues if you reconnect within that sleep timer. If you go live after that period of time it will automatically resets the timer and assumes you do a new stream.

Note: If you don't like setting up the timer in these settings you can also do that per commands in chat. See "Set xx chat command" on the image above.

As the name tells it's a simple text-to-speech system which enables your viewers to let a voice say what they wrote in chat. It allows a lot of configuration like the "Min Power Level" which says who can use it (Everyone, Regulars, Subs or only Mods), the cost of it, cooldowns and supports a lot of languages.
Note: Since that also can lead to some trolling we also included a "Black List" so you can filter out words you definitely don't want to hear in your stream.

Here is an overview and the languages we support currently:

Receiving posts and messages from bugs and errors which are caused by using older versions was quite the normal. People didn't have a way to see if a new version is out unless they checked the discord server in a regular fashion.

Hence we created the script "Update Notifier": It's notifying you if a new version is out in currently four different ways which you can choose yourself and find your way to the publishing site (discord, website) and download the newest version. Extremely simple but useful in our opinion.

Since we think the betting system has a lot of potential and even casters could use that for showmatches we're working on a seperate script just for them.

Why? Because this would be different...

..Overlay graphics
..Overlay labels
..Chat messages
..no StarCraft 2 Accounts needed
..Animations?!

Those reasons are enough for us to say that we definitely want a seperate solution for this.

Another upcoming tool which allows you to track your games, wins/losses/win rates (in total and per matchup), MMR progress and you can decide what to display on your stream and maybe even with fancy graphics and more.

This feature is still “under construction” since we’re still not sure what people would really like to see and track. But we promise it will be awesome, helpful and fancy looking on your stream!

A new idea that we're currently working on is our so called "Replay Manager". It'll allow people to rename them in a format they want, move them into seperate folders and also set filters for replays you want to be deleted instantly (games under 1 minute in case someone left instantly).

That way streamers also have a way to easily set up replay packs when they let it organise per month as example.

If you got ideas, suggestions or wishes you want to see in such a script don’t hesitate to write it down below as a comment or directly in our discord.

True to the motto: From the SC-Community for the SC-Community.

You’re hooked and want to know how to get all that?

Step 1: Download SL Chatbot from their website: https://streamlabs.com/chatbot/

Step 2: You can download these scripts for free on following two places (currently the safest bet for the newest version is our discord since I'm working on a new version for the website):

Our discord: Discord invitation

If you didn't download it from those two places or the Chatbot's official discord we won't guarantee for anything. We also don't allow sharing or offering it on other places!

Step 3: Get your stuff configured as you like and start streaming

There are also ReadMe files in every script with - we believe - simple and easy to follow instructions on how to get started.

Does it cost something?
Since AnkhBot joined the Streamlabs family we can confirm that it will stay free.

You have problems with the Chatbot itself?
We won't offer support for general problems but only for our scripts. If you need help/support for it you can check out the discord of them: Streamlabs Chatbot Discord

You want to report bugs or feedback/ideas?
If you want to report problems/bugs or want to share some ideas and suggestions for improvement please leave a comment on the TL thread here or at best join our discord and write it in the channel for it: Discord invitation

If you encounter problems please try to deliver as much information as possible so we can find the problem quickly. Reports like "It doesn't work anymore" won't help us a lot ^_^
With future releases we also integrate a more professional bug-tracking so you can just send us error-logs but that isn't the case right now, sorry.

You don't like our overlays or want to create/get your own??
You're free to create your overlays as you like (You need knowledge about HTML, CSS and JS).
Otherwise you can get some personalised versions made by us which will cost some depending on your needs and wishes.

We hope you like those tools and can upgrade your streaming experience. Not only for you streamers but also for the viewers who can have more informations and can get more interaction going with the Betting System.

~ Brain & Burny

Troubleshooting Q&A
+ Show Spoiler +

### TROUBLESHOOTING - Everything related to scripts

#My Chatbot has no scripts tab!
* Do you have Chatbot version 1.0.2.0 or newer installed?
* In the "Connections" menu of Chatbot (the icon in the bottom left), in "Connections -> Twitch Bot -> Channel" did you put YOUR channel name in the "channel" field and is it the same as the "Connections -> Twitch Streamer -> Username"?

#Why do my scripts not show up?
* In the Chatbot scripts tab, in the top right hit the cog / wheel icon and link your python 2.7.13 installation!

### TROUBLESHOOTING - SC2 Scene Switcher

# Why do my scenes not automatically change?
* In the Chatbot - Scripts tab, select scene switcher and enter the names of your scenes to exactly what they are called in your OBS studio (case sensitive!). Also in the same window, is your scene switcher enabled? Hit "save settings" to apply changes.
* Did you install OBS remote plugin for OBS studio (link in readme)? If yes, go into OBS studio, open "Tools" -> "Websocket server settings" and enter a password. Now, in Chatbot at the bottom left, hit the little human icon (shoulder+head), go to the "OBS Remote" tab and enter the same password, now hit "Connect" while having OBS studio running. You may have to do the "Connect" part each time you launch Chatbot.

# Why is there no field for when you are "tabbed out of Sc2"?
* This might be an upcoming feature if people actually want it.

### TROUBLESHOOTING - SC2 Title Updater

# Why does the script not detect me as player and use the caster title instead?
* In the "STARCRAFT II ACCOUNTS" tab, enter your in game nickname, e.g. "Burny" and NOT "Burny#2452".

# Why does my title not update?
* You didn't enter your client ID and oauth correctly in the "USER SETTINGS" tab of the script. Check the readme.txt on how to obtain a client ID and oauth.

# Why do my overlay files not get created / updated?
* Is the "ENABLE TEXT FILE CHANGES" checkbox active?
* This might be a admin right issue and Chatbot cannot create text files. You can find the overlay files in "(AnkhBotFolder)ChatbotFolder\Twitch\Files\SC2TitleUpdater_OverlayText1.txt".

# Why does the variable $mymmr$ not work?
* You didn't enter the (correct) rankedFTW URL. Go to http://www.rankedftw.com/ enter your account name e.g. "burny", select YOUR profile and then go on the ladder icon http://i.imgur.com/F6Nfij7.png and now copy the link you are on, it should be similar to http://www.rankedftw.com/ladder/lotv/1v1/mmr/?team=1372705

### TROUBLESHOOTING - SC2 Betting System

# I am testing the script by playing 1v1 against AI, why does it not work?
* The script will not work when playing against AI. Please test it against a friend of yours or by queueing in unranked 1v1.

# I am testing the script in custom game / unranked / ranked 1v1 games, why does it not send a message in twitch?
* The script has not detected you as a player, did you put your in game nickname in the "STARCRAFT II ACCOUNTS" field, e.g. "Burny" but NOT "Burny#52435"

# The bot sends messages in twitch now, but the overlay doesn't work!
* You have to insert the Chatbot API Key into the script so that the script and overlay can communicate. Rightclick the betting script in the script tab and click "Insert API Key". Now add the file
"(AnkhBotFolder)ChatbotFolder\Twitch\Scripts\SC2BetSystem\Overlays\index.html"
as browser source in OBS.

# I don't want certain response messages to appear (e.g. when user joined betting), how to disable them?
* Empty the text field and the bot will no longer send response messages.

PinoKotsBeer

Netherlands1385 Posts

August 06 2017 20:21 GMT

Very nice, well done!!!

MAAPK1

1 Post

August 06 2017 20:28 GMT

Excellent job! Thx a lot!

Nyarly

France1030 Posts

August 06 2017 21:47 GMT

Cool looking, good job !

propagare

Germany93 Posts

August 06 2017 23:25 GMT

I really like it! And I really hope it stays free and working for us in this version even when a premium version comes out. The disappointment of users after a couple of months with a new working setup would create an unintentional blow back that could really hurt Ankhbot otherwise.

Thanks a lot for this good job!

leveretrush

Taiwan9 Posts

August 07 2017 03:01 GMT

Niceeeee job

Brainyac

Germany199 Posts

August 07 2017 06:52 GMT

On August 07 2017 08:25 propagare wrote:
I really like it! And I really hope it stays free and working for us in this version even when a premium version comes out. The disappointment of users after a couple of months with a new working setup would create an unintentional blow back that could really hurt Ankhbot otherwise.

Thanks a lot for this good job!

Scripts, OBS Remote and the Python interface are included in the premium version so if you want to continue to use those scripts you'd have to get that at some point. I understand that it's a big negative aspect but I myself don't know any other Bot that offers that many possibilites and customization options for a fee.

But I put that part already into the FAQ Section so nobody stays in the dark about it nor do we want to hide it.
PS: No, I don't work for Ankhbot I'm just a big fan of it.

When the price is higher than expected we could also think about a stand-alone version with those scripts so you don't need to use AnkhBot at all. But for now that's only an idea.

Thanks for your positive feedback so far! ~ <3

Mraptor

France26 Posts

August 07 2017 22:48 GMT

Great initative.
I decided to give it a try today. So I just dumped every other bots and commands I had to switch to AnkhBot and use these scripts.

Following through the guidelines above to install it was pretty simple. I had little to no trouble to deploy the scripts, if you are careful with the readme.txt files around, and the advice on the Discord server, you're set in about an hour.

Did a test run tonight on my stream to see how it was, and surprisingly it didn't crash once, I was able to use AnkhBot functions plus the scripts above. I only use the TitleSwitcher and the BetSystem. I have hotkeys to switch scenes on OBS so the SceneSwitcher wasn't of any use to me.

Here's a preview of the Bet System used around my overlay. Using AnkhBot you can select the way the "Bet panel" appears, so here I applied the transition Right / Left. So it slides in and out of my screen.

[image loading]

If you want other screenshots like this to know how these features work, join the Discord. I'm active there, and both creators were very responsive to my questions too.

The Titles were changed nicely too. MMR is retrieved in real time, so you don't need to update your Twitch title at all. And you can change the way the message is ordered around easily too. Here's a sample below.

[image loading]

To conclude, easy to set, nice to parameter, useful, I'll run my stuff through AnkhBot and maybe do my own scripts later on.

Rated 8/8 gr8

Brainyac

Germany199 Posts

August 10 2017 00:53 GMT

Thanks for the awesome feedback so far!

Since AnkhBot released a new version with unicode encoding we also updated our scripts and got some new features in them.

Changelog:
Betting System - v1.0.1:

Compatibility with the new AnkhBot version
Rewards and ChatMessage for Winners are now send when in Menu to prevent early spoilers
Added Unicode to display every name / sign (utf-8)

TitleUpdater - v1.0.1:

Compatibility with the new AnkhBot version
Added two buttons to make it easier to access the ClientID and oauth per button/browser link

SceneSwitcher - v1.0.1:

Compatibility with the new AnkhBot version

StreamTimers - v1.0.2:

Compatibility with the new AnkhBot version
Included the ScriptToggled-Function
Resets now properly the countdown in textfiles
Utf-8 Encoding
Minor Bugfixes

The new versions can be found either on Discord or on the website. Keep rockin' o/

Brainyac

Germany199 Posts

August 11 2017 18:26 GMT

#10

And another smaller fixes and changes

Changelog:
Betting System - v1.0.2:

Bugfixes
New default values for the chat messages and responses

TitleUpdater - v1.0.1:

Bugfixes
New/fixed default values for the chat messages and responses

Also put a list of twitch streamers in the starting post so you can check them out to get an idea on how it looks and works

Brainyac

Germany199 Posts

October 03 2017 09:28 GMT

#11

We didn't vanish but thought about things we can improve. But first of all new awesome streamer who decided to use the SceneChanger and Betting Overlay:

Glad to see new people giving it a try and loving it afterwards ^_^

Also some things which will come soon:

StreamTimers:

Will get a rather small update where Countdown/Uptime can be set with custom commands in chat
Option to display responses to your commands in chat or not

Betting System:

Switch between Currency Betting and just Voting without currency involved
Display total amounts (5 votes / 500 currency) and percentages
1-2 new themes you can choose from

The updates should be rolling out this week. StreamTimers most likely withing the next 1-2 days.

Stats'N'Track:
This is what we're working the most on but also need the most time since we want to almost offer as many possibilities as sc2replaystats or even more functionality. Can't really say when this will be out currently, sorry about that.

Discord:
We overprepared this seperate discord server and isn't needed so we move it to an already existing and populated discord and continue to offer our scripts and support there. The links are updated.
Sorry about the inconvenience!

Stay tuned~

Brainyac

Germany199 Posts

November 22 2017 23:06 GMT

#12

Since Ankhbot joined the Streamlabs family it's also official that the "Premium" part will be completely removed and stay for free - hence also the scripts and every streamer can use it without any worries

https://blog.streamlabs.com/ankhbot-is-joining-the-streamlabs-family-1c71dfc26690

Darkness2k11

Chile313 Posts

November 23 2017 00:41 GMT

#13

cool :o

Brainyac

Germany199 Posts

January 06 2018 22:38 GMT

#14

We completely rewrote this thread and updated the graphics as well as the functions the scripts have. The last weeks we published a lot of updates for each scripts and made them even better.
We also share our scripts now on github and will include the link the post as soon as everything is up to date there.

Hope you guys enjoy those scripts! Happy streaming~

Brainyac

Germany199 Posts

January 11 2018 23:27 GMT

#15

Waddup everyone?!

Here to announce the new script "Update Notifier" which allows you to easily check if you got the newest version of the Chatbot scripts.

We created some banners for the thread to make it more enjoyable to read with that huge wall of text.

A few streamers started using some of our scripts as well now and we're publishing Youtube Tutorials/Guides on how to set them up properly soon(TM) (Sorry, can't give you an exact date yet).

Brainyac

Germany199 Posts

January 15 2018 09:06 GMT

#16

Been a few days ago and I can announce another few updates from our side:

SC2SceneSwitcher got an update with two more options:

Checkbox to decide if you want to swap scenes at the game start or at the start of the loading screen
Textfield where you can enter the IP of your game pc if you use a dual pc setup

With this we want to start working/improving on the usability for dual pc setups.

The bigger update came right now for the Betting System:

Added a checkbox to decide if you want the playernames capitalized
Added an "Open Readme" button since people still asked where they can find it :p
Lots of improvements, hotfixes and changes of labels and default values
Added the new 'GSL' theme for the overlays (preview below)

As note: Please download the scripts on the discord since the files on the website are not up to date!

Stay tuned for more awesome news ~
Brain

PS: Don't hesitate to ask for help setting it up on the #support channel or DM Burny or me directly.
The youtube guides will start soon so you can see how to configure them fast & easy.

Brainyac

Germany199 Posts

February 26 2018 04:59 GMT

#17

Sorry for not posting for a bit longer than a month - we were really busy working on the scripts and getting the word out there.

New Streamers:
First of all I thank all the wonderful streamers out there who give our scripts a try/chance. Also two of the more known streamers started using the scripts: ROOT CatZ and our allrounder PiG:

Streamlabs Chatbot:
23nd February came the patch 1.0.2.29 for Chatbot and with that the support of Youtube streamers. Additionally a lot under the hood was changed and also on the scripting side so we were busy updating all of our scripts this weekend. Please make sure to grab those updates!

Website - Brains World:
I'm happy to announce that the new website is finally online with the current versions of the scripts and additional informations to each script and also some scripts of other developers. Most of the infos can also be found now in the new Readme files.

Website: Brains World

Betting System:

Added dual pc support
Added the option to use sounds for those events: Match start, Victory and Defeat
Added a detailed error logging so we can help out more efficient
Fixed bugs and reworked a lot :D

MatchInfo: (former "Twitch Title Updater")
With the decision of renaming this script we are also happy to announce our cooperation with sc2unmasked and Ophidian so we're able to bring you some new awesome features!

New features:

Un-Barcoding: If you're facing a barcode we're able to un-barcode him and if he's listed on sc2unmasked the barcode will be replaced with his real username.
Streamer Shoutout: If you're facing an opponent who also streams at that time you can let the bot do a shoutout for him with his Twitch link (Enable/Disable option, custom message, blacklist for streamers you don't want to shoutout).
Overlay information: You can fill multiple textfiles with real-time information like names, races, mmr, matchup, region you play on and ingame min/sec.
Added dual pc support
Made the installation & configuration A LOT easier and faster
Fixed bugs and reworked a lot as well.

Scene Changer:

Added dual pc support
Added Download button for the OBS websocket plugin
Fixed a few bugs

~~~~~~~~~~~~~~

Overall we tried to improve the usage and make it easier and faster for people to get started right away while we allow a deep customization for those who want to get into it and fiddle around with all of that.

Means we added buttons to make access to everything faster like the Readme files (documentations more likely by now) as well as the overlay files, downloads, token generators, etc.

I'm also really happy that more people are giving those scripts a chance - and most get to like and stick with them since it also increases the chat interaction.

Stay tuned~
Brain

PS: We didn't forget the Replay Manager or Stats'N'Track.. maybe they're coming sooner then you think ;p

Brainyac

Germany199 Posts

February 26 2018 20:35 GMT

#18

Happy to announce that two additional streamers started using them

https://www.twitch.tv/xjustxjordanx
Caster/Commentator of Gauntlet and various tournaments which also streams a lot on his personal channel.

https://www.twitch.tv/breadbeardtv
4k MMR Zerg struggling and improving his way upwards.

BreadBeardTV

1 Post

February 26 2018 20:59 GMT

#19

I’ve started using these scripts a few weeks ago and I am thrilled about them! This being my first real attempt at adding scripts to my Ankhbot, I was happy at how easy they were to install, as well as customizable! Very well thought out scripts and readme’s/ instructions and how they work. So, beyond the fact that these scripts work great, Brained also adds incredible support for problems or ideas you may have. I had a question regarding the matchinfo script and threw it in discord and he answered almost immediately ^_^. If you’re in the market for anything to spice up your stream, I highly recommend using these!

Freeedom

United States199 Posts

March 01 2018 01:18 GMT

#20

hey guys I've been using this on my stream... my twitch is not listed yet above as I am new to this but even in just a few days it's been magical. I especially love the sounds I can play with it, and the betting on winner feature. The next thing I wanna try out of the many cool features is the Un-barcoding, but that's not that much of a problem for my level at around Master 2.

1 2 Next All

Please or register to reply.

Streamlabs Chatbot meets SC2 - Scripts for Streamers

Completed

Ongoing

Upcoming