项目简介
1. 概述
Yunzai-Bot 是一款开源的 QQ 聊天机器人,最初主要面向原神(Genshin Impact)相关的QQ群,帮助用户查询游戏数据、记录抽卡情况和进行互动娱乐。随着版本的不断更新和社区的不断扩展,它已经具备了群聊管理、智能对话、娱乐互动等多种功能,适用于各种群组场景。该机器人采用 Node.js 开发,支持插件化扩展,用户可以根据自身需求灵活定制机器人行为。
2. 主要功能
群聊管理
自动欢迎新人、定时发布公告、关键词回复等功能,帮助群管理员更好地管理群聊。信息查询
通过对接米游社等第三方接口,支持查询原神角色详情、抽卡记录、体力数据等;同时也支持其他信息查询功能。娱乐互动
支持趣味对话、斗图、小游戏等互动功能,提升群聊活跃度,并能结合 ChatGPT 插件等提供智能对话体验。插件化扩展
采用模块化插件设计,内置了多个插件(如喵喵插件、图鉴插件等),用户可根据需要选择加载或自行开发新插件,实现功能的个性化定制。
3. 系统架构
Yunzai-Bot 的核心架构主要包括以下几个部分:
核心模块
负责处理 Bot 登录、消息接收与解析,并通过统一的命令调度机制将消息分发给对应的插件。配置系统
所有配置文件均存放于专用目录(例如config/config/qq.yaml
、bot.yaml
等),用户只需修改这些文件即可调整登录信息、命令设置、插件参数等。插件机制
插件分为单 JS 文件插件和大型扩展插件两大类,支持动态加载与热更新。开发者可以参考示例代码(如plugins/example
下的内容)快速编写并调试自己的插件。
4. 安装与部署
Yunzai-Bot 提供了多种安装方式,满足不同用户的需求:
本地部署
在 Windows、Linux 或 macOS 环境下,需提前安装 Node.js、Redis 和 Git。通过命令行克隆代码仓库(如 GitHub 或 Gitee 上的仓库),然后使用 pnpm/npm 安装依赖,运行node app
进行首次配置登录。Docker 部署
官方已提供精简版和扩展版 Docker 镜像。精简版仅包含机器人本体,而扩展版则集成了 ffmpeg、Python 环境等,方便加载语音、图像处理及 Python 插件。用户可通过 docker-compose 快速搭建。
5. 插件生态与定制开发
丰富的插件库
除了官方核心功能外,社区开发者贡献了大量插件,如喵喵插件、ChatGPT 插件、图鉴插件等,极大扩展了机器人的应用场景。二次开发与定制
Yunzai-Bot 完全开源,开发者可以根据自己的需求修改源码或编写新插件,官方文档和社区教程为开发提供了详尽的示例和支持。
6. 使用场景
游戏群聊
针对原神、崩坏等游戏群组,机器人可以实时查询游戏数据、记录抽卡信息、提供游戏攻略和角色分析,极大提升游戏群的互动性。群管理
通过指令禁言、违禁词、自助头衔等功能,协助群主高效管理各类QQ群。智能娱乐
结合 AI 对话插件(如 ChatGPT 插件),提供智能对话、趣味互动等娱乐功能,使群聊更加生动有趣。
7. 社区与支持
Yunzai-Bot 拥有一个活跃的开源社区,主要集中在 GitHub、Gitee 以及相关的QQ群中。用户和开发者不仅共享安装和使用经验,还通过文档、问题合集(例如 Yunzai.Chat 指南)不断完善产品。任何问题都可以通过社区渠道获得帮助和反馈。
8. 总结
Yunzai-Bot 以其开放、灵活且功能丰富的特性,在游戏群聊、企业群管理和娱乐互动等多个场景中展现出巨大优势。无论你是初学者还是开发高手,都可以通过简单的配置和插件扩展,打造出符合自己需求的专属智能聊天机器人。