phergie/phergie-irc-plugin-react-autojoin

Phergie plugin for automatically joining IRC channels

2.0.0 2015-12-21 23:43 UTC

README

A plugin for Phergie to join channels when connecting to servers.

Build Status

Install

The recommended method of installation is through composer.

composer require phergie/phergie-irc-plugin-react-autojoin

See Phergie documentation for more information on installing plugins.

Configuration

return array(
    'plugins' => array(

        new \Phergie\Irc\Plugin\React\AutoJoin\Plugin(array(

            // Required: list of channels to join
            'channels' => '#channel1,#channel2,#channelN',
            // or
            'channels' => array('#channel1', '#channel2', '#channelN'),

            // Optional: channel keys
            'keys' => 'key1,key2,keyN',
            // or
            'keys' => array('key1', 'key2', 'keyN'),

            // Optional: if true, doesn't join channels until
            // the NickServ plugin has successfully logged in
            'wait-for-nickserv' => true,

        )),

        // If wait-for-nickserv is enabled, the NickServ plugin must also be used
        new \Phergie\Irc\Plugin\React\NickServ(array(
            /* .... */
        )),

    ),
);

The option wait-for-nickserv depends on the NickServ plugin version >=1.3.0.

Tests

To run the unit test suite:

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

License

Released under the BSD License. See LICENSE.