Hedgebot, chatting around at the speed of sound
Hedgebot is a Twitch Bot written in PHP, aimed at a server-side use. It aims to provide a flexible and powerful setup for streamers and communities to improve their chatrooms.
It requires at least PHP 7.0 to be used.
Core functions :
- Connects to Twitch IRC servers one or multiple times (multi-server setup)
- Connects to multiple channels
- It has a flexible plugin management system, based on an event system
- Handles disconnections
- Basic Twitch API v5 handling (via Twitch PHP Client)
- JSON-RPC based API for remote querying (web-based admin ?)
- Internal API for quick and easy access to bot functions from plugins
- Documentation generator for plugin commands (outputs Markdown).
- Web admin (see Hedgebot Web Admin)
- Live refresh through servent-sent events (formerly Socket.IO used, abandoned for Mercure.
Plugins :
- Announcements: Sends stored messages periodically on the channel to announce things.
- CustomCommands: Allows to create custom commands that prints messages upon call.
- Quotes: Handles a quote manager.
- Currency: Handles a currency/money system on the chat.
- BannedWords: ??? (plugin to rework).
- BlackJack: Handles a blackjack game system.
- Horaro: Handles a stream schedule set via Horaro. It feeds the bot's store and changes the Twitch channel's title and game according to the schedule items values.
- HoraroTextFile: Stores the current item of a schedule loaded in the Horaro plugin in a text file for other programs to access.
- TestManager: Development-oriented plugin that allows to test how other plugins are supposed to work.
- Twitter: Allows scheduling tweets to automatically send at a specific time or when a specific event is fired.
- StreamControl : Handle basic stream updates : title, game, ...
- AutoHost: Handles a hosting manager, included priorities (with %), time to switch to another stream and whitelist/blacklist of words into title.
- Timer: Handles timers that can be started, stopped, paused and viewed through a web admin.
(Plugins names in bold style means they have also a web-admin interface, see below)
- [IN PROGRESS] Spam regulation plugin (BannedWords), timing out users for unwanted words in messages, links, walltexts and/or other things
- Donation alerts, with StreamLabs API
- Cooldown feature, as a core feature (allowing cooldown per user type and per command).
- [IN PROGRESS] Logger core feature, allowing logging actions from every plugin
- Statistics plugin, gathering real time stats from chat
- Discord API integration
- [IN PROGRESS] Raffle plugin
- Update all plugins' comments to fit Documentor standards (like on the Currency plugin).
- Enhanced Twitter plugin: Allow tweets with multiple images.
If you want to install it, you can follow the wiki page detailing all the instructions.
If you want to help improving this bot, you can do it in the following ways :
- Developing plugins. If you want to merge them in the main tree, drop a Pull Request :)
- Documenting things.
- Testing. Tests are done to ensure that the plugins work properly, but nothing beats a real field test.
For all of these things, if you want to discuss about it, feel free to contact me on my Twitter : @linkboss. If the project grows a bit, other means of discussion will be put in place.
