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
3d0bf18001
PyLink/docs/technical
History
James Lu 3d0bf18001 protocols: rename topicClient -> topic; topicServer -> topicBurst 
This is one of the few commands that I won't consolidate at this time, because there is actually a difference in how most IRCds handle topic bursts and normal topic changes
2016-01-16 17:09:52 -08:00
..
autogen Move autogen docs to separate folder, add them for conf, classes, log, and world 2015-12-26 16:55:59 -08:00
core-structure.dot Update core-structure graph 2015-08-06 03:05:07 -07:00
core-structure.png Update core-structure graph 2015-08-06 03:05:07 -07:00
hooks-reference.md docs: update hooks-reference (#113) 2016-01-09 19:18:19 -08:00
plugin_example.py plugin_example.py: use irc.reply() 2015-12-26 15:02:23 -08:00
pmodule-spec.md protocols: rename topicClient -> topic; topicServer -> topicBurst 2016-01-16 17:09:52 -08:00
README.md docs: add part of hooks-reference, mention topics and modes in protocol module spec, some more changes 2015-12-26 16:44:22 -08:00
using-utils.md Move autogen docs to separate folder, add them for conf, classes, log, and world 2015-12-26 16:55:59 -08:00
writing-plugins.md protocols: rename joinClient(...) -> join(...) 2016-01-16 16:36:45 -08:00

README.md

PyLink Developer Documentation

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

It is also really incomplete (contributors welcome!)

Introduction

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

Contents

WIP topics

Future topics (not yet available)