This folder contains all documentation for nrelay.
The contents of the docs folder mirrors that of the src folder. For example, the Client class is in src/core/client, so the docs will be at docs/core/client.
The plugin recipes folder contains tutorials on how to create a variety of plugins. Use these docs if you are looking for ideas for plugins, or want to learn more about how to create functional plugins.
This is a guide which provides a tutorial on how to write a basic plugin, including some of the services which are available to plugins.
Use this document to learn about the process of creating plugins which utilize available features.
This document includes documentation for all packets which are currently implemented. The documentation includes all members which are available in the packets as well as a description of what the members are. Some of the member descriptions may not be accurate. If an inacuracy is suspected, there will usually be a note outlining several possibilities of what the member actually is. If you notice an incorrect member description, please open an issue outlining which description is incorrect and what the correct description is.
Use this document to learn about what members are available for packets of interest.
This document gives an overview of all plugin components which are available for other plugins to use.