mirai/README.md
2019-09-08 01:24:18 +08:00

1.8 KiB

Mirai

一个以TIM QQ协议驱动的JAVA(+Kotlin) QQ机器人服务端核心
我们坚持免费与开源

项目处于快速开发阶段
协议来自网络上开源项目
一切开发旨在学习, 请勿用于非法用途


A JAVA(+Kotlin) powered open-source project under GPL license
It use protocols from TIM QQ, that is, it won't be affected by the close of Smart QQ
The project is all for learning proposes and still in developing stage

代码结构

Network部分使用 Kotlin 完成(因为kt有对 unsigned byte 的支持).
与插件相关性强(或其他在二次开发中容易接触)的部分使用 Java 完成,
同时也会针对kotlin提供优化的方法调用. 例如对'+'操作符的重载: String+BufferedImage+QQ.At+Face+URL+String+File 将会被自动处理为String消息.

抢先体验

现在你可以使用 Mirai 内置的一些测试qq号体验Mirai, 或登录自己的账号.

  1. Clone
  2. Import as Maven project
  3. Run MiraiMain 简略阅读源码便可体验接收和发送消息

TODO

  • 事件(Event)模块
  • 插件(Plugin)模块 (Working on)
  • Network - Touch
  • Network - Login
  • Network - Session
  • Network - Verification Code
  • Network - Message Receiving
  • Network - Message Sending
  • Network - Events (Working on)
  • Robot - Friend/group list
  • Robot - Actions(joining group, adding friend, etc.)
  • Message Section (Working on)
  • Contact
  • UI

使用方法

要求

  • Java 11 或更高
  • Kotlin 1.3 或更高

插件开发

    to be continued
    ...

Usage

Requirements

  • Java 11 or higher
  • Kotlin 1.3 or higher

Plugin Development

    to be continued
    ...