GitHub/PyLink
3
0
Fork 0
mirror of https://github.com/jlu5/PyLink.git synced 2024-12-26 04:32:51 +01:00
Code Issues Projects Releases Wiki Activity

docs: mention that Clientbot-only relays are not supported

Browse Source
This commit is contained in:
James Lu 2021-02-09 12:31:21 -08:00
parent 5eca51d979
commit c5541b58e5
2 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -140,3 +140,5 @@ Support for these IRCds was added at some point but is no longer actively mainta
PyLink supports connecting to IRCds as a relay bot and forwarding users back as virtual clients, 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. PyLink supports connecting to IRCds as a relay bot and forwarding users back as virtual clients, 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`. For Relay to work properly with Clientbot, be sure to load the `relay_clientbot` plugin in conjunction with `relay`.
Note: **Clientbot links can only be used as a leaf for Relay links - they CANNOT be used to host channels!** This means that Relay does not support having all your networks be Clientbot - in those cases you are better off using a classic relayer bot, like [RelayNext for Limnoria](https://github.com/jlu5/SupyPlugins/tree/master/RelayNext).

1
docs/relay-quickstart.md
View File

@ -36,6 +36,7 @@ Then, to list all available channels:
To create a channel on Relay: To create a channel on Relay:
- `/msg PyLink create #channelname` - `/msg PyLink create #channelname`
- Note: **you can only create channels on full IRCd links - this will NOT work with Clientbot.**
To link to a channel already created on a different network (network names are case sensitive!): To link to a channel already created on a different network (network names are case sensitive!):
- `/msg PyLink link othernet #channelname` - `/msg PyLink link othernet #channelname`