GitHub/PyLink
3
0
Fork 0
mirror of https://github.com/jlu5/PyLink.git synced 2024-12-28 13:42:37 +01:00
Code Issues Projects Releases Wiki Activity
https://github.com/jlu5/PyLink
907 Commits 5 Branches 72 Tags 7.2 MiB
Python 100%
514072804c
Go to file
James Lu 514072804c README: mention the implications of #193
2016-04-01 20:26:30 -07:00
docs/technical docs/t: use rawgit links to serve HTML 2016-03-11 23:20:08 -08:00
log Make sure log/ exists 2015-07-18 20:13:53 -07:00
plugins relay: fix typo in comment 2016-03-30 21:22:18 -07:00
protocols unreal: fix wrong variable name in handle_umode2 2016-03-26 12:50:23 -07:00
tests Remove references to overdrive TLDs in code 2016-01-17 21:07:51 -08:00
.gitignore Rename config.yml.example -> example-conf.yml 2016-01-03 20:02:23 -08: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 Irc: run initVars() on connect too 2016-03-25 17:14:53 -07:00
conf.py conf: fix testconf missing the logging: section 2016-03-11 23:14:16 -08:00
coreplugin.py coreplugin: tell plugins to exit cleanly before closing connections 2016-03-05 10:22:00 -08: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 pylink: don't crash if plugin is missing 2016-01-03 21:05:45 -08:00
README.md README: mention the implications of #193 2016-04-01 20:26:30 -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: actually abort when mode target is invalid 2016-03-26 17:58:03 -07:00
world.py world: use a better module description 2016-03-11 23:14:16 -08:00

README.md

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 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 relay plugin: expiringdict (pip install expiringdict)
  • 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
    • Note: Unreal 3.2, or any mixed 3.2/4.0 networks are NOT supported (see issue #193)

Setup

  1. 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!

  2. Run ./pylink from the command line.

  3. Profit???