mirror of
https://github.com/jlu5/PyLink.git
synced 2024-11-24 11:39:25 +01:00
25 lines
839 B
Markdown
25 lines
839 B
Markdown
# 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.
|
|
|
|
<img src="core-structure.png" width="50%" height="50%">
|
|
|
|
## Contents
|
|
|
|
- [Writing plugins for PyLink](writing-plugins.md)
|
|
- [PyLink protocol module specification](pmodule-spec.md)
|
|
- [Using PyLink's utils module](using-utils.md)
|
|
|
|
### WIP topics
|
|
- [PyLink hooks reference](hooks-reference.md)
|
|
|
|
### Future topics (not yet available)
|
|
- [Writing tests for PyLink modules](writing-tests.md)
|