GitHub/PyLink
3
0
Fork 0
mirror of https://github.com/jlu5/PyLink.git synced 2024-11-01 09:19:23 +01:00
Code Issues Projects Releases Wiki Activity
61cf48c37c
PyLink/docs/technical
History
James Lu 61cf48c37c pmodule-spec: various fixes 
- Corrected the location of the `self.irc.cmodes/umodes/prefixmodes` attributes
- Mention `self.conf_keys` as a special variable for completeness
2017-03-15 23:11:44 -07:00
..
channel-modes.csv docs/technical: fix capitalization of ircd-ratbox 2017-01-21 13:13:53 -08: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: document the 'was_successful' key in PYLINK_DISCONNECT 2017-02-24 22:27:51 -08:00
permissions-api.md docs/t: more notes regarding the permissions API 2017-02-24 18:31:26 -08:00
pmodule-spec.md pmodule-spec: various fixes 2017-03-15 23:11:44 -07:00
protocol-modules.dot docs/t: update protocol modules list 2016-10-01 13:42:48 -07:00
protocol-modules.png docs/t: update protocol modules list 2016-10-01 13:42:48 -07:00
README.md docs/t: link to using-ircparser.md in contents 2017-03-12 20:38:58 -07:00
release-process.md Document the PyLink release process 2016-09-16 22:01:10 -07:00
services-api.md Documentation tweaks 2017-03-13 13:50:16 -07:00
user-modes.csv docs/technical: fix capitalization of ircd-ratbox 2017-01-21 13:13:53 -08:00
using-ircparser.md using-ircparser.md: minor tweaks and reordering 2017-03-12 20:45:42 -07:00
writing-plugins.md writing-plugins.md: mention that IRCParser is a 1.2+ feature 2017-03-12 20:37:53 -07:00

README.md

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)