GitHub/PyLink
3
0
Fork 0
mirror of https://github.com/jlu5/PyLink.git synced 2024-11-01 01:09:22 +01:00
Code Issues Projects Releases Wiki Activity
https://github.com/jlu5/PyLink
528 Commits 5 Branches 72 Tags 7.2 MiB
Python 100%
75de9c6be6
Go to file
James Lu 75de9c6be6 relay: sort code and document most internal functions
2015-09-14 17:25:17 -07:00
docs/technical Fix typos and other stupid mistakes... 2015-09-06 23:18:27 -07:00
log Make sure log/ exists 2015-07-18 20:13:53 -07:00
plugins relay: sort code and document most internal functions 2015-09-14 17:25:17 -07:00
protocols Merge branch 'master' into devel 2015-09-14 16:55:35 -07:00
tests tests/inspircd: remove checks for FMODE hook data, they change too often 2015-09-13 14:06:20 -07:00
.gitignore .gitignore: ignore .pem files 2015-08-10 20:26:10 -07:00
classes.py Irc: log the offending line when an error is caught in handle_events 2015-09-13 17:58:59 -07:00
conf.py Fix test cases 2015-09-12 22:34:55 -07:00
config.yml.example Update config.yml.example for last commit 2015-09-02 23:29:01 -07:00
coreplugin.py coreplugin: reply with the *right* server name in WHOIS 2015-09-06 22:40:22 -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 Various README fixes 2015-09-13 22:36:50 -07:00
runtests.py runtests: allow specifying files to test 2015-09-12 22:31:19 -07:00
start-cpulimit.sh start-cpulimit: update binary name for f6a4503372 2015-09-06 21:53:54 -07:00
utils.py utils.reverseModes: don't reverse prefix/list modes that were never set 2015-09-13 14:05:07 -07:00
world.py Allow multiple plugins to bind to one command name! 2015-08-29 19:25:07 -07:00

README.md

PyLink

PyLink is an extensible, plugin-based IRC Services framework 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 you’d like to contribute: note that master is bugfix only; new stuff goes to the devel branch.

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

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???