3
0
mirror of https://github.com/jlu5/PyLink.git synced 2024-12-25 12:12:53 +01:00
PyLink/docs/technical
James Lu 0ccaac595b services-api: refresh + expand for 2.0 and the persistent channel rework
Closes #603.

Other changes:
- Move the "Removing services" section to earlier in the doc - it is important!
- Consistently use 'strings' instead of "strings" in example code
- Mention briefly how "spawn_service:" false affects plugins
- Mention the "dynamic" channel handling added in 2.0-alpha3
2018-07-02 00:35:31 -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 hooks-reference: bump to 2.0-alpha2 2018-01-13 18:23:12 -08:00
permissions-api.md permissions-api: fix markdown syntax [skip ci] 2017-09-08 19:02:51 -07:00
pmodule-spec.md pmodule-spec: document protocol capabilities 2018-06-26 22:47:39 -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: refresh + expand for 2.0 and the persistent channel rework 2018-07-02 00:35:31 -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: briefly mention log, world, irc.connected, and useful builtin modules 2018-06-26 21:58:17 -07:00

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