GitHub/PyLink
3
0
Fork 0
mirror of https://github.com/jlu5/PyLink.git synced 2024-11-23 11:09:22 +01:00
Code Issues Projects Releases Wiki Activity
master
PyLink/docs/technical
History
James Lu fc971aa679 pmodule-spec: Update notes about non-IRC protocols and PyLinkNetworkCoreWithUtils
2021-06-15 00:22:14 -07:00
..
doxygen.conf Doxygen configuration & autorun script 2016-07-23 19:42:17 -07:00
doxygen.sh Doxygen configuration & autorun script 2016-07-23 19:42:17 -07:00
hooks-reference.md Expose SSL/TLS state in UID hooks when available (#169) 2021-06-13 01:00:41 -07:00
permissions-api.md Update GitHub repository address 2018-07-08 12:54:10 -07:00
pmodule-spec.md pmodule-spec: Update notes about non-IRC protocols and PyLinkNetworkCoreWithUtils 2021-06-15 00:22:14 -07:00
protocol-modules.dot Convert protocol-modules graphic to a .svg 2017-11-12 12:07:08 -08:00
protocol-modules.svg Convert protocol-modules graphic to a .svg 2017-11-12 12:07:08 -08:00
README.md Convert protocol-modules graphic to a .svg 2017-11-12 12:07:08 -08:00
release-process.md Convert protocol-modules graphic to a .svg 2017-11-12 12:07:08 -08:00
services-api.md services-api: less awkward wording 2018-07-02 00:59:29 -07:00
using-ircparser.md using-ircparser.md: minor tweaks and reordering 2017-03-12 20:45:42 -07:00
writing-plugins.md writing-plugins: mention that editing hook payloads is allowed 2019-06-27 13:07:02 -07:00

README.md

PyLink Developer Documentation

This documentation is provided for reference only, and may not always be up to date as APIs change. Patches are welcome if something looks wrong or is wrong. In such cases, consulting the source code is probably your best bet.

The docs are also really incomplete (contributions are appreciated!)

Introduction

PyLink is an a modular, plugin-based IRC services framework. It uses swappable protocol modules and a hooks system for calling plugins, allowing them to function regardless of the IRCd used.

Contents

Graph of protocol module inheritance tree