2015-12-26 16:44:22 -08:00
# PyLink Developer Documentation
2015-08-05 23:31:53 -07:00
2016-05-11 21:31:11 -07:00
Please note that as PyLink is still in its development phase, its APIs are subject to change.
2015-08-05 23:31:53 -07:00
Any documentation here is provided for reference only.
2016-05-11 21:31:11 -07:00
The docs are also really incomplete (contributors welcome!)
2015-09-06 23:11:31 -07:00
2015-12-26 16:44:22 -08:00
## Introduction
2015-08-05 23:31:53 -07:00
2016-05-11 21:31:11 -07:00
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.
2015-08-05 23:31:53 -07:00
2016-07-12 00:29:14 -07:00
< img src = "core-structure.png" width = "50%" height = "50%" > < img src = "protocol-modules.png" width = "50%" height = "50%" >
2015-08-05 23:31:53 -07:00
2015-12-26 16:44:22 -08:00
## Contents
2015-08-05 23:31:53 -07:00
2015-08-09 14:36:46 +08:00
- [Writing plugins for PyLink ](writing-plugins.md )
2015-09-06 23:11:31 -07:00
- [PyLink hooks reference ](hooks-reference.md )
2016-12-25 11:17:10 -08:00
- [Services bot API/Creating your own service bots ](services-api.md )
- [Permissions API Introduction ](permissions-api.md )
2017-03-12 20:38:58 -07:00
- [Using `utils.IRCParser()` ](using-ircparser.md )
2016-12-25 11:17:10 -08:00
----
- [PyLink protocol module specification ](pmodule-spec.md )
2016-05-11 21:31:11 -07:00
- [Supported named channel modes ](channel-modes.csv )
2016-05-31 20:56:08 -07:00
- [Supported named user modes ](user-modes.csv )
2016-12-25 11:17:10 -08:00
----
2016-09-16 22:01:10 -07:00
- [Release Process for PyLink ](release-process.md )
2015-12-26 16:44:22 -08:00
### Future topics (not yet available)
2015-08-09 14:36:46 +08:00
- [Writing tests for PyLink modules ](writing-tests.md )
2016-07-23 20:56:22 -07:00
