Irc

= IRC interface plugin =

StatusNet Google Summer Of Code 2010

Introduction
Although mostly used by more technical users, after some discussion in the StatusNet IRC channel, it is clear that there is a great demand for an IRC plugin.

Download
The code for this plugin can be found in the plugins/Irc folder of the 1.0.x branch

Requirements
A queueing backend is required for all IM plugins, to enable the DB queue, add the following to your config.php

$config['queue']['enabled'] = true;

Installation
In your config.php in your SN installation add the lines

addPlugin('irc', array( 'host' =&gt; '...', 'username' =&gt; '...', 'realname' =&gt; '...', 'nick' =&gt; '...', 'channels' =&gt; array('#channel1', '#channel2') ));

Config Options
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 &lsquo;ssl&rsquo; 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&rsquo;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

To start the daemon, run

scripts/startdaemons.sh

Dev Notes
The documentation for the code base of this plugin can be found at

Dev Notes