GitHub/PyLink
3
0
Fork 0
mirror of https://github.com/jlu5/PyLink.git synced 2024-11-24 03:29:28 +01:00
Code Issues Projects Releases Wiki Activity
fdcb58ba2c
PyLink/README.md
James Lu 6de30722b9 Revert "README: mark TS6 support as experimental" 
This reverts commit a5d71ffb56.

Then again, most of PyLink is experimental at this stage... :)
2015-07-25 11:08:04 -07:00

1.0 KiB
Raw Blame History

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 throughout your user base!

That said, please report any bugs you find to the issue tracker. Pull requests are open if you’d like to contribute.

Dependencies

Dependencies currently include:

  • Python 3.4+
  • PyYAML (pip install pyyaml or apt-get install python3-yaml)

Supported IRCds

  • InspIRCd 2.0.x - module: inspircd
  • charybdis (3.5.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 isn’t finalized yet - this means your configuration may break in an update!

  2. Run main.py from the command line.

  3. Profit???