A PHP-based IRC bot built on React.

The recommended method of installation is through composer.

{
    "minimum-stability": "dev",
    "require": {
        "phergie/phergie-irc-bot-react": "dev-master"
    }
}

• Easy installation with minimal configuration
• Low-friction plugin development
• Informative logging of events for debugging
• Use of third-party libraries where feasible
• Simple easy-to-understand API

To run from a project using this repository via composer, which is the recommended approach for end-users and plugin developers:

./vendor/bin/phergie

To run from a clone of this repository, which is only recommended for core developers:

./bin/phergie

In both cases, an optional list of configuration file paths can be specified as command line arguments. If none are, config.php in the current working directory will be assumed by default.

Configuration is stored in PHP files that return associative arrays. These files contain settings for IRC server connections and plugins. See config.sample.php for a example.

The bot provides enough functionality to connect to an IRC server and listen for events, but what really makes it useful to end-users is functionality provided through plugins.

Like the bot itself, plugins are installed via composer. Add any plugins you want to install to the require section of your composer.json file and run composer install or composer update as appropriate.

In order for the bot to actually use an installed plugin, it must be enabled and configured in the bot's configuration file. See config.sample.php for an example.

To get an idea of what plugins are available, check out the Plugins page in this repository's wiki.

More to come...

To run the unit test suite:

cd tests
curl -s https://getcomposer.org/installer | php
php composer.phar install
./vendor/bin/phpunit

Released under the BSD License. See LICENSE.

Check out #phergie on irc.freenode.net.