GitHub/PyLink
3
0
Fork 0
mirror of https://github.com/jlu5/PyLink.git synced 2024-11-01 09:19:23 +01:00
Code Issues Projects Releases Wiki Activity
https://github.com/jlu5/PyLink
799 Commits 5 Branches 72 Tags 7.2 MiB
Python 100%
a3a27a9031
Go to file
James Lu a3a27a9031 Merge chancmds plugin into opercmds
2016-01-03 19:59:48 -08:00
docs/technical docs: pingServer is required in protocol modules 2015-12-29 11:18:15 -08:00
log Make sure log/ exists 2015-07-18 20:13:53 -07:00
plugins Merge chancmds plugin into opercmds 2016-01-03 19:59:48 -08:00
protocols unreal: implicitly set +xt when SETHOST or CHGHOST is received (#136) 2016-01-03 11:28:35 -08:00
tests Unbrick the tests 2015-12-26 14:30:14 -08:00
.gitignore .gitignore: ignore .pem files 2015-08-10 20:26:10 -07:00
AUTHORS Add authors file 2016-01-03 10:05:30 -08:00
classes.py Irc: Return False instead of None when isInternalClient fails to find a match 2015-12-31 17:53:33 -08:00
conf.py Document more parts of the core - comments are cool right 2015-12-06 17:40:13 -08:00
config.yml.example Merge chancmds plugin into opercmds 2016-01-03 19:59:48 -08:00
coreplugin.py classes: sort code, move nickToUid, clientToServer, isInternalClient, isInternalServer into the Irc class 2015-12-31 17:28:47 -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 Document more parts of the core - comments are cool right 2015-12-06 17:40:13 -08:00
pylink pylink: more consistent logging syntax 2015-12-24 18:08:00 -08:00
README.md README: simplify module installation text 2015-12-30 15:59:22 -08:00
runtests.py runtests: allow specifying files to test 2015-09-12 22:31:19 -07:00
start-cpulimit.sh start-cpulimit: pass command line options to ./pylink 2015-09-25 20:25:07 -07:00
utils.py utils.getHostmask: option to return hostmask with real host, use placeholders w/o spaces in them 2015-12-31 18:09:52 -08:00
world.py relay/world: remove need for world.schedulers 2015-12-26 17:06:28 -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

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

  1. Rename config.yml.example 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???