Awesome

QQRobot

✨ 基于 Mirai + mirai-api-http + NestJS 实现的一项 QQ 机器人项目✨

🌴 概述

基于Mirai对QQ各项事件监听与收发功能，支持自定义组合操作QQ能力，同时借助Mirai-Api-Http封装提供RESTful API，实现对其他语言的支持。

💥 功能介绍

• 多群消息转发互通，实现跨群聊天功能
• 接入天行API，通过检测关键字实现诸如获取 舔狗日记 、 彩虹屁（一段文字）等 功能
• 支持输入关键字实现群员投票踢人能力
• 支持关键字搜索音乐能力

现已迁移到mirai-api-http的2.x版本，1.x版本传送门

✨ 预览

🚀 开发手册

🐳 Docker 方式安装（ 强烈推荐！！！）

传送门： Docker 方式安装环境

如果采用手动方式，你会发现很麻烦。

🐌 手动方式安装

整体环境依赖于Mirai，故首先需要安装相关环境提供QQ托管能力。

安装 Mirai 环境

当前项目依赖 mirai-api-http 版本为 2.x

1. 安装Mirai Console Loader：相关安装地址。

建议优先尝试他的手动安装方式

这里笔者采用它提供的自动安装方式未成功，故采用的手动方式，如果自动安装不行，建议采用手动安装，手动安装的话会需要你安装一个大于11的JDK，这里建议采用开源版本的。

2. 使用Mirai Console Loader安装mirai-api-http插件。

在当前安装路径下启动终端并中执行以下命令

./mcl --update-package net.mamoe:mirai-api-http --channel stable --type plugin

重要 !!!

==========>

如果上面步骤2安装的mirai-api-http版本最终是1.x，那么这里你可以在当前目录下把plugins里内容都删掉，然后手动下载这个包mirai-api-http@2.x，放置到plugins目录下。

然后记得在终端里执行

./mcl --disable-script updater

这个是用来禁用mcl的自动更新的，因为目前观察来看每次启动会自动下载1.x版本，导致启动出现问题。

如果这个问题已经修复了就当我没说。。。。

==========>

执行完毕之后你可以通过执行./mcl命令直接启动，看mirai环境是否正常启动成功。

相关API地址：mirai-api-http API 文档

这里主要是因为笔者服务端采用Nodejs环境进行开发，故需要该插件提供RESTful接口与websocket连接与QQ通信。

音乐搜索功能插件安装

若需要开启音乐搜索能力，请按照音乐插件文档下载插件放置到plugins目录下。

redis & mysql

本项目需要依赖redis与mysql环境，故需要你安装并启动redis和mysql服务。

同时在下面提到的.env文件中添加数据库配置DATABASE_URL

启动

1. 启动MCL（上面安装的）。
2. 输入登录指令，将一个用于机器人的QQ号进行登录。

在上述步骤都完成之后，你需要安装的东西基本完毕了，可以启动本项目进行进一步服务端开发了。

克隆（下载）项目

git clone git@github.com:STDSuperman/QQRobot.git

项目启动

进入克隆后的项目，执行安装命令，安装完毕之后执行启动命令。

使用npm

npm i
npm run start

使用yarn

yarn
yarn start

🚴 项目配置

mirai-api-http全局配置：

1. 按照官方文档在Mirai Console Loader安装目录下找到相关配置文件：config/MiraiApiHttp(名字不一定叫这个，不过目录名一表示的含义是mirai-api-http的)/setting.yml (没有则自行创建)
2. 配置端口为9999（因为笔者项目指定的端口为这个，如果这里想自定义或者用系统默认的8080，则你需要将笔者项目 src/config/index.ts 文件中的BOT_SERVER_PORT改成你这里设置的端口）
3. 修改verifyKey，或不修改，同时复制这个verifyKey，后续在笔者项目src/config/index.ts中VERIFY_KEY指定为这个

这里的src/config/index.ts主要用于一些全局配置项，克隆项目后可以进行查看修改。

这样差不多笔者准备需要你配置的地方改好了，其他如果需要自己自主定义的就按照官方文档自行修改，相应的也可能需要修改config/index.ts中配置。

配置文件示例

笔者的文件目录为：config\net.mamoe.mirai-api-http\setting.yml

## 配置文件中的值，全为默认值

## 启用的 adapter, 内置有 http, ws, reverse-ws, webhook
adapters:
  - http
  - ws

## 是否开启认证流程, 若为 true 则建立连接时需要验证 verifyKey
## 建议公网连接时开启
enableVerify: true
verifyKey: 1234567890

## 开启一些调式信息
debug: false

## 是否开启单 session 模式, 若为 true，则自动创建 session 绑定 console 中登录的 bot
## 开启后，接口中任何 sessionKey 不需要传递参数
## 若 console 中有多个 bot 登录，则行为未定义
## 确保 console 中只有一个 bot 登陆时启用
singleMode: false

## 历史消息的缓存大小
## 同时，也是 http adapter 的消息队列容量
cacheSize: 4096

## adapter 的单独配置，键名与 adapters 项配置相同
adapterSettings:
  ## 详情看 http adapter 使用说明 配置
  http:
    host: localhost
    port: 9999
    cors: [*]
  
  ## 详情看 websocket adapter 使用说明 配置
  ws:
    host: localhost
    port: 9999
    reservedSyncId: -1

src/config/index.ts文件中包含的配置以及含义请打开该文件查看注释部分。

除了前面提到的需要修改src/config/index.ts配置之外，你需要在当前项目根目录下新建一个.env文件，用于配置一些私密数据，具体值如下：

TIAN_API_KEY=xxx
QQAccount=xxx
QQPassword=xxx
SERVER_HOST=xxx
DATABASE_URL=mysql://root:password@localhost:3306/QQROBOT

配置介绍：

项目中需要引入机器人的群，需要预先将机器人账号设为管理员，否则投票踢人功能会存在异常。