#summary IRC to XMPP interface to allow IRC clients to connect to chatrooms
#labels Stage-Alpha

= Introduction =

Whether you like it or not, XMPP is the future, but that pesky IRC just won't go away :)

With this module you can set up a special host on your server to allow connections from IRC clients and bots. They are able to join XMPP chatrooms on a specified conference server.

= Usage =
In your config file put something similar to the following:

{{{
Component "irc.example.com" "ircd"
    conference_server = "conference.example.com"
}}}

If you don't want your IRC users to have connectivity outside your server then there is no need for the hostnames you specify to be valid DNS entries.

= Warning =

For now the port number used by the plugin is hardcoded to be 7000, if you want to change it, you'll need to edit the plugin file just search for "7000" in your text editor and replace it with your port of choice.
Also the plugin stability, and/or serving compatibility with most of the IRC clients is yet to be determined.

= Install =

This release requires the [http://code.matthewwild.co.uk/verse/ Verse client library] as dependancy and [http://code.matthewwild.co.uk/squish/ Squish] to meld it with the plugin.

Instructions:
 * Clone both the Verse/Squish repo and/or download the latest tips from 'em (in that case you'll have to decompress the tip zips/tarballs)
 * Edit Verse's squish file so that all plugins cept the presence and groupchat ones will be commented
 * In your Squish directory type make install
 * Run squish.lua --use-http into your Verse's directory, and move verse.lua into where mod_ircd files from google code's HG are stored
 * Run squish.lua again
 * Move the mod_ircd.out.lua to your prosody's plugin directory renaming it back to mod_ircd.lua

= Compatibility =
||0.8||Works||
||0.7||Uncertain||
||0.6||Uncertain||

= Todo =
  * Authentication
  * SSL
  * Many improvements to handling of IRC and XMPP