3
0
mirror of https://github.com/jlu5/PyLink.git synced 2024-11-01 09:19:23 +01:00
Go to file
2016-04-01 23:14:04 -07:00
docs/technical Regenerate pydoc documentation 2016-03-26 11:42:12 -07:00
log Make sure log/ exists 2015-07-18 20:13:53 -07:00
plugins Merge branches 'master' and 'wip/relay-fixes' into devel 2016-04-01 18:32:19 -07:00
protocols unreal: use an awful outFilter hack to convert PUIDs->nicks when sending outgoing commands 2016-04-01 23:14:04 -07:00
tests Use more flexible shebangs (/usr/bin/env python3) 2016-04-01 18:22:02 -07:00
.gitignore gitignore: Ignore env folder for virtualenvs 2016-03-29 19:52:57 +10:00
.mailmap Add .mailmap 2016-03-17 15:08:41 -07:00
AUTHORS Add authors file 2016-01-03 10:05:30 -08:00
classes.py classes: remove ts6-specific hack in Protocol.removeClient 2016-04-01 22:55:03 -07:00
conf.py conf: fix testconf missing the logging: section 2016-03-11 23:14:16 -08:00
coreplugin.py coreplugin: modularize shutdown routines, handle SIGTERM->shutdown 2016-03-27 21:46:10 -07:00
example-conf.yml example conf: use 1 "#" without trailing space for commented-out options 2016-01-30 23:37:01 -08:00
kill.sh Add wrapper scripts (start-cpulimit.sh, kill.sh) to assist running PyLink under cpulimit 2015-07-25 16:58:11 -07:00
LICENSE Add a LICENSE: MPL 2.0 2015-06-20 21:10:50 -07:00
log.py log: respect child loggers' levels if they are lower than the main one's 2016-03-25 15:45:26 -07:00
pylink Use more flexible shebangs (/usr/bin/env python3) 2016-04-01 18:22:02 -07:00
README.md New servprotect plugin (anti-KILL/SAVE flood) 2016-03-25 16:51:02 -07:00
runtests runtests: remove .py extension, only run tests when ran as a script 2016-03-11 23:14:16 -08:00
start-cpulimit.sh start-cpulimit: pass command line options to ./pylink 2015-09-25 20:25:07 -07:00
utils.py utils: also don't crash in applyModes for bad mode targets 2016-03-26 18:14:53 -07:00
world.py world: use a better module description 2016-03-11 23:14:16 -08:00

PyLink

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

  1. a replacement for the now-defunct Janus.

  2. a versatile framework and gateway to IRC.

Support

Please report any bugs you find to the issue tracker. Pull requests are open if youd 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

  1. Rename example-conf.yml to config.yml and configure your instance there. Note that the configuration format isnt finalized yet - this means that your configuration may break in an update!

  2. Run ./pylink from the command line.

  3. Profit???