mirror of
https://github.com/jlu5/PyLink.git
synced 2024-12-24 03:33:10 +01:00
docs/technical | ||
log | ||
plugins | ||
protocols | ||
tests | ||
.gitignore | ||
.mailmap | ||
AUTHORS | ||
classes.py | ||
conf.py | ||
coreplugin.py | ||
example-conf.yml | ||
kill.sh | ||
LICENSE | ||
log.py | ||
pylink | ||
README.md | ||
runtests | ||
start-cpulimit.sh | ||
utils.py | ||
world.py |
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
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 channels:
#PyLink @ irc.overdrivenetworks.com
(webchat)
or #PyLink @ chat.freenode.net
. Ask your questions and be
patient for a response.
Dependencies
- Python 3.4+
- PyYAML (
pip install pyyaml
) - For the servprotect plugin: python3-expiringdict
(
apt-get install python3-expiringdict
; not available in pip) - For the changehost and opercmds plugins: ircmatch
(
pip install ircmatch
)
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 - module
unreal
(NOT Unreal 3.2 or lower)
Setup
Rename
example-conf.yml
toconfig.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???