Discover
Plugins
Indexing Guide API Settings
HuHoBotPenguin

HuHoBotPenguin

HuHoBot Penguin 服务端模组，直连 QQ 官方机器人网关，实现 QQ 群与 Minecraft Java 版服务器的双向消息桥接。

8

Links

Report issues View source

Creators

HuHoBot
HuHoBotOwner
HuoHuas001
HuoHuas001Member
Shabby-666
Shabby-666Member

Details

Licensed AGPL-3.0
Published 3 months ago
Updated last month

HuHoBotPenguin

把 QQ 群机器人接入 Minecraft 服务器：游戏聊天与 QQ 群双向转发、白名单管理、在线查询、命令执行与敏感词审核。基于 qqpd-bot-java（HuHoBot fork，以 git submodule 引入）。

支持的平台

  • Spigot / Paper（api-version 1.18）：JDK 8，产物 HuHoBot-Penguin_Spigot-<版本>.jar
  • Nukkit（MOT）：JDK 17，产物 HuHoBot-Penguin_Nukkit-<版本>.jar
  • Allay（≥ 0.17.0）：JDK 21，产物 HuHoBot-Penguin_Allay-<版本>.jar
  • BungeeCord / Velocity（3.4）：JDK 17，产物 HuHoBot-Penguin_Proxy-<版本>.jar

功能特性

  • 游戏 ↔ QQ 群聊天双向转发，支持格式模板与转发前缀过滤（默认只转发以 # 开头的游戏消息）
  • QQ 群指令系统：查在线、发信息、白名单、管理员、认证等，可在配置中逐个开关
  • 白名单管理：映射到服务器原生命令（如 whitelist add/remove），代理平台可配置路由到子服
  • 敏感词审核：正则 + 本地词库 + 可选 OpenAI 兼容接口 AI 二审；接口不可用时自动回退为本地屏蔽
  • MOTD 服务器状态展示：内置查询或第三方 API，可选 Markdown / 图片输出
  • 自定义命令：占位符替换（{params}、{group}、{user}、{0}…），支持权限分级
  • 多群支持：每群独立的管理员名单、管理员判定方式与全量转发开关
  • 各平台打包为独立 fat jar（shadow），放进 plugins 目录即可用
  • 扫码绑定：启动时检测到 bot.app-id / bot.secret 任一为空，会自动在控制台输出二维码；手机 QQ 扫码授权后自动写回这两个字段并重新连接机器人（二维码过期会自动刷新）
  • 附属插件 API（AddonAPI）：第三方插件可通过 registerAddon() 注册扩展，通过 registerBotCommand() 注册自定义命令，所有命令自动同步到 QQ 指令面板
  • 附属插件查询：群内发送 /附属插件 可查看已安装的附属插件列表

快速开始

准备

  1. 到 q.qq.com 申请机器人；也可以先留空 bot.app-id / bot.secret，启动后直接扫码绑定（见下文「扫码绑定」）。
  2. 准备运行环境：Spigot 平台需要 JDK 8+，Nukkit / BungeeCord / Velocity 需要 17+，Allay 需要 21+。

构建

git clone --recurse-submodules git@github.com:HuHoBot/PenguinClient.git
cd PenguinClient
./gradlew build
  • 项目依赖 deps/qqpd-bot-java 子模块；克隆时若未使用 --recurse-submodules，运行 git submodule update --init --recursive。
  • 所有产物会收集到 build/gather-jar/。
  • 同时构建全部平台需要本机可用的 JDK 8 / 17 / 21（Gradle toolchain 可自动下载时无需手动安装）。
  • 运行 Gradle 本身请使用 JDK 17 / 21（Gradle 8.14.5 不支持 JDK 25 及更新版本，报错时可用 JAVA_HOME=/usr/lib/jvm/java-21-openjdk ./gradlew build 指定）。

也可以从 Releases 下载已构建的 jar。

安装

把对应平台的 jar 放入服务端插件目录（Spigot/Allay/Nukkit 为 plugins/，Velocity 为 plugins/，BungeeCord 也为 plugins/），重启服务器。

配置

首次启动后会在插件数据目录生成 config.yml。关键配置项：

  • bot：app-id / secret 为 QQ 机器人凭据；groups 为允许使用的群 OpenId 列表。
  • chat-format：双向转发格式模板；post-chat 总开关；start-with 指定只有以该前缀开头的游戏消息才会转发（转发时移除前缀，留空表示全部转发）。
  • player-events：配置进退服通知；always-forward 为 true 时忽略平台的隐藏、取消或登录状态判断，始终转发进退服事件。
  • whitelist：白名单原生命令模板，代理平台需改为可路由到子服的命令。
  • admin：管理员判定方式 qq（群主/群管理员）、config（手动名单）、both（任一满足），及手动名单 openids。
  • audit：OpenAI 兼容审核接口（base-url / api-key / model）。
  • custom-commands：自定义指令列表，permission: 0 供所有成员执行，更高等级需要管理员。
  • commands：各群指令的开关。
  • features：enable-auth 控制 QQ 头像认证；full-amount 控制是否默认全量转发；group-member-events 控制是否订阅群成员进退群与入群申请事件（默认关闭，修改后需重启服务器）。

Spigot 版另有 command-sender: Hybrid，用于同时收集命令发送者输出与服务端日志。

扫码绑定

首次启动时如果 bot.app-id 或 bot.secret 任一为空，插件不会直接放弃启动，而是进入扫码绑定：

  1. 控制台打印一张二维码（同时输出二维码链接，便于日志查看）；
  2. 手机 QQ 扫码并确认授权；
  3. 插件拿到 AppID / Secret 后自动写回 config.yml（保留其他配置与注释），并立即重新连接 QQ 机器人；
  4. 二维码过期会自动刷新，重新打印一张新的二维码。

终端二维码按深色背景渲染（亮色模块 + 深色背景）。若控制台是浅色主题导致无法识别，可复制日志中的「二维码链接」自行生成二维码。 扫码流程需要能访问 q.qq.com；连续创建绑定任务失败 5 次后会停止，重载插件即可重试。

QQ 群指令

在群内发送指令（无需 @机器人）。[] 表示可选参数，<> 表示必填参数：

  • 查信息 [OpenId] —— 查询自己的 OpenId / 群 OpenId；带参数且是管理员时查询他人认证状态
  • 查管理 <OpenId> —— 查询某人是否为本群管理员
  • 加管理 <OpenId> / 删管理 <OpenId> —— 管理本群管理员名单
  • 管理方式 [QQ|手动|双重] —— 查看或设置本群管理员判定方式
  • 添加白名单 <玩家名> / 删除白名单 <玩家名> / 查白名单 —— 白名单管理
  • 查在线 —— 查询服务器在线玩家
  • 在线服务器 —— 查询已连接的服务器
  • 发信息 <内容> —— 发送消息到游戏内
  • 执行命令 <命令> —— 以管理员身份执行服务器命令
  • 执行 <key> [参数] / 管理员执行 <key> [参数] —— 执行 custom-commands 中定义的自定义命令
  • 全量 —— 切换本群全量聊天转发
  • 认证 —— 查询自己的认证状态；认证 / 解除认证 <OpenId>（管理员）—— 管理他人认证状态
  • 附属插件 —— 查看已安装的附属插件列表

模块结构

  • common/Bot —— 平台无关核心：QQ 客户端、群消息分发、指令、审核与状态存储
  • server/AdapterCommon —— 服务端适配公共层（YAML 配置、调度与命令原语）
  • server/Spigot / server/Allay / server/Nukkit / server/Proxy —— 各平台入口与适配
  • deps/qqpd-bot-java —— QQ 机器人 SDK（git submodule，HuHoBot fork），源码直接参与编译

附属插件开发

第三方插件可以通过 AddonAPI 向 HuHoBotPenguin 注册扩展和自定义命令：

import cn.huohuas001.bot.addon.Addon
import cn.huohuas001.bot.QClient

// 1. 注册扩展
val addon = Addon("MyAddon", "1.0.0", "我的附属插件", "作者名")
QClient.registerCommand(addon, myCommandHandler)

// 2. 注册自定义命令（5 参数版本）
plugin.registerBotCommand("MyAddon", "mycmd", "执行我的命令", 0, true)

// 3. 查询已安装扩展
val addons = AddonManager.allAddons()

群管理接口与群事件

除聊天与指令外，适配器还暴露了 QQ 开放平台的群管理接口，并把群成员变更透传为平台事件。

群管理接口

所有平台适配器实例（HuHoBotSpigot / HuHoBotAllay / HuHoBotNukkit / HuHoBotBungee / HuHoBotVelocity）都实现了同一套方法，返回值使用 QQ SDK 数据类，机器人未启动或接口报错时返回 null / false：

val plugin: HuHoBotSpigot = ...

plugin.getGroupInfo(groupOpenId)                   // 获取群基本信息
plugin.getGroupBotState(groupOpenId)               // 获取机器人群内状态
plugin.getGroupMuteSetting(groupOpenId)            // 查询群禁言状态
plugin.muteGroupMember(groupOpenId, memberOpenId, 60)   // 禁言成员（秒）
plugin.unmuteGroupMember(groupOpenId, memberOpenId)     // 解除禁言
plugin.getGroupJoinRequestList(groupOpenId)        // 拉取入群申请
plugin.approveGroupJoinRequest(groupOpenId, memberOpenId, joinRequestId)  // 通过申请
plugin.declineGroupJoinRequest(groupOpenId, memberOpenId, joinRequestId, "拒绝理由", false)  // 拒绝申请
plugin.getGroupMembers(groupOpenId)                 // 群成员列表（QQ 内邀接入中）
plugin.getGroupMember(groupOpenId, memberOpenId)    // 群成员详情
plugin.batchRemoveGroupMembers(groupOpenId, memberOpenIds)      // 批量移除成员
plugin.getGroupMemberBlacklist(groupOpenId)         // 查询群黑名单
plugin.addGroupMemberBlacklist(groupOpenId, memberOpenIds)      // 加入黑名单
plugin.removeGroupMemberBlacklist(groupOpenId, memberOpenIds)   // 移出黑名单
plugin.getGroupJoinApprovalStrategies()             // 入群自动审批策略列表

完整的接口清单与参数说明见 cn.huohuas001.bot.QClient 与 cn.huohuas001.bot.HuHoBot 的注释。自动审批策略的创建、修改、删除、执行与白名单维护目前 SDK 尚未提供，因此未接入。

群成员事件

把 features.group-member-events 设为 true 并重启服务器后，插件会额外订阅 GROUP_MEMBER_EVENT（1 << 24）Intent，并触发以下平台事件：

事件 Spigot Allay Nukkit BungeeCord Velocity
群成员加入 OnBotGroupMemberAdd OnBotGroupMemberAdd OnBotGroupMemberAdd OnBotGroupMemberAdd OnBotGroupMemberAdd
群成员退出 OnBotGroupMemberRemove OnBotGroupMemberRemove OnBotGroupMemberRemove OnBotGroupMemberRemove OnBotGroupMemberRemove
入群申请 OnBotJoinRequest OnBotJoinRequest OnBotJoinRequest OnBotJoinRequest OnBotJoinRequest

事件通过 GroupMemberPack / JoinRequestPack 快照暴露数据，不直接暴露 SDK 可变对象；OnBotJoinRequest 附带 approve() / decline(reason, addToMemberBlacklist) 便捷审批方法。该 Intent 需要 QQ 机器人具备群管理相关权限，订阅失败会导致连接被拒，因此默认关闭；入群申请事件还要求机器人为群管理员。

开发与发布

  • Kotlin + Gradle（wrapper 已随仓库提供，版本 8.14.5）。
  • CI 见 .github/workflows/build.yml：push 到 main / dev 或发起 PR 触发构建；推送 v* 标签触发构建并创建 GitHub Release。