3
0
mirror of https://github.com/jlu5/PyLink.git synced 2024-12-24 11:42:51 +01:00
PyLink/docs/technical
James Lu 945818e1d8 Refresh protocol module spec for 0.10 (#284)
Reword various things, and update links to source code references. Also, mention the following:

- conf_keys validation (#282)
- Topic acceptance rules (or rather, the lack thereof: #277)
2016-08-24 23:25:36 -07:00
..
channel-modes.csv channel-modes: fix definition for private (+p) 2016-06-19 21:14:10 -07:00
core-structure.dot docs/t: revamp core-structure pic 2016-04-10 21:51:12 -07:00
core-structure.png docs/t: revamp core-structure pic 2016-04-10 21:51:12 -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: update keys for SJOIN 2016-08-08 21:06:49 -07:00
pmodule-spec.md Refresh protocol module spec for 0.10 (#284) 2016-08-24 23:25:36 -07:00
protocol-modules.dot docs/t: add clientbot to protocol-modules 2016-08-09 00:07:27 -07:00
protocol-modules.png docs/t: add clientbot to protocol-modules 2016-08-09 00:07:27 -07:00
README.md docs/t: add Services API description 2016-07-23 20:56:51 -07:00
services-api.md docs/t: add Services API description 2016-07-23 20:56:51 -07:00
user-modes.csv docs/t: add usermodes list (#200) 2016-05-31 20:57:18 -07:00
writing-plugins.md docs/t/writing-plugins: mention main() and die() 2016-06-11 11:03:16 -07:00

PyLink Developer Documentation

Please note that as PyLink is still in its development phase, its APIs are subject to change. Any documentation here is provided for reference only.

The docs are also really incomplete (contributors welcome!)

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

Future topics (not yet available)