mirror of https://github.com/jlu5/PyLink.git synced 2024-11-01 01:09:22 +01:00

James Lu ba7b6af89b Rename config.yml.example -> example-conf.yml

Easier syntax highlighting with editors this way, since the file extension is now something they recognize. Also, update README and .gitignore accordingly.

2016-01-03 20:02:23 -08:00

1.4 KiB

Raw Blame History

PyLink

PyLink is an extensible, plugin-based IRC services framework written in Python. It aims to be:

a replacement for the now-defunct Janus.
a versatile framework and gateway to IRC.

Support

PyLink is a work in progress and thus may be very unstable! No warranty is provided if this completely wrecks your network and causes widespread rioting amongst your users!

That said, please report any bugs you find to the issue tracker. Pull requests are open if you’d like to contribute, though new stuff generally goes to the devel branch.

You can also find support via our IRC channel: #PyLink at irc.overdrivenetworks.com (webchat). Ask your questions and be patient for a response.

Dependencies

Python 3.4+
PyYAML (pip install pyyaml)
For the relay plugin: expiringdict (pip install expiringdict)

Supported IRCds

InspIRCd 2.0.x - module inspircd
charybdis (3.5.x / git master) - module ts6
Elemental-IRCd (6.6.x / git master) - module ts6
UnrealIRCd 4.x (experimental) - module unreal (NOT Unreal 3.2 or lower)

Setup

Rename example-conf.yml to config.yml and configure your instance there. Note that the configuration format isn’t finalized yet - this means that your configuration may break in an update!
Run ./pylink from the command line.
Profit???