Overflow 溢出核心

猫猫式 mirai 实现于 Onebot 11
让 mirai 框架加入 Onebot 大家庭!

project-tRNA 星标 mirai Onebot 11 论坛

这是什么

Overflow 是 mirai-core-api 的实现,该项目因腾讯官方持续更新签名算法打击机器人社区而产生,产生目的是扩展 mirai 的可用范围。 当实在没有人更新 mirai-core 的协议实现与签名服务时,可使用本项目将 mirai 接口嫁接到 Onebot 实现上,以实现快速迁移的目的,而无需修改原有业务代码。

Overflow 是什么

这是 mirai 上的 Onebot 转接器、适配器,Overflow 扮演的角色是 Onebot 的客户端,以及 mirai-core-api 接口的实现。它桥接在 mirai 接口与 Onebot 实现之间,使得用户可以在大部分标准 Onebot 11 实现上使用 mirai 插件 (或其它业务实现)。

Overflow 不是什么

不是即装即用的协议实现,用户至少需要部署一个 Onebot 11 实现,使 Overflow 连接到该协议实现才能够正常工作。本项目的开发参考了 Onebot 11 规范,没有对即时通信软件QQ进行过逆向分析。

这是免费的吗

是的,你可以免费使用 Overflow 来满足任何你对聊天机器人的幻想。顺带一提,Overflow 以 AGPL-v3 协议开放了源代码,在遵守开源许可证的前提下,任何人都可以使用或者贡献代码。

还在更新吗

是的,我们会尽可能持续保持更新。在开源仓库提交条目到达一定数量的情况下,大约会每月发布一个正式版本。本项目的主要维护者为 MrXiaoM,出于主要维护者的学业、工作等原因,以及目前项目已趋于稳定,大约不会有多少重大更新。

支持 mirai-core 吗

是的,本项目支持 mirai-core 和 mirai-console 使用,只需要将 mirai-core-jvm 依赖替换为 overflow-core,并修改登录流程即可。详见开发文档中的示例。

这稳定吗

Overflow 在 2023 年末完成第一个开发版本,在 2024 年下旬正式发布。尽管目前仍有部分接口未完整实现,但基础功能已经较为稳定,常用的收发消息需求基本没有问题。欢迎长期测试,你的反馈将帮助 Overflow 变得更好。

快速开始

在这里打包下载 Overflow + mirai-console 整合包,并进行部署。

如果需要自动更新功能,请使用 MCL-patch1-with-overflow

Step 1. 下载

*开发版本仅保留90天

开发人员依赖:

top.mrxiaom.mirai:overflow-core-api:$VERSION

对于更老的开发版本,请到这里下载

不支持大部分移动端浏览器,请使用桌面端 Chrome、Edge、FireFox 等浏览器下载。你也可以使用此方法手动下载。

Step 2. 部署

下载后解压至少启动一遍,以生成配置文件。

打开配置文件 overflow.json 以备用。

从下方选择任意一个 Onebot 实现并部署,详细教程请见链接内相关文档。

部署难度:
Gensokyo > LLOnebot ~ NapCatQQ > AstralGocq

Onebot 实现部署完成后,取得其 正向 WebSocket 地址反向 WebSocket 地址,任选其一填入配置文件中,再次启动即可。

  • ws_host 正向 WebSocket 地址。
  • reversed_ws_port 反向 WebSocket 端口。
  • token 鉴权令牌,留空即不验证令牌。
用户手册 部署教程