phergie / phergie-irc-plugin-react-autojoin
Phergie plugin for automatically joining IRC channels
Installs: 6 048
Dependents: 7
Suggesters: 2
Security: 0
Stars: 4
Watchers: 4
Forks: 3
Open Issues: 1
Requires
Requires (Dev)
Suggests
- phergie/phergie-irc-plugin-react-nickserv: Enables wait-for-nickserv autojoin functionality
This package is not auto-updated.
Last update: 2020-03-16 04:35:34 UTC
README
This repo is being kept for posterity and will be archived in a readonly state. If you're interested it can be forked under a new Composer namespace/GitHub organization.
phergie/phergie-irc-plugin-react-autojoin
A plugin for Phergie to join channels when connecting to servers.
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
.