gnu-social/plugins/Irc
Mikael Nordfeldth c00491cd7a Cosmetic changes to common_redirect, clientError, serverError
Since these functions exit (or throw exception) after running, there
is no need to have a 'return' statement or similar afterwards.
2014-03-10 00:25:57 +01:00
..
classes plugins onAutoload now only overloads if necessary (extlibs etc.) 2013-08-28 16:10:30 +02:00
extlib Merge in Phergie changes 2010-08-12 11:58:53 -07:00
lib Cosmetic changes to common_redirect, clientError, serverError 2014-03-10 00:25:57 +01:00
locale Localisation updates from http://translatewiki.net. 2012-06-30 11:10:38 +00:00
IrcPlugin.php Using GNUSOCIAL_VERSION instead of STATUSNET_VERSION 2013-11-01 13:51:41 +01:00
README Add an config option to change the ping interval 2010-08-11 10:49:09 -07:00

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')
));