Twitchirc - a PHP Twitch IRC bot framework

Twitchirc is a Slim-inspired framwork for creating simple Twitch IRC bots.

Requirements

PHP 7.2.5+
Composer

Installation

The best way to create a bot based on Twitchirc is to use Composer. From the command line, create a directory for your bot. In this directory, first download Composer:

$> curl -s http://getcomposer.org/installer | php

Then create and open a composer.json file. Add TitchIRC to the list of required libraries:

{
    "require": {
        "tohur/twitchirc": "dev-master"
    }
}

Run Composer's install command to download and install the Twitchirc library:

$> php composer.phar install -v

Once this is complete, your directory should have a few new items (a composer.lock file, and a vendors directory) in it, and you should be ready to go. All that's left is to create the the bot. You can name your bot whatever you want, though bot.php is nice and easy. Here's a basic example:

// bot.php
<?php

require __DIR__ . '/vendor/autoload.php';

$config = array(
    "ssl"          => true,
    "username"     => "examplebot",
    "realname"     => "example IRC Bot",
    "nick"         => "examplebot",
    "password"     => "password-for-nickserv",
    "channels"     => array( '#example-channel' ),
    "unflood"      => 500,
    "admins"       => array( 'example' ),
    "debug"        => true,
    "log"          => __DIR__ . '/bot.log',
);

$bot = new Twitchirc($config);

$bot->onChannel('/^!echo (.*)$/', function($event) {
    $matches = $event->getMatches();
    $event->addResponse(Response::msg($event->getRequest()->getSource(), trim($matches[0])));
});

$bot->run();

Save your file, and start your bot:

$> php examplebot.php

And that's all there is to it! Your bot will connect to the IRC server and join the channels you've specified. Then it'll start listening for any commands you've created. For more information about Twitchirc's API, please see the API section below. But first, let's quickly cover the configuration array...

Configuration

Configuration for Twitchirc is a basic array of key-value pairs. Here's a quick reference to what each key value pair is:

username: string, the IRC username for the bot
realname: string, the IRC "real name" for the bot
nick: string, the IRC nickname for the bot
password: string, optional, the password to authencate with from https://twitchapps.com/tmi/
channels: array, an array of channels for the bot to join. For example:
```
'channels' => array(
    '#channel1',
    '#channel2'
)
```
unflood: int, optional, the amount of time to wait between sending messages
admins: array, optional, an array of names of IRC users who have admin control of the bot (required by some plugins)
debug: boolean, whether or not to print debug information,
log: string, path where to store the bot's log file, required if debug is turned on

API

Twitchirc's API is simple and similar to JavaScript's "on*" event system. You add functionality to your bot by telling it how to respond to certain events. Events include things like channel messages, private messages, users joining a channel, users leaving a channel, etc.

There are two kinds of events in Twitchirc: server events and message events. The only real difference between the two is that you can tell Twitchirc to conditionally respond to message events. Since your bot will always respond to server events, the API for those is simpler:

$bot->on<Event>(<callback function>[, <priority>]);

Possible values for <Event> in this case are: Join, Part, Error, and Notice.

For message events, to determine whether your bot should respond to a given event, you will supply a regular expression that Twitchirc will test against. If the regex matches, then Twitchirc will execute the callback function you provide. The API for message events is:

$bot->on<Event>(<regex pattern>, <callback function>[, <priority>]);

Possible values for <Event> include Channel, PrivateMessage, and Message.

Event Examples:

// Message Events
$bot->onChannel()           // listens only to channel messages
$bot->onPrivateMessage()    // listens only to private messages
$bot->onMessages()          // listens to both channel messages and private messages

// Server Events
$bot->onError()             // listens only for IRC ERROR messages
$bot->onInvite()            // listens only for invites to channels
$bot->onJoin()              // listens only for people joining channels
$bot->onKick()              // listens only for people getting kicked from channels
$bot->onMode()              // listens only for IRC MODE change messages
$bot->onNick()              // listens only for people changing nick on channels
$bot->onNotice()            // listens only for IRC NOTICE messages
$bot->onPart()              // listens only for people leaving channels
$bot->onPing()              // listens only for IRC PING messages
$bot->onQuit()              // listens only for people leaving servers
$bot->onTopic()             // listens only for channel topic changes

The <regex pattern> is a standard PHP regular expression. If null is passed instead of a regular expression, the callback function will always be executed for that event type. If any match groups are specified in the regular expression, they will be passed to the callback function through the event.

If your regular expression is successfully matched, Twitchirc will execute the callback function you provide, allowing you to respond to the message. The <callback function> is an anonymous function that accepts one parameter: $event.

Setting the <priority> is optional. In case a event matches multiple callback functions, the one with the highest priority is executed first. If priority is not set, the default value (0) will be used. If multiple callbacks have the same priority, they are executed in the order they where added.

$event is an instance of Twitchirc\IRC\Event (which is a simple wrapper over an IRC "event"). The main functions in the public API for a Twitchirc Event re:

$event->getRequest()        // Returns a Twitchirc Request object
$event->getMatches()        // Returns an array of any matches found for match
                               groups specified by the <regex pattern>.
$event->addResponse()       // Adds a response to the list of responses for the event.

There is no captured return value for the callback function. However, if you wish to send a message back to the IRC server, your callback function can add a response to the list of responses by using the addResponse() method on the Event object. The addResponse() method expects its only parameter to be an instance of a Twitchirc Response object.

Putting all this together, let's look an example of adding echo functionality to Twitchirc:

Example:

$bot->onChannel('/^!echo (.*)$/', function($event) {
    $matches = $event->getMatches();
    $event->addResponse(Response::msg($request->getSource(), trim($matches[0])));
});

In this example, the bot will listen for channel messages that begin with !echo and are followed by anything else. The "anything else" is captured in a match group and passed to the callback function. The callback function simply adds a response to the event that send the matching message back to the channel that originally received the message.

Methods of note in the `Twitchirc\IRC\Request` object:

$request->getSendingUser()      // Get the nick of the user sending a message
$request->getSource()           // Get the channel of the sent message,
                                // or nick if it was a private message
$request->getMessage()          // Get the text of a message for channel/private messages

Methods of note in the `Twitchirc\IRC\Response` object:

Response::msg($who, $msg)      // Sends a message $msg to channel/PM $who
Response::action($who, $msg)   // Same as a ::msg(), but sends the message as an IRC ACTION

Plugins

Twitchirc supports a basic plugin system, and adding a plugin to your bot is simple.

Using a plugin

Using a plugin is simple. Plugins should be Composer-able, so start by include the plugins via Composer. Once you've run composer update and your plugins are available in your bot, you can load the plugins by calling either loadPlugin(<name>) (to load them one at a time), or loadPlugins(array()) (to load multiple plugins at once).

For example, if you had a plugin whose full, namespaced classname was \Example\Twitchirc\Plugin\HelloPlugin, you can do load it in your both with either of the following:

$bot = new Twitchirc(array(/*...*/));
$bot->loadPlugin(new \Example\TwitchircPlugin\HelloPlugin($bot));
$bot->loadPlugins(array(
    new \Example\TwitchircPlugin\HelloPlugin($bot),
    // ...
));

Plugins accept a second (optional) parameter on their constructor if the plugin requires some configuration. Loading a plugin that accepts configuration might look like this:

$bot = new Twitchirc(array(/*...*/));
$bot->loadPlugin(new \Example\TwitchircPlugin\HelloPlugin($bot, $config['HelloPlugin']));

Additionally, if you'd like to turn some of your bot's functionality into a plugin, that's easy as well.

Writing a plugin

Creating a plugin is simple. A plugin must extend the Twitchirc\AbstractPlugin class and must provide and implementation for an init() and a getName() method. And that's it. Your plugin can be named anything, however, by convention most Twitchirc plugins are named like <xxx>Plugin Below is an example of a simple plugin:

// .../Example/TwitchircPlugin/HelloPlugin.php
<?php

namespace Example\TwitchircPlugin;

use Twitchirc\AbstractPlugin as BasePlugin;

class HelloPlugin extends BasePlugin
{
    /**
     * Does the 'heavy lifting' of initializing the plugin's behavior
     */
    public function init()
    {
        $this->bot->onChannel('/^hello$/', function($event) {
            $request = $event->getRequest();
            $event->addResponse(
                Response::msg($request->getSource(), "Hi, {$request->getSendingUser()}!")
            );
        });
    }

    /**
     * Returns the Plugin's name
     */
    public function getName()
    {
        return 'HelloPlugin';
    }
}

License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

This license is also included in the LICENSE file.

Author

Joshua Webb AKA Tohur - https://github.com/TohurTV - https://twitter.com/tohurTV

tohurtv/TwitchIRC