跳转到正文

快速开始

从零编写、编译并安装你的第一个 64 位 Windows 萌喵插件。

本节基于 SDK 自带的最小示例,演示如何导出生命周期函数、创建后台工作线程、记录运行日志以及监听好友/群聊消息与事件。

1. 环境准备

  • 64 位 Windows
  • 64 位 C/C++ 编译器(如 64 位 MinGW-w64 gcc 或 MSVC x64)
  • SDK 头文件:plugin-sdk/plugin.h

2. 最小示例插件

将以下代码保存为 example.c(对应 plugin-sdk/example/example.c):

example.c
#include <windows.h>
#include <stdio.h>

#include "plugin.h"

static const PluginInfo INFO = {
    SDK_VERSION,
    "example.mmiao.app",
    "Example Plugin",
    "1.0.0",
    "萌喵",
    "启动后每 10 秒写一条日志",
};

static HANDLE worker;
static HANDLE stop_event;

static DWORD WINAPI work(LPVOID unused) {
    (void)unused;
    int count = 0;
    char text[64];
    /* 等停止信号,超时 10 秒就写一条日志 */
    while (WaitForSingleObject(stop_event, 10000) == WAIT_TIMEOUT) {
        snprintf(text, sizeof text, "示例插件运行中,第 %d 次", ++count);
        write_log(text, LOG_INFO, "#22c55e");
    }
    return 0;
}

EXPORT const PluginInfo *plugin_info(void) {
    return &INFO;
}

EXPORT bool plugin_install(const Api *api) {
    api_init(api);
    stop_event = CreateEventW(NULL, TRUE, FALSE, NULL);
    if (!stop_event) {
        return false;
    }
    write_log("示例插件已安装", LOG_INFO, NULL);
    return true;
}

EXPORT bool plugin_switch(bool enabled) {
    if (enabled) {
        ResetEvent(stop_event);
        worker = CreateThread(NULL, 0, work, NULL, 0, NULL);
        if (!worker) {
            return false;
        }
        write_log("示例插件已启动", LOG_INFO, NULL);
    } else if (worker) {
        SetEvent(stop_event);
        WaitForSingleObject(worker, INFINITE);
        CloseHandle(worker);
        worker = NULL;
        write_log("示例插件已停止", LOG_INFO, NULL);
    }
    return true;
}

EXPORT void plugin_uninstall(void) {
    if (stop_event) {
        CloseHandle(stop_event);
        stop_event = NULL;
    }
}

EXPORT void on_friend_event(const FriendEvent *event) {
    const char *label;
    if (strcmp(event->event_type, FRIEND_EVENT_SELF_STATUS_CHANGED) == 0)
        label = "修改在线状态";
    else if (strcmp(event->event_type, FRIEND_EVENT_NICKNAME_CHANGED) == 0)
        label = "修改昵称";
    else if (strcmp(event->event_type, FRIEND_EVENT_REMARK_CHANGED) == 0)
        label = "修改好友备注";
    else if (strcmp(event->event_type, FRIEND_EVENT_DELETED) == 0)
        label = "好友关系已移除";
    else if (strcmp(event->event_type, FRIEND_EVENT_REQUEST) == 0)
        label = "好友申请";
    else
        return;

    char text[512];
    if (event->operator_nickname[0])
        snprintf(text, sizeof text, "[%s(%llu)]:%s", event->operator_nickname,
                 (unsigned long long)event->operator_user_id, label);
    else
        snprintf(text, sizeof text, "[%llu]:%s",
                 (unsigned long long)event->operator_user_id, label);
    write_log(text, LOG_INFO, NULL);
}

EXPORT void on_group_event(const GroupEvent *event) {
    char text[512];
    if (strcmp(event->event_type, GROUP_EVENT_MEMBER_DECREASED) == 0) {
        snprintf(text, sizeof text, "[群 %llu]:成员减少,主动人[%s(%llu)],被动人[%s(%llu)]",
                 (unsigned long long)event->group_id, event->operator_nickname,
                 (unsigned long long)event->operator_user_id, event->target_nickname,
                 (unsigned long long)event->target_user_id);
    } else if (strcmp(event->event_type, GROUP_EVENT_ADMIN_CHANGED) == 0) {
        if (event->target_user_id)
            snprintf(text, sizeof text, "[群 %llu]:成员[%s(%llu)]的管理员身份发生变化",
                     (unsigned long long)event->group_id, event->target_nickname,
                     (unsigned long long)event->target_user_id);
        else
            snprintf(text, sizeof text, "[群 %llu]:群成员的管理员身份发生变化",
                     (unsigned long long)event->group_id);
    } else {
        return;
    }
    write_log(text, LOG_INFO, NULL);
}

EXPORT void on_friend_message(const FriendMessage *message) {
    char text[512];
    if (message->nickname[0]) {
        snprintf(text, sizeof text, "[%s(%llu)]:%s", message->nickname,
                 (unsigned long long)message->user_id, message->message);
    } else {
        snprintf(text, sizeof text, "[%llu]:%s",
                 (unsigned long long)message->user_id, message->message);
    }
    write_log(text, LOG_INFO, NULL);
}

3. 编译与安装

在 example 目录中使用 64 位 MinGW 编译:

gcc -shared -O2 -I.. -o example.dll example.c

安装步骤:

  1. 将编译产物按插件 ID 重命名为 example.mmiao.app.dll。
  2. 放入 <程序目录>/plugins/ 目录。
  3. 在客户端插件页手动启用该插件,随后可在运行日志页看到绿色周期日志及事件记录。

实际插件应按需筛选要写入日志的业务字段,不要直接把包含网页凭据或红包凭据等敏感信息的原始消息完整写入日志。

本页目录