To create new wiki account, please join us on #znc at Libera.Chat and ask admins to create a wiki account for you. You can say thanks to spambots for this inconvenience.

Writing modules: Difference between revisions

From ZNC
Jump to navigation Jump to search
No edit summary
docs url
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Languages}}
{{Languages}}
=== Overview ===
=== C++ ===


* Look at ZNC API [http://people.znc.in/~psychon/znc/doc here] or directly in ZNC headers
* Look at ZNC API [http://docs.znc.in/ here] or directly in ZNC headers
* Create your own module.cpp file (you can look into the [[sample]] module's source for help)
* Create your own module.cpp file (you can look into the [[sample]] module's [https://github.com/znc/znc/blob/master/modules/sample.cpp source] for help. Of course, you can look to other existing [[:Category:Core Modules|modules]] too)
* #include <znc/main.h> and <znc/Modules.h>
* #include <znc/main.h> and <znc/Modules.h>
* Create a new class derived from CModule overriding any module hooks that you need
* Create a new class derived from CModule overriding any module hooks that you need
Line 9: Line 9:
* Compile your module into a shared object (.so file) (See [[Compiling modules]])
* Compile your module into a shared object (.so file) (See [[Compiling modules]])
* Place the .so file into your ~/.znc/modules directory !!!WARNING!!! '''if you overwrite a .so file while znc has it loaded, it can and probably will crash znc, ''/msg *status unloadmod foo'' first!'''
* Place the .so file into your ~/.znc/modules directory !!!WARNING!!! '''if you overwrite a .so file while znc has it loaded, it can and probably will crash znc, ''/msg *status unloadmod foo'' first!'''
=== Perl ===
Look at [[modperl]].
=== Python ===
Look at [[modpython]].


[[Category:Modules]]
[[Category:Modules]]

Revision as of 10:28, 21 April 2014

C++

  • Look at ZNC API here or directly in ZNC headers
  • Create your own module.cpp file (you can look into the sample module's source for help. Of course, you can look to other existing modules too)
  • #include <znc/main.h> and <znc/Modules.h>
  • Create a new class derived from CModule overriding any module hooks that you need
  • Be sure to add the macro call MODULEDEFS(CYourClass) at the END of the file
  • Compile your module into a shared object (.so file) (See Compiling modules)
  • Place the .so file into your ~/.znc/modules directory !!!WARNING!!! if you overwrite a .so file while znc has it loaded, it can and probably will crash znc, /msg *status unloadmod foo first!

Perl

Look at modperl.

Python

Look at modpython.