3
0
mirror of https://github.com/jlu5/PyLink.git synced 2026-04-30 12:48:08 +02:00
James Lu 0ccaac595b services-api: refresh + expand for 2.0 and the persistent channel rework
Closes #603.

Other changes:
- Move the "Removing services" section to earlier in the doc - it is important!
- Consistently use 'strings' instead of "strings" in example code
- Mention briefly how "spawn_service:" false affects plugins
- Mention the "dynamic" channel handling added in 2.0-alpha3
2018-07-02 00:35:31 -07:00
..

# PyLink Developer Documentation

This documentation is provided for reference only, and may not always be up to date as APIs change.
Patches are welcome if something looks wrong or *is* wrong. In such cases, consulting the source code is probably your best bet.

The docs are also really incomplete (contributions are appreciated!)

## 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

- [Writing plugins for PyLink](writing-plugins.md)
- [PyLink hooks reference](hooks-reference.md)
- [Services bot API/Creating your own service bots](services-api.md)
- [Permissions API Introduction](permissions-api.md)
- [Using `utils.IRCParser()`](using-ircparser.md)

----

- [PyLink protocol module specification](pmodule-spec.md)

----

- [Release Process for PyLink](release-process.md)

![Graph of protocol module inheritance tree](protocol-modules.svg)