Skip to content
This repository has been archived by the owner on Sep 12, 2021. It is now read-only.

Karlatemp/mirai-websocket-api

Repository files navigation

logo
title

Gitter Actions Status

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

这个项目的名字来源于

京都动画作品《境界的彼方》栗山未来(Kuriyama Mirai)

CRYPTON初音未来为代表的创作与活动(Magical Mirai)

图标以及形象由画师DazeCake绘制

mirai-websocket-api

Mirai WebSocket API (console) plugin

Mirai-WebSocket-Api 插件 提供WebSocket API供所有语言使用mirai

开始使用

  1. 请首先运行Mirai-console相关客户端生成plugins文件夹
  2. mirai-websocket-api生成的jar包文件放入plugins文件夹中
  3. 编辑config/MiraiWSApi/config.yml配置文件 (没有则自行创建)
  4. 再次启动Mirai-console相关客户端
  5. 记录日志中出现的 userpasswd

config.yml模板

## 该配置为全局配置,对所有Session有效

# 可选,默认值为0.0.0.0
host: '0.0.0.0'

# 可选,默认值为7247
port: 7247

# 可选, 鉴权系统使用的用户名
user: root

# 必须, 默认密码为 ROOT, 必须修改
passwd: ROOT

# 是否在广播信息时使用 pettyPrint
pettyPrint: false

replyCache:
  maximumSize: 2000
  expireTime: 2
  expireTimeUnit: HOURS

messageSourceCache:
  maximumSize: 2000
  expireTime: 2
  expireTimeUnit: HOURS

receiptCache:
  maximumSize: 2000
  expireTime: 2
  expireTimeUnit: HOURS

更新日志

点我查看

文档