基于 Endstone 插件框架开发的 Minecraft 服务器与 QQ 群双向消息互通及安全绑定工具。
- NapCat 或其他支持 OneBot V11 正向 WebSocket 协议的 QQ 机器人框架。
- 双向消息同步:实现游戏内聊天与 QQ 群聊天消息的双向转发。
- 远程命令执行:通过QQ群远程查看玩家状态、执行控制台命令
- 游戏事件广播:支持玩家加入、离开、聊天、死亡等事件的自动同步投递。
- 自定义屏蔽词过滤:支持自定义屏蔽词过滤,匹配到
custom_ban_words.txt中配置的敏感词会自动用*替换。 - 安全身份验证:提供强制 QQ 绑定机制与防抖验证码系统,防止恶意账号进入。
- 群成员监控自愈:自动检测绑定玩家的退群状态,并实时对其进行游戏权限降级保护。
运行以下命令一键安装或更新:
pip install --upgrade endstone-qqsync-plugin在 Releases 页面下载插件对应的 .whl 文件,将其放入 Endstone 服务器的 plugins 文件夹中。
首次启动服务器后,插件将在以下路径自动生成默认配置文件及自定义屏蔽词过滤规则:
- 主配置文件:
~/bedrock_server/plugins/qqsync_plugin/config.toml - 自定义屏蔽词库:
~/bedrock_server/plugins/qqsync_plugin/custom_ban_words.txt
可以在 custom_ban_words.txt 中按行写入自定义屏蔽词,双向转发的聊天消息中若包含这些词,将会被自动用星号 * 遮蔽过滤。
打开并修改 config.toml 配置文件:
# QQsync 群服互通插件配置文件
napcat_ws = "ws://127.0.0.1:3001" # NapCat WebSocket 服务器地址(正向WS)
access_token = "" # 访问令牌(可选,若无则保持空)
admins = ["2899659758"] # 管理员 QQ 号列表
enable_qq_to_game = true # QQ 消息转发到游戏
enable_game_to_qq = true # 游戏消息转发到 QQ
force_bind_qq = true # 强制 QQ 绑定(启用身份验证系统)
sync_group_card = true # 自动同步群昵称为玩家名
check_group_member = true # 启用退群检测功能
# 聊天刷屏检测配置
chat_count_limit = 20 # 1分钟内最多发送消息数(-1则不限制)
chat_ban_time = 300 # 刷屏后禁言时间(秒)
api_qq_enable = false # QQ 消息 API(默认关闭)
# 群发消息提示词自定义模板
msg_first_join = "[首次加入] 欢迎新玩家 {player} 首次进入服务器!" # 首次加入提示词(支持 {player})
msg_join = "[+] {player} 上线了 (第 {sessions} 次登录)" # 玩家上线提示词(支持 {player}、{sessions})
msg_quit = "[-] {player} 下线了 ({time})" # 玩家下线提示词(支持 {player}、{time}、{total_time})
# 群组配置表数组(支持配置多群,各群拥有独立的事件和指令开关)
[[groups]]
id = 712523104 # 目标 QQ 群号
name = "主群" # 群组名称映射(用于区分消息来源)
enable_chat = true # 是否开启该群聊天同步
enable_command = true # 是否开启该群指令响应
[[groups]]
id = 987654321 # 目标 QQ 群号(示例副群)
name = "二群" # 群组名称映射
enable_chat = true
enable_command = false # 可针对不同群配置独立的指令或聊天开关配置修改完成后,重启 Endstone 服务器。插件将自动完成旧版数据及配置自愈迁移、自动连接 NapCat,完成群服互联。
/help- 显示群服互通命令帮助信息/list- 查看当前游戏在线玩家列表/tps- 查看服务器 TPS 和 MSPT 性能指标/info- 查看系统及硬件负载信息/bind- 查看当前 QQ 绑定状态/verify <验证码>- 验证 QQ 绑定
/cmd <命令>- 执行后台服务器控制台命令(如:/cmd say 欢迎!)/bindqq <游戏名> <QQ>- 强制绑定玩家/check <玩家名|QQ>- 查询玩家详细绑定状态、时长统计与权限信息/unbindqq <玩家名|QQ>- 强行解除指定玩家的 QQ 绑定/ban <玩家名> [原因]- 封禁指定玩家并解除绑定/unban <玩家名>- 解封指定玩家/banlist- 查询当前封禁黑名单/tog_qq- 切换 QQ 消息到游戏的转发开关/tog_game- 切换游戏消息到 QQ 的转发开关/reload- 重新载入 TOML 配置文件
/bindqq- 未绑定的玩家可用于启动 QQ 绑定表单
当启用 force_bind_qq 时,未绑定 QQ 的玩家将受到严格 hometown/访客权限限制:
- 无法在游戏聊天中发言
- 无法破坏或放置方块
- 无法与任何方块和容器交互
- 无法拾取或丢弃任何物品
- 无法攻击生物、玩家或载具
- 仅允许移动和观察
当在 config.toml 中开启了 api_qq_enable = true 时,其他 Endstone 插件可以通过获取本插件实例,调用相关 API 向配置的指定或所有 QQ 群组投递消息。
# 获取 QQSync 插件实例
qqsync = self.server.plugin_manager.get_plugin("qqsync")
if qqsync:
# 场景 1:向所有配置并启用了的群组进行消息广播
success = qqsync.api_send_message("这里是发给所有群组的推送消息")
# 场景 2:向指定且已在配置中的群组投递消息(需传入群号整型 id)
target_group_id = 712523104
success_single = qqsync.api_send_message("这里是定向推送到指定群的消息", target_group_id)在 Docker Compose 中配置 Endstone 与 NapCat 同步互通的极简示例:
services:
endstone:
container_name: endstone-qqsync
image: ghcr.io/yuexps/endstone-qqsync-plugin:latest
init: true
restart: unless-stopped
ports:
- "19132:19132/udp"
volumes:
- ./bedrock_server:/app/endstone/bedrock_server:rw
stdin_open: true
tty: true
depends_on:
- napcat
networks:
- qqsync-net
napcat:
image: mlikiowa/napcat-docker:latest
container_name: napcat
restart: always
ports:
- "6099:6099" # 映射 WebUI 网页端口,用于扫码登录 QQ
environment:
- TZ=Asia/Shanghai
volumes:
- ./qq-data:/app/.config/QQ
- ./napcat-config:/app/napcat/config
networks:
- qqsync-net
networks:
qqsync-net:
driver: bridge在该部署模式下,请先登录 NapCat 并配置 正向 Websocket 服务器,建议端口默认3001。
- 无法加载插件:请确认您的服务器环境为 Python 3.11+ 且安装了 Endstone 0.9.4+。
- WebSocket 连接失败:检查 NapCat 服务端是否正常启动、WebSocket 地址端口是否被防火墙阻拦。
- 消息无法同步:检查
config.toml中的群号是否填写正确,并确保对应群下的enable_chat开关已打开。