gnu-social/plugins/Irc
2010-07-09 02:53:58 -07:00
..
extlib/phergie Added missing closing bracket 2010-07-09 02:53:58 -07:00
Fake_Irc.php Fix Fake_Irc to store data to send, not raw socket data to send 2010-07-09 01:21:33 -07:00
ircmanager.php Initial IRC plugin work 2010-07-04 09:51:44 -07:00
IrcPlugin.php Initial IRC plugin work 2010-07-04 09:51:44 -07:00
README Updated README 2010-07-09 02:02:50 -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
username*: Username of bot
realname*: Real name of bot
nick*: Nickname of bot
password: Password
nickservpassword: NickServ password for identification
channels: Channels for bot to idle in
transport: Set to 'ssl' to enable SSL
encoding: Set to UTF8 to enable UTF8 encoding

* required

Example
=======
addPlugin('irc', array(
    'host' => '...',
    'port' => '...',
    'username' => '...',
    'realname' => '...',
    'nick' => '...',
    'channels' => array('#channel1', '#channel2')
));