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
Created page with "{{Languages}} === Overview === * Create your own module.cpp file (you can look into the sample module for help) * #include <main.h> and <Modules.h> * Create a new class d..."
 
KindOne (talk | contribs)
73 edits
m Use https.
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Languages}}
{{Languages|Writing modules}}
=== Overview ===
=== C++ ===


* Create your own module.cpp file (you can look into the [[sample]] module for help)
* Look at ZNC API [https://docs.znc.in/ here] or directly in ZNC headers
* #include <main.h> and <Modules.h>
* 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)
* Create a new class derived from CModule overriding any [[Module Hooks]] that you need
* #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
* 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]])
* 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!'''


=== Code ===
=== Perl ===
 
Look at [[modperl]].
#include <main.h>
#include <Modules.h>
class CExampleMod : public CModule {
public:
    MODCONSTRUCTOR(CExampleMod) {}
    virtual ~CExampleMod() {}
    virtual void OnModCommand(const CString& sCommand) {
        if (sCommand.Token(0).CaseCmp("HELP") == 0) {
            PutModule("I'd like to help, but I am just an example module");
        } else {
            PutModule("Unknown command, try HELP");
        }
    }
};
MODULEDEFS(CExampleMod, "This is the description")
 
=== Output ===
 
<zncuser> test
<*example> Unknown command, try HELP
<zncuser> help
<*example> I'd like to help, but I am just an example module


=== Python ===
Look at [[modpython]].


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

Latest revision as of 00:28, 30 October 2023

Languages Languages: 

English

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.

Retrieved from "https://wiki.znc.in/index.php?title=Writing_modules&oldid=3028"