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
811 Commits 5 Branches 72 Tags 7.2 MiB
Python 100%
f2efaf9437
Go to file
James Lu f2efaf9437 docs: update hooks-reference (#113)
2016-01-09 19:18:19 -08:00
docs/technical docs: update hooks-reference (#113) 2016-01-09 19:18:19 -08:00
log Make sure log/ exists 2015-07-18 20:13:53 -07:00
plugins opercmds: add KILL command (#90) 2016-01-09 18:34:57 -08:00
protocols note to self: never use case-insensitive find/replace again 2016-01-09 18:34:41 -08:00
tests Unbrick the tests 2015-12-26 14:30:14 -08:00
.gitignore Rename config.yml.example -> example-conf.yml 2016-01-03 20:02:23 -08:00
AUTHORS Add authors file 2016-01-03 10:05:30 -08:00
classes.py classes: show instance type in classes.IrcUser/IrcChannel/IrcServer 2016-01-09 19:15:39 -08:00
conf.py Document more parts of the core - comments are cool right 2015-12-06 17:40:13 -08:00
coreplugin.py classes: sort code, move nickToUid, clientToServer, isInternalClient, isInternalServer into the Irc class 2015-12-31 17:28:47 -08:00
example-conf.yml Rename config.yml.example -> example-conf.yml 2016-01-03 20:02:23 -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: don't crash if plugin is missing 2016-01-03 21:05:45 -08:00
README.md README: mention ircmatch as a dependency 2016-01-03 21:06:24 -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)
  • 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 (experimental) - 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 isn’t finalized yet - this means that your configuration may break in an update!

  2. Run ./pylink from the command line.

  3. Profit???