gnu-social

History

Evan Prodromou 83fb5e6023 Mass replacement of #-comments with //-comments like leprous boils in our code. So, I've replaced all of them with // comments instead. It's a massive, meaningless, and potentially buggy change -- great one for the middle of a release cycle, eh?		2011-03-22 11:54:23 -04:00
..
extlib	Merge in Phergie changes	2010-08-12 11:58:53 -07:00
locale	Localisation updates from http://translatewiki.net .	2011-03-18 20:59:45 +01:00
ChannelResponseChannel.php	send_message -> sendMessage	2010-09-03 17:50:28 -04:00
Fake_Irc.php	Added more commenting	2010-08-07 16:32:17 -07:00
IrcPlugin.php	is_otr -> isOtr	2010-09-03 17:50:29 -04:00
Irc_waiting_message.php	Mass replacement of #-comments with //-comments	2011-03-22 11:54:23 -04:00
README	Add an config option to change the ping interval	2010-08-11 10:49:09 -07:00
ircmanager.php	send_confirmation_code -> sendConfirmationCode	2010-09-03 17:50:28 -04:00

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