c00491cd7a
Since these functions exit (or throw exception) after running, there is no need to have a 'return' statement or similar afterwards. |
||
---|---|---|
.. | ||
classes | ||
extlib | ||
lib | ||
locale | ||
IrcPlugin.php | ||
README |
The IRC plugin allows users to send and receive notices over an IRC network. Installation ============ add "addPlugin('irc', array('setting'=>'value', 'setting2'=>'value2', ...);" to the bottom of your config.php scripts/imdaemon.php included with StatusNet must be running. It will be started by the plugin along with their other daemons when you run scripts/startdaemons.sh. See the StatusNet README for more about queuing and daemons. Settings ======== host*: Hostname of IRC server port: Port of IRC server (defaults to 6667) username*: Username of bot realname*: Real name of bot nick*: Nickname of bot password: Password nickservpassword: NickServ password for identification nickservidentifyregexp: Override existing regexp matching request for identification from NickServ channels: Channels for bot to idle in transporttype: Set to 'ssl' to enable SSL encoding: Set to change encoding pinginterval: Set to change the number of seconds between pings (helps keep the connection open) Defaults to 120 seconds regcheck: Check user's nicknames are registered, enabled by default, set to false to disable regregexp: Override existing regexp matching response from NickServ if nick checked is registered. Must contain a capturing group catching the nick unregregexp: Override existing regexp matching response from NickServ if nick checked is unregistered Must contain a capturing group catching the nick * required Example ======= addPlugin('irc', array( 'host' => '...', 'username' => '...', 'realname' => '...', 'nick' => '...', 'channels' => array('#channel1', '#channel2') ));