Overflow 溢出核心

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

project-tRNA 星标 mirai Onebot 11 论坛

这是什么

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

Overflow 是什么

它是 mirai 对于 Onebot 的转接器、适配器,桥接在 mirai 接口与 Onebot 实现中,使得用户可以在大部分标准 Onebot 实现上使用 mirai 插件 (或其它业务实现)。

Overflow 不是什么

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

这是免费的吗

是的,你可以免费使用 Overflow,同时,它开放了源代码,任何人都可以对其贡献代码。如需使用其源代码,请遵守 AGPL-v3 协议。

它还在更新吗

是的,本项目的主要维护者为 MrXiaoM。由于主要维护者的学业等原因,该项目更新频率将不稳定

支持 mirai-core 吗

是的,本项目支持 mirai-core 和 mirai-console 使用,只需要将 mirai-core-jvm 依赖替换为 overflow-core 即可,详见开发文档

它稳定吗

目前 Overflow 暂未正式发布,内部还有非常多 TODO 未完成,稳定性暂不确定,欢迎长期测试,你的反馈将帮助 Overflow 变得更好。

快速开始

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

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

Step 1. 下载

*开发版本仅保留30天

开发人员依赖:

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

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

Step 2. 部署

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

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

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

部署难度:
Gensokyo > LLOnebot ~ NapCatQQ

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

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