开发文档

开发版使用说明

由于当前项目进度缓慢，将来可能有越来越多人有开发需求，故暂时将包发布到了 Sonatype 快照仓库。如需在开发环境中使用 Overflow，添加以下仓库

repositories {
    maven("https://s01.oss.sonatype.org/content/repositories/snapshots")
}

快照仓库中依赖版本的格式为 ${miraiVersion}-${shortCommitHash}-SNAPSHOT，如 2.16.0-0abcdef-SNAPSHOT

你可以在 官网 或者 仓库 maven-metadata.xml 查询已发布的开发版本列表

在 mirai-console 中开发

此方法仅 Gradle 可用。

插件模板另请参见 overflow-console-plugin-template

此方法需要安装 mirai-console-gradle-plugin，即

plugins {
    id("net.mamoe.mirai-console") version "2.16.0"
}

在构建脚本 build.gradle(.kts) 中加入以下内容即可，其中，需要将 $VERSION 替换为 overflow 版本号

mirai {
    noTestCore = true
    setupConsoleTestRuntime {
        // 移除 mirai-core 依赖
        classpath = classpath.filter {
            !it.nameWithoutExtension.startsWith("mirai-core-jvm")
        }
    }
}
dependencies {
    // 若需要使用 Overflow 的接口，请取消注释下面这行
    // compileOnly("top.mrxiaom:overflow-core-api:$VERSION")
    
    testConsoleRuntime("top.mrxiaom:overflow-core:$VERSION")
}

在 mirai-core 中开发

将依赖 net.mamoe:mirai-core 替换为 top.mrxiaom:overflow-core 即可。

dependencies {
    implementation("top.mrxiaom:overflow-core:$VERSION")
}

<dependency>
    <groupId>top.mrxiaom</groupId>
    <artifactId>overflow-core</artifactId>
    <version>$VERSION</version>
    <scope>compile</scope>
</dependency>

连接到 Onebot

// 正向 WebSocket
val bot1 = BotBuilder.positive("ws://127.0.0.1:5800")
    .token("114514")
    .connect()
// 反向 WebSocket
val bot2 = BotBuilder.reversed(5700)
    .token("114514")
    .connect()
// connect() 返回值为 null 时登录失败

当前未编写多 Bot 支持，请勿在生产环境中连接多个实例。

向 Onebot 发送自定义 action

预设的 action 类型列表另请参见 ActionPathEnum.java (以下应当填写的是字符串 path 的值)

相关文档：

• go-cqhttp API
• Onebot API

val onebot = bot as RemoteBot
// 第一个参数 path 为请求 action 类型
// 第二个参数 params 为请求参数，是 JsonObject 格式字符串，可为空(null)
// 返回值是 JsonObject 字符串
val response = onebot.executeAction("get_forward_msg", "{\"id\":\"转发消息ID\"}")

手动刷新数据

// 目前 Bot, Group, Member 都实现了 Updatable
val updatable = group as Updatable
updatable.queryUpdate() // suspend
val remoteGroup = group as RemoteGroup
remoteGroup.updateGroupMemberList() // suspend

资源相关消息说明

正如用户手册所说，为减少运行内存占用，你可以使用以下方法来上传图片、语音、短视频来减少其造成的资源占用

val image = OverflowAPI.get().imageFromFile("https://xxxxx")
val audio = OverflowAPI.get().audioFromFile("https://xxxxx")
val video = OverflowAPI.get().videoFromFile("https://xxxxx")

// 其中的链接与 Onebot 的 file 参数相同，有三种格式
// 本地文件: file:///path/file
// 网络文件: http(s)://xxxx
// Base64: base64://b3ZlcmZsb3c=

为了兼容 mirai 已有的部分插件等可能已停止更新的业务逻辑，Overflow 添加了 FileService，使用示例另请参见 overflow-shamrock-ext