The bot is NOT READY for other streamers to use -- not enough config options are available yet. However you are welcome to give it a try and let us know what features you want.
- Update Settings
- Changes may require restarting the app
- You can leave Twitter values null
- The bot likes to whisper with the streamer. You may need to follow the bot if whispers are not appearing.
!help !command
Use the !command to create new commands for your channel. e.g. !social to drop a link to your Twitter.
Note that the "!" is just a style convention Twitch uses, it is not required.
There is an optional cooldown. If a command is issued too quickly, the response is whispered instead of posted in chat again. Mods bypass the cooldown period.
!help !alias
Aliases allow you to have alternate words for the same command. e.g. !twitter can be an alias of !social so that either works.
FYI the command cooldown is per command and not per alias.
!help !eta
Counts down till the next stream.
The ETA (and optional message) is auto posted anytime someone new enters the chatroom while you are offline. (FYI we do not mention users by name).
!help !live
Starts streaming in OBS if the app is open. Issues an unhost and posts a message to chat.
If you include a note when going live it is posted to Twitter (with a link to the channel), as a reply to a previous conversion.
!uptime
Tracks uptime for the stream (and total for the day).
Check or set the stream's title and/or game.
!help !title
!help !setgame
!help !tweet
!Tweet posts to both Twitter and Pulse. When posting to Twitter, a link to the channel is added. Note tweets are not under the previous conversion like the tweet sent when going live.
!help !shoutout
Creates a custom message for shouting out another streamer.
The bot will auto shoutout someone who hosted us or the person we are hosting.
- First message
- OnSub and on Bits -> Thanks (do we have a bit event yet)
- Host and Hosting -> shoutout
- Stream title (updated anytime you change the text)
- Issue command (this is the same as whispering the bot)
- Note that the "!" prefix is optional when whispering the bot.
- Settings (saves to settings.json)
- There are a couple files created by the bot you may use in OBS (under the bin directory):
- TODO.txt (currently your stream title)
- Keystrokes.txt (holds the most recent keyboard combinations like "ctrl+s")
(coming soon?) For the mods out there (my channel or others), what features might be helpful?
- Clone this repro
- Clone HardlyCommon in the same directory (so ChatBot and HardlyCommon folders are side by side)
- If references are broken (very likely):
- Open menu Tools -> NuGet Package Manager
- Run
Update-Package -reinstall
- Hit play.
- It'll prompt you for settings. Fill these in and then restart the app.
Do this frequently if you are making changes
- Change directory to your local repository.
- Switch to master branch if you are not
git checkout master - Add the parent as a remote repository,
git remote add upstream https://github.com/hardlydifficult/ChatBot.git - Issue
git fetch upstream - Issue
git rebase upstream/master - Check for pending merges with
git status - Issue
git push origin master
https://stackoverflow.com/a/31836086
- ChatBotEngine
- Why project separation? - Facade
- Dynamic commands
This bot is NOT ready for another streamer to use. Our TODO list is here: https://trello.com/b/M3Z2GerB/chatbot
If you are interested in contributing, please! Just let me know if you have questions.
If you are a streamer interested in using this, let us know what features you want.