This will stop working completely by September 12 2019, if it still works at all. I do not have plans to update this project.
A complete rewrite is being worked on at: https://github.com/Skhmt/koalabot2
It's a moderation bot for Twitch meant for roughly the same things as nightbot, moobot, ankhbot, deepbot, etc. This is and always will be free and open source. It runs off your desktop. I'm always open to feature requests, bug reports, and any constructive critique. Hit me up on Twitch or Twitter or Reddit.
- Chat window with emoticons and viewer list
- !highlight / !ht command to tag a place for VOD editing later
- Quote system
- Custom commands
- Timed messages
- Spam control via link, word, caps, symbols
- Viewer count graphs
- Customizable !uptime command based on bot running time, stream uptime, or a custom set time
- Chat logging
- Hosts logging
- Giveaways
- Song requests
- Follower logging
- Sub notifications
- Update backend to allow plugins
- Loyalty points
- OS X compatibility
- API command for recent events (to allow server notifications)
- Enable/Disable subscriber months text
- Streamer song queue that's overridden by user song requests
- Option to have song requests cost points
- Save song lists
- Add a user to points list even if that user is not in the chat
- Add a "play" button to individual quotes and timed messages
- More text file outputs
- Put game and stream title in the window title
- Reduce saving to every 30 seconds or so
- Generic Module status tab + api command for module description
- Documentation on how obs-integration works
- Add "regular" rank (between viewer and sub)
- Global hotkeys
- Change mod requirements for commands
- Cooldowns for commands
- timed messages not playing if the stream isn't live
- disable/enable timed messages
- Top x (100?) users?
- All users "filter" button for point list
- Play songs instantly?
- Add song playing to streamer queue
- Move game/stream status to chat tab
- Points requirement for raffles
- Edit timed messages, commands, and quotes
- User ranks
- On first chat notification
- Open/view old statistics (https://github.com/nwjs/nw.js/wiki/File-dialogs)
| Command | Parameters | Description |
|---|---|---|
| !bot | n/a | Links to this page. |
| !uptime | n/a | Configurable in the "Settings" tab to display either the bot uptime, the stream uptime, or the lap time. |
| !bottime | n/a | Shows the amount of time the bot has been open. |
| !streamtime | n/a | Shows the amount of time your stream has been going (if your stream disconnects, this resets). |
| !laptime | n/a | Shows the amount of time since you've hit the "lap" button. |
| !highlight | (comments) | Mod-only. Adds a time stamp to a log file (both local time and stream time) with the optional comments. |
| !ht | Same as above. | |
| !game | [game name] | Mod-only. Changes the game. |
| !status | [stream status] | Mod-only. Changes the stream status. |
| !permit | [username] | Mod-only. Allows the user to post links for 60 seconds. |
| !addcom | (-ul=[mod/sub/streamer]) [!commandname] [text] | Mod-only. Adds a command. The new command can be set to only be used by a certain user level. Using %1%, %2%, %3%, %4%, or %5% when creating a command will replace it with that parameter when the command is run. For example, "!addcom !tree %1% and %2% sitting in a tree" then "!tree wolfish indy" would output "wolfish and indie sitting in a tree". Use %from% to insert the username of the person that used the command. |
| !addcmd | Same as above. | |
| !delcom | [!commandname] | Mod-only. Deletes a command. |
| !delcmd | Same as above. | |
| !quote | (id) | Plays a random quote. If an id is given, it will attempt to play the quote with that id. |
| !addquote | [quote author] [quote] | Adds a quote. |
| !delquote | [id] | Mod-only. Deletes the quote with the given id. |
| !currentsong | Returns the current song playing. | |
| !skipsong | Mod-only. Skips the currently playing song. | |
| !volume | [volume 0-100] | Mod-only. Sets the song volume to this. |
| !mute | Mod-only. Mutes/unmutes the song, does not change the volume level. | |
| !songrequest | [youtube id or youtube url] | Adds a song to the queue. |
| !points | Displays your points. |
- For Windows: Run koalaBot.exe
- For OS X: NWJS is no longer available from the app store, but is available at their website. Download the Koalabot osx .zip and unzip it into the same directory as nwjs.app. Run nwjs.app. OSX may prompt that the application is from an untrusted source. If that happens, go to settings > Security & Privacy > General, and set the "Allow Apps from Anywhere" option and launch the application. After launching for the first time, it would be a good idea to set the securtiy settings back to "App Store and Identified Developers".
- Go to Settings > Bot Config
- Click "Get Token"
- If Windows pops up something about the firewall, click OK.
- Log in to the Twitch account you want the bot to be
- If you're using the bot on an account other than the one you stream on, make sure the bot is both a mod and an editor for your channel. To make the bot an editor, go to your Twitch Dashboard on your main account.
Modules are HTML5 + javascript (ES6) + jQuery (2.2.0) + Boostrap (3.3.6). See my example module for working example. To install it, save it as a .js file and place it in the \mods\ folder, then restart the bot. Also see the API for more details and some functionality not used in example.js. Share modules via JSFiddle or Gist.
Themes are just Bootstrap 3.3.6 .css files. Put them in the themes folder and restart the bot.
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation version 3.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.