Home

Awesome

<div align="center"> <img width="160" src="https://github.com/mamoe/mirai/blob/dev/docs/mirai.png" alt="logo"></br> <img width="95" src="https://github.com/mamoe/mirai/blob/dev/docs/mirai.svg" alt="title">

Gitter Actions Status

Mirai 是一个在全平台下运行，提供 QQ Android 和 TIM PC 协议支持的高效率机器人框架

这个项目的名字来源于 <p><a href = "http://www.kyotoanimation.co.jp/">京都动画</a>作品<a href = "https://zh.moegirl.org/zh-hans/%E5%A2%83%E7%95%8C%E7%9A%84%E5%BD%BC%E6%96%B9">《境界的彼方》</a>的<a href = "https://zh.moegirl.org/zh-hans/%E6%A0%97%E5%B1%B1%E6%9C%AA%E6%9D%A5">栗山未来(Kuriyama <b>Mirai</b>)</a></p> <p><a href = "https://www.crypton.co.jp/">CRYPTON</a>以<a href = "https://www.crypton.co.jp/miku_eng">初音未来</a>为代表的创作与活动<a href = "https://magicalmirai.com/2019/index_en.html">(Magical <b>Mirai</b>)</a></p> 图标以及形象由画师<a href = "https://github.com/dazecake">DazeCake</a>绘制

</div>

mirai-api-http

Mirai HTTP API (console) plugin

<b>mirai-api-http插件 提供HTTP API供所有语言使用mirai</b>

安装mirai-api-http

使用 Mirai Console Loader 安装mirai-api-http

./mcl --update-package net.mamoe:mirai-api-http --channel stable-v2 --type plugin

./mcl -u

开始使用

  1. 编辑config/net.mamoe.mirai-api-http/setting.yml配置文件 (没有则自行创建)
  2. 启动MCL ./mcl
  3. 如果手动安装则启动 mirai-console(不建议)
  4. 记录日志中出现的authKey

setting.yml模板

## 配置文件中的值，全为默认值

## 启用的 adapter, 内置有 http, ws, reverse-ws, webhook
adapters:
  - http
  - ws

## 是否开启认证流程, 若为 true 则建立连接时需要验证 verifyKey
## 建议公网连接时开启
enableVerify: true
verifyKey: 1234567890

## 开启一些调试信息
debug: false

## 是否开启单 session 模式, 若为 true，则自动创建 session 绑定 console 中登录的 bot
## 开启后，接口中任何 sessionKey 不需要传递参数
## 若 console 中有多个 bot 登录，则行为未定义
## 确保 console 中只有一个 bot 登录时启用
singleMode: false

## 历史消息的缓存大小
## 同时，也是 http adapter 的消息队列容量
cacheSize: 4096

## adapter 的单独配置，键名与 adapters 项配置相同
adapterSettings:
  ## 详情看 http adapter 使用说明 配置
  http:
    host: localhost
    port: 8080
    cors: ["*"]
    unreadQueueMaxSize: 100
  
  ## 详情看 websocket adapter 使用说明 配置
  ws:
    host: localhost
    port: 8080
    reservedSyncId: -1

Adapter

mirai-api-http 提供了多种接口调用方式, 并进行模块化称为 adapter

对于较常使用的调用方式, 内置了4种 adapter

adapter 可以多个同时开启, 请按需启用

Adapter 一览

迁移至 2.x

从 1.x 迁移至 2.x 有不少变动，提供迁移文档参考

可能无法覆盖所有变更

调试API

(2.x 未更新)

更新日志

点我查看

文档

在线文档