ZNC Palaver 模块使用教程

ZNC Palaver 模块使用教程

znc-palaverZNC module for push notifications项目地址:https://gitcode.com/gh_mirrors/zn/znc-palaver

1. 项目的目录结构及介绍

ZNC Palaver 模块的 GitHub 仓库地址为：https://github.com/cocodelabs/znc-palaver。以下是该项目的目录结构及主要文件介绍：

znc-palaver/
├── LICENSE
├── README.md
├── palaver.cpp
└── palaver.h

• LICENSE: 项目许可证文件，采用 MIT 许可证。
• README.md: 项目说明文档，包含项目的基本介绍和使用方法。
• palaver.cpp: 项目的主要源代码文件，包含了模块的核心功能实现。
• palaver.h: 项目的头文件，定义了模块所需的数据结构和函数声明。

2. 项目的启动文件介绍

项目的启动文件是 palaver.cpp，它是 ZNC Palaver 模块的核心实现文件。以下是该文件的主要内容和功能介绍：

#define REQUIRESSL
#define ZNC_PALAVER_VERSION "1.2.2"
#include <algorithm>
#include <znc/Modules.h>
#include <znc/User.h>
#include <znc/IRCNetwork.h>
#include <znc/Client.h>
#include <znc/Chan.h>
#include <znc/FileUtils.h>
#include <znc/IRCSock.h>

#if defined VERSION_MAJOR && defined VERSION_MINOR && VERSION_MAJOR >= 1 && VERSION_MINOR >= 5
#define HAS_REGEX
#include <regex>
#endif

#if defined VERSION_MAJOR && defined VERSION_MINOR && VERSION_MAJOR >= 1 && VERSION_MINOR < 6
#error "Palaver ZNC Modules requires ZNC 1.6 or newer "
#endif

#if defined VERSION_MAJOR && defined VERSION_MINOR && VERSION_MAJOR >= 1 && VERSION_MINOR >= 7
#define HAS_CAP_NOTIFY
#endif

const char *kPLVCapability = "palaverapp.com";

• REQUIRESSL: 定义了 SSL 要求。
• ZNC_PALAVER_VERSION: 定义了模块的版本号。
• 包含了一系列 ZNC 的头文件，用于实现模块的功能。
• 版本检查和功能定义，确保模块在支持的 ZNC 版本上运行。
• kPLVCapability: 定义了模块的标识符。

3. 项目的配置文件介绍

ZNC Palaver 模块没有独立的配置文件，其配置主要通过 ZNC 的模块加载和命令行操作完成。以下是一些常用的配置和调试命令：

• 加载模块：

  /msg *status loadmod palaver
  

• 查看设备注册状态：

  /msg *palaver info
  

• 发送测试通知：

  /msg *palaver test
  

• 调试模式：

  znc --debug
  

通过这些命令，可以加载模块、查看设备注册状态、发送测试通知以及进行调试。

---

以上是 ZNC Palaver 模块的基本使用教程，希望对您有所帮助。

znc-palaverZNC module for push notifications项目地址:https://gitcode.com/gh_mirrors/zn/znc-palaver