From a09ec494f62cd6a66b24f4525cf1880c28e67498 Mon Sep 17 00:00:00 2001 From: James Lu Date: Fri, 14 Oct 2016 22:39:03 -0700 Subject: [PATCH] README: cherry-pick updates from the devel branch Squashed commit of the following: commit 00279a148abe5f1f5413116b7736f758883c8287 Author: James Lu Date: Mon Oct 10 15:55:36 2016 -0700 README: update clientbot notes (cherry picked from commit 0db194726318ce2bb46b454ebe792b3896f4b80c) commit 33cd90c2553977f17e61006f29288abbe9fe5cac Author: James Lu Date: Mon Oct 10 15:54:30 2016 -0700 README: update IRCd notes (cherry picked from commit 44d139f610f51d51bd59b00015fa75ad9548ee4c) commit 639e185977e8cfe98932310d132751ea9d720609 Author: James Lu Date: Sun Sep 25 19:32:00 2016 -0700 README: briefly mention protocols/clientbot (cherry picked from commit 1fbd9edc3b9601841b06d94aca907ea27fcab677) --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 40e3248..cf072ed 100644 --- a/README.md +++ b/README.md @@ -66,7 +66,7 @@ First, make sure the following dependencies are met: These IRCds (in alphabetical order) are frequently tested and well supported. If any issues occur, please file a bug on the issue tracker. -* [charybdis](http://charybdis.io/) (3.5+ / git master) - module `ts6` +* [charybdis](http://charybdis.io/) (3.5+) - module `ts6` * [InspIRCd](http://www.inspircd.org/) 2.0.x - module `inspircd` - For vHost setting to work, `m_chghost.so` must be loaded. - Supported channel, user, and prefix modes are negotiated on connect, but hotloading modules that change these is not supported. After changing module configuration, it is recommended to SQUIT PyLink to force a protocol renegotiation. @@ -78,7 +78,7 @@ These IRCds (in alphabetical order) are frequently tested and well supported. If Support for these IRCds exist, but are not tested as frequently and thoroughly. Bugs should be filed if there are any issues, though they may not always be fixed in a timely fashion. * [Elemental-IRCd](https://github.com/Elemental-IRCd/elemental-ircd) (6.6.x / git master) - module `ts6` -* [InspIRCd](http://www.inspircd.org/) 2.2 (git master) - module `inspircd` +* [InspIRCd](http://www.inspircd.org/) 3.0.x (git master) - module `inspircd` * [IRCd-Hybrid](http://www.ircd-hybrid.org/) (8.2.x / svn trunk) - module `hybrid` - Note: for host changing support and optimal functionality, a `service{}` block / U-line should be added for PyLink on every IRCd across your network. * [juno-ircd](https://github.com/cooper/yiria) (11.x / janet) - module `ts6` (see [configuration example](https://github.com/cooper/juno/blob/master/doc/ts6.md#pylink)) @@ -87,3 +87,9 @@ Support for these IRCds exist, but are not tested as frequently and thoroughly. - For optimal functionality (mode overrides in relay, etc.), consider adding `UWorld{}` blocks / U-lines for every server that PyLink spawns. Other TS6 and P10 variations may work, but are not officially supported. + +### Clientbot + +Since v1.0, PyLink supports connecting to IRCds as a relay bot and forwarding users back, similar to Janus' Clientbot. This can be useful if the IRCd a network used isn't supported, or if you want to relay certain channels without fully linking with a network. + +For Relay to work properly with Clientbot, be sure to load the `relay_clientbot` plugin in conjunction with `relay`.