3
0
mirror of https://github.com/jlu5/PyLink.git synced 2024-11-24 03:29:28 +01:00
Go to file
James Lu 9e73af050c relay: unpluralize "relayWhoisHandlers"
There's only one handler, why did I make it plural?
2015-09-06 22:39:40 -07:00
docs/technical docs/: Start work on writing-plugins.md, improvements to example plugin 2015-08-24 12:10:14 -07:00
log Make sure log/ exists 2015-07-18 20:13:53 -07:00
plugins relay: unpluralize "relayWhoisHandlers" 2015-09-06 22:39:40 -07:00
protocols ts6_common: fix a typo 2015-09-06 22:09:09 -07:00
tests Remove unused imports 2015-08-30 12:53:30 -07:00
.gitignore .gitignore: ignore .pem files 2015-08-10 20:26:10 -07:00
classes.py move utils.msg() => classes.Irc.msg() 2015-09-06 22:23:44 -07:00
conf.py Refactor conf loading; skip the file-loading parts entirely for tests (#56) 2015-08-29 14:20:20 -07:00
config.yml.example Update config.yml.example for last commit 2015-09-02 23:29:01 -07:00
coreplugin.py move utils.msg() => classes.Irc.msg() 2015-09-06 22:23:44 -07: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 Support loading different config files from the command line 2015-08-03 19:27:19 -07:00
pylink Use a more unique main executable name... 2015-09-04 18:20:46 -07:00
README.md relay: fix many bugs with nick collision handling, and add flood prevention for fixing nicks 2015-08-22 21:01:51 -07:00
runtests.py Remove unused imports 2015-08-30 12:53:30 -07:00
start-cpulimit.sh start-cpulimit: update binary name for f6a4503372 2015-09-06 21:53:54 -07:00
utils.py move utils.msg() => classes.Irc.msg() 2015-09-06 22:23:44 -07:00
world.py Allow multiple plugins to bind to one command name! 2015-08-29 19:25:07 -07:00

PyLink

PyLink is an extensible, plugin-based IRC PseudoService written in Python. It aims to be a replacement for the now-defunct Janus.

Usage

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 youd like to contribute.

Dependencies

Dependencies currently include:

  • Python 3.4+
  • PyYAML (pip install pyyaml or apt-get install python3-yaml)
  • For the relay plugin only: expiringdict (pip install expiringdict/apt-get install python3-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

Installation

  1. Rename config.yml.example to config.yml and configure your instance there. Not all options are properly implemented yet, and the configuration schema isnt finalized yet - this means that your configuration may break in an update!

  2. Run main.py from the command line.

  3. Profit???