Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
lz1998 committed Oct 2, 2020
1 parent a978f91 commit 9826255
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 8 deletions.
29 changes: 21 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,27 @@
# Spring-Mirai-Client
可通过HTTP请求创建Mirai QQ机器人,处理登陆验证码、URL等信息

本项目(client端)使用 Kotlin 编写(因为 Mirai 是 kotlin 的)
用于收发QQ消息,并通过 websocket + protobuf 上报给 server 进行处理。

server 端:可使用任意语言编写
本项目对应前端:https://github.com/protobufbot/spring-mirai-client-ui

通信协议:https://github.com/lz1998/onebot/tree/master/v11/specs/idl
server端可以使用任意语言编写,通信协议:https://github.com/lz1998/onebot_idl

## TODO
- 整合 onebot 协议,与远程服务器通过 http/websocket/rpc 方式进行通信
- 群/私聊 消息事件 -> protobuf/json
- 接受API调用,执行并返回结果
Java/Kotlin用户推荐使用 [spring-boot-starter](https://github.com/protobufbot/pbbot-spring-boot-starter)

支持发送的消息:文字、表情、图片、闪照、atQQ、atAll

## 使用说明

下载release:https://github.com/ProtobufBot/Spring-Mirai-Client/releases

解压后运行
```bash
java -jar spring-mirai-client-版本.jar
```

浏览器打开 http://localhost:9000/

创建机器人并处理下方验证码(图形验证码或设备锁)


![截图](https://github.com/lz1998/Spring-Mirai-Client/blob/master/screenshot/client.jpg?raw=true)
Binary file added screenshot/client.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 9826255

Please sign in to comment.