Modules
From Anope Wiki
Contents |
Modules allow you to extend Anope by adding your own functionaly. Modules have full access to all of Anope's internal data structures and functions, and can thus do virtually anything you want.
This section of the wiki contains instructions on finding, compiling, and using modules in the Usage section. Developers can get information on the basics of module programming in the Tutorials section. We also provide a number of QuickLists to give a quick, yet complete, overview of various facilities Anope provides for coders.
Usage
This section contains a number of pages dealing with the usage of modules. The first step in using modules is finding them. When you've found the modules you want to use, you have to compile them and finally, you have to load them into Anope. The following pages should help you with all parts of this process:
- Finding -- Information on where to find modules
- Compiling -- Information on compiling modules once you've found them
- Loading -- Information on loading compiled modules
Developing
Modules are developed in the C programming language. If you want to write modules, you should first be familiar with coding in C. If you are, we provide a few basic tutorials to help you get started with modules programming. When you've got the hang of it, you can refer to our quicklists to get information on various interfaces we provide to module authors.
Tutorials
We currently provide the following tutorials on developing modules:
- Basic -- A tutorial on the basics of module programming
- Help Basics -- A tutorial which demonstrates how to add simple help to your module
QuickLists
Quicklists provide a quick overview of some functionality we provide to module coders. A quicklist contains all functions involved in using the functionality, and a small example of them being used. The following quicklists are currently available:
- Callbacks -- Add time-based callbacks to your modules
- Complex Events -- Hook to outgoing messages
- Configuration -- Parse configuration directives from services.conf
- Internal Events -- Hook to various internal events
- Language Strings -- Translate your response strings
- Pseudoclients -- Introduce your own services pseudoclients
- Tokens -- Various non-destructive token functions
Next to these lists we also provide a Doxy with a complete reference of the Anope core.
Miscellaneous
Next to all pages above, there's a few pages that don't fit into any already named categories.
- Internal Event List -- A list containing the available Internal Events
- QA Checklist -- A checklist to check for module quality
