gnu-social

History

Luke Fitzgerald a34e55e1a3 Change default encoding to UTF-8		2010-07-20 11:32:09 -07:00
..
extlib/phergie	Code now functional - lots of error checking and extras missing still though	2010-07-20 11:16:59 -07:00
Fake_Irc.php	Weaken send scope to protected	2010-07-20 06:26:51 -07:00
ircmanager.php	Change default encoding to UTF-8	2010-07-20 11:32:09 -07:00
IrcPlugin.php	Code now functional - lots of error checking and extras missing still though	2010-07-20 11:16:59 -07:00
README	Code now functional - lots of error checking and extras missing still though	2010-07-20 11:16:59 -07: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
channels: Channels for bot to idle in
transporttype: Set to 'ssl' to enable SSL
encoding: Set to UTF8 to enable UTF8 encoding

* required

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