Streamlabs-Chatbot-Randombeer

A Python Script for Streamlabs Chatbot to gift some random user a "Beer" (similar to currencies by SL Chatbot)

How to install (still "Alpha af!")

1. Go to this directory (starting from the root where Streamlabs Chatbot is installed):

Services\Scripts\

2. Create a new Folder called "RandomBeer"
3. Drop all of the stuff from this Repository in there
4. Reload the scripts in SL Chatbot and you're good to go!

If you're having trouble with loading scripts in the SL Chatbot, see: https://www.youtube.com/watch?v=l3FBpY-0880

How to use

You don't really need to (and can, because the user config is still buggy) configure much. Just call the command "!beer" in your stream and have fun!

Changelog

v0.0.1

• initial Build

v0.0.2

• parse first command
• Add .gitignore for .csv files
• check if randuser is already in file then plus 1
• parse second command: check file for given username and print out value
• outputting 1., 2. and 3. as "first" "second" and "third" (hopefully low hanging fruits | edit: yeah it was)

v0.1.0 (Alpha)

• First working version: sending beer with "!beer" to random user which is stored and updated in json file
• fix error when moving written temp file
• if not found add new line with viewer name and set to 1
• Biggest thing: switch from csv to json data storage

v0.1.1 (don't use this, was buggy)

• Mostly code style related fixes
• Added codacy badge

v0.2.0

• Fixes a bug of v0.1.1 that caused the script to crash on load
• Fixes a known bug: data file "beerdata.json" is now created on "load" of the script, if it didnt exist yet.
• Implements new Feature: Split Beercounter for: daily and overall counters

v0.2.1

• Fixes a dumb bug in v2.0.0 where i forgot to remove the testing user-override^^
• Some preset changes and readme updated with a new idea

v0.3.0

• Implements a new feature: The bot returns a completely different response (still hardcoded) when it's the very first beer for a user.
• Some localization bugfixes

v0.3.1

• Implements a "debug message" as response, if the generated random username is an empty string (I don't know why this happens yet)
• Added more in depth code documentation

v0.4.0

• Implements a new Feature: The drunklevel! That's basically a cap of maximum beers a user can handle before he gets drunk and doesn't receive any more beers. Currently there are 3 random drunklevels with different max beer counts hardcoded (since you have better and worse days when drinking :P).

v0.4.1

• Fixes a bug that where drunklevel won't be reset after a new day (you'd be stuck being drunk forever :D)

Known bugs to fix:

• Updating the beerdata.csv only saves the current line to the new file (discards all other lines that were there before) [see v0.0.2 above]
• Big one: create "beerdata.json" file if it doesn't exists (when one just installed the script)
• Settings don't apply sometimes (discovered on "cooldown" and "command" setting; seem to load the fallback from "Settings_Module.py" then til you save your script settings again with a click.
• "How to use" stuff still missing in this readme
• Investigation needed: can you set a username on Twitch to one including umlauts (ö,ä,ü)? The script would most likely crash then
• Sometimes the function counts a beer for user "" (empty string)
• You'll be instantly sober after midnight, well^^

Future ideas in priority order (tell me what you need most):

• Outputting 1., 2. and 3. as "first" "second" and "third" (hopefully low hanging fruits)
• Split Beercounter for: daily (or per stream?) and overall
• Replace complete "parseString" if beercount is exactly 1 in Parse() so it will display a completely different response for the first beer today and maybe the first ever additionally
• Limit of beers for today (e.g. user gets too drunk)
• Feature: maybe add possibility to specifically gift beers to someone (maybe limited to X beers per hour or sth)
• Automatic backup function of beerdata.csv so that the data won't get lost
• Blacklist users (maybe with streamlabs blacklist) to exclude bots from getting beer (what a shame!) and then get switch from "random active users" to "random users"
• !top10beers
• More exception handling and debug information for streamers
• Trigger gifs on !beer command
• Combination with currency system from sl chatbot (is this really wanted or should it always be a separate "currency"?)