2019-08-07 18:14:29 +08:00
|
|
|
# Mirai
|
2019-08-08 12:45:12 +08:00
|
|
|
|
2019-08-18 23:38:04 +08:00
|
|
|
一个以<b>TIM QQ协议</b>驱动的JAVA(+Kotlin) QQ机器人服务端核心
|
2019-08-18 23:19:04 +08:00
|
|
|
我们坚持免费与开源
|
|
|
|
|
|
2019-09-08 01:24:18 +08:00
|
|
|
项目处于快速开发阶段
|
2019-09-01 22:48:42 +08:00
|
|
|
协议来自网络上开源项目
|
|
|
|
|
一切开发旨在学习, 请勿用于非法用途
|
2019-08-08 12:45:12 +08:00
|
|
|
|
2019-09-01 01:57:14 +08:00
|
|
|
<br>
|
|
|
|
|
|
|
|
|
|
A JAVA(+Kotlin) powered open-source project under GPL license<br>
|
|
|
|
|
It use protocols from <i>TIM QQ</i>, that is, it won't be affected by the close of <i>Smart QQ</i><br>
|
|
|
|
|
The project is all for <b>learning proposes</b> and still in <b>developing stage</b><br>
|
|
|
|
|
|
2019-08-24 15:36:59 +08:00
|
|
|
### 代码结构
|
2019-09-01 22:48:42 +08:00
|
|
|
Network部分使用 Kotlin 完成(因为kt有对 unsigned byte 的支持).
|
2019-09-04 22:55:14 +08:00
|
|
|
与插件相关性强(或其他在二次开发中容易接触)的部分使用 Java 完成,
|
2019-09-01 01:56:40 +08:00
|
|
|
同时也会针对kotlin提供优化的方法调用. 例如对'+'操作符的重载: `String+BufferedImage+QQ.At+Face+URL+String+File` 将会被自动处理为String消息.
|
|
|
|
|
|
2019-09-08 01:24:18 +08:00
|
|
|
### 抢先体验
|
2019-09-08 01:25:23 +08:00
|
|
|
现在你可以使用 Mirai 内置的一些测试qq号体验 Mirai.
|
2019-09-08 01:24:18 +08:00
|
|
|
1. Clone
|
|
|
|
|
2. Import as Maven project
|
|
|
|
|
3. Run [MiraiMain](mirai-core/src/main/java/net/mamoe/mirai/MiraiMain.java#L7)
|
2019-09-08 01:25:23 +08:00
|
|
|
简略阅读源码便可测试接收和发送消息
|
2019-08-24 15:36:59 +08:00
|
|
|
|
|
|
|
|
### TODO
|
|
|
|
|
- [x] 事件(Event)模块
|
2019-09-08 01:24:18 +08:00
|
|
|
- [ ] 插件(Plugin)模块 **(Working on)**
|
2019-08-24 15:36:59 +08:00
|
|
|
- [x] Network - Touch
|
2019-09-08 01:32:18 +08:00
|
|
|
- [X] Network - Login
|
2019-09-01 22:48:42 +08:00
|
|
|
- [X] Network - Session
|
2019-09-07 19:57:32 +08:00
|
|
|
- [X] Network - Verification Code
|
2019-09-01 22:48:42 +08:00
|
|
|
- [X] Network - Message Receiving
|
|
|
|
|
- [X] Network - Message Sending
|
2019-09-08 01:24:18 +08:00
|
|
|
- [ ] Network - Events **(Working on)**
|
2019-09-01 22:48:42 +08:00
|
|
|
- [ ] Robot - Friend/group list
|
2019-09-04 23:33:09 +08:00
|
|
|
- [ ] Robot - Actions(joining group, adding friend, etc.)
|
2019-09-01 22:48:42 +08:00
|
|
|
- [ ] Message Section **(Working on)**
|
|
|
|
|
- [ ] Contact
|
2019-09-07 19:57:32 +08:00
|
|
|
- [ ] UI
|
2019-08-24 15:36:59 +08:00
|
|
|
|
2019-08-08 12:45:12 +08:00
|
|
|
<br>
|
|
|
|
|
|
2019-08-08 12:51:21 +08:00
|
|
|
## 使用方法
|
|
|
|
|
### 要求
|
2019-08-17 13:17:56 +08:00
|
|
|
- Java 11 或更高
|
2019-09-01 01:56:40 +08:00
|
|
|
- Kotlin 1.3 或更高
|
2019-08-08 12:51:21 +08:00
|
|
|
### 插件开发
|
2019-09-08 01:24:18 +08:00
|
|
|
``` text
|
2019-09-01 01:48:27 +08:00
|
|
|
to be continued
|
2019-08-08 12:51:21 +08:00
|
|
|
...
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
### Requirements
|
2019-08-17 13:16:15 +08:00
|
|
|
- Java 11 or higher
|
2019-09-01 01:56:40 +08:00
|
|
|
- Kotlin 1.3 or higher
|
|
|
|
|
### Plugin Development
|
2019-09-08 01:24:18 +08:00
|
|
|
``` text
|
2019-09-01 01:48:27 +08:00
|
|
|
to be continued
|
2019-08-08 12:51:21 +08:00
|
|
|
...
|
|
|
|
|
```
|
2019-08-08 12:45:12 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
