Skip to content

CuteReimu/mirai-sdk-http

Repository files navigation

mirai-api-http的Go SDK

这是针对mirai-api-http编写的Go SDK。

相较于直接使用mirai-core和mirai-console而言,mirai-api-http的好处是,在你更新代码时,你无需进行重新登录。

开始

在使用本项目之前,你应该知道如何使用mirai进行登录,并安装mirai-api-http插件。

请多参阅mirai-api-http的文档

本项目使用ws接口,因此你需要修改mirai的配置文件config/net.mamoe.mirai-api-http/setting.yml,开启ws监听。

adapters:
  - ws
verifyKey: ABCDEFGHIJK
adapterSettings:
  ws:
    ## websocket server 监听的本地地址
    ## 一般为 localhost 即可, 如果多网卡等情况,自定设置
    host: localhost

    ## websocket server 监听的端口
    ## 与 http server 可以重复, 由于协议与路径不同, 不会产生冲突
    port: 8080

    ## 就填-1
    reservedSyncId: -1

引入项目:

go get -u github.com/CuteReimu/mirai-sdk-http

关于如何使用,可以参考examples文件夹下的例子

注意事项

所有ListenXXXXXX函数之间都不支持并发,你可以在启动机器人的情况下调用这些函数,但是不要同时在多个协程调用这些函数,否则会出现panic("don't call listen concurrently")(不过在一般情况下确实不会有这种奇怪的需求)

进度

目前已支持的功能有:

  • 消息链
    • 所有消息类型
    • 所有消息解析
    • 所有其它客户端同步消息解析
  • 事件
    • Bot自身事件
    • 好友事件
    • 群事件
    • 申请事件
    • 其它客户端事件
    • 命令事件
  • 请求
    • 获取插件信息
    • 缓存操作
    • 获取账号信息
    • 消息发送与撤回
    • 文件操作
    • 多媒体内容上传
    • 账号管理
    • 群管理
    • 群公告
    • 事件处理
    • Console命令
  • 其它
    • 连接与认证
    • 断线重连
    • MiraiCode解析

About

mirai-api-http的Go SDK

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages