3
0
mirror of https://github.com/jlu5/PyLink.git synced 2026-04-26 02:37:59 +02:00
James Lu a03214514c hybrid, ts6, ratbox: fix +p mode definitions properly
+p is noknock and rfc1459-style private on all 3 IRCds, though the latter bit is undocumented in /help cmodes (maybe it's assumed?)
+p is also "paranoia" on hybrid, which adds more restrictions to halfops and /invite

(cherry picked from commit c107f0062ffb25a54d52946a26725940865318bb)
2017-08-31 15:06:25 -07:00
..
2017-03-15 23:11:44 -07:00
2017-03-13 13:50:16 -07:00

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

<img src="core-structure.png" width="50%" height="50%"> <img src="protocol-modules.png" width="50%" height="50%">

## 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)
- [Supported named channel modes](channel-modes.csv)
- [Supported named user modes](user-modes.csv)

----

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

### Future topics (not yet available)
- [Writing tests for PyLink modules](writing-tests.md)