跳至主要內容

用户手册


用户手册

Overflow 的用途是替换 mirai-core 协议实现,连接 Onebot 标准的实现使 mirai 在Bot协议寒冬中续命。

要运行或开发 Overflow,需要 Java 版本为 8 或以上。

另请参见:开发文档

快速开始-使用者

mirai-core 实现删除,替换为 overflow 即可。

安装操作视频

欢迎补充任何视频平台上的 Overflow 部署教程视频,提交格式为 视频简略标题 (视频平台/视频作者)

安装方法

注意: MCL 无法使用 sonatype snapshots 仓库获取包,故 MCL 安装方法全部不可用,详见 iTXTech/mirai-console-loader #192open in new window

按以上任意一种方法安装好后,请往下看进行进一步配置。

配置文件

另请参见 配置文件说明

Onebot 协议实现部署教程

首先部署一个 Onebot 协议实现,以下是相关教程

除此之外,你还可以到 Onebot 生态open in new window 中寻找更多的 Onebot 11 实现,Overflow 基本可以连接到它们。

额外配置:

  • 对于 非QQ平台 或者 无法获得账号凭证 的 Onebot 实现,请在 overflow.json 中开启 no_platform
  • Overflow 不支持 CQ 码,请在 Onebot 端使用数组格式 (array) (又称消息段格式) 消息。

如何确定 Onebot 实现是否可以取得账号凭证?
如果支持以下几个API,则说明该实现可以取得账号凭证

  • get_cookies
  • get_csrf_token
  • get_credentials

部署完成后,选择一种连接方式进行下一步操作。

连接

启动 Overflow 后会生成配置文件 overflow.json,编辑配置文件再次启动即可。

需要注意的是,OpenShamrock 不管是主动(正向) WebSocket 还是被动(反向) WebSocket 的接口信息配置,都需要重新启动QQ才能生效。

从下方选择任意一种连接方式,仅能选择一种

以下提到的 Onebot 端,均为 Onebot 协议实现,如 OpenShamrock。


正向 WebSocket

让 Overflow 去连接 Onebot 协议实现。

关键配置项:ws_host - 连接目标地址。

Onebot 端 获取如下信息:

  • 正向 WebSocket 端口 (也叫做主动 WebSocket 端口)
  • 在 Overflow 侧可以与其建立连接的IP地址,可以是内网、公网或者内网穿透等等,模拟器可能需要配置端口转发。

将以上信息以 ws://IP:端口 的格式填入 ws_host,如 ws://127.0.0.1:5700,再次启动即可。

反向 WebSocket

让 Onebot 协议实现去连接 Overflow。

设置此项以后,正向 WebSocket 的配置将会失效

关键配置项:reversed_ws_port - 反向服务器端口。

首先修改 reversed_ws_port[1, 65535] 区间的数 (端口号有效值),启动 Overflow,确保端口没有冲突,若有冲突请自行更改。

Overflow 侧 获取以下信息:

  • 反向服务器端口,即 reversed_ws_port 的值。
  • Onebot 端 可以与其建立连接的IP地址。

将以上信息以 ws://IP:端口 的格式写好备用,这个就叫做反向 WebSocket 地址了,如 ws://127.0.0.1:5800

Onebot 端 的设置中找到 反向 WebSocket 地址 的配置,有些实现中它也叫作 被动 WebSocket 地址,将上面获取到的地址填入即可。

反向 WebSocket 仅支持一个客户端连接,目前没有支持多客户端以及多 Bot 的打算。


WebSocket 各关闭码的详细意义另请参见 CloseFrame.javaopen in new window

项目进度相关说明

另请参见 Overflow 项目进度

若出现不支持的消息类型 ([overflow,unknown:type,{}]),将会在日志 logs/unknown_messages.log 输出其详细信息,可以此日志提交 Issues 或 Pull Requests 请求添加该消息类型支持。

JVM 参数

参数说明
-Doverflow.config=路径修改配置文件(overflow.json)的路径
-Doverflow.not-exit=true设置无法连接到 Onebot 时不结束进程
-Doverflow.timeout=超时时间设置主动发送 action 的请求超时时间(毫秒),默认为10000毫秒(10秒)
-Doverflow.timeout-process=超时时间设置处理事件的超时时间(毫秒),默认为200000毫秒(20秒)。这个超时时间为 Overflow 内部将 Onebot 事件转换为 mirai 事件的时间,与事件广播后被插件处理无关。