mirai/docs/guide_quick_start.md
2020-03-01 12:08:35 +08:00

2.5 KiB

Mirai Guide - Quick Start

由于 mirai 项目在快速推进中,因此内容时有变动,本文档的最后更新日期为2020/3/1,对应版本0.23.0

本文适用于对 Kotlin 较熟悉的开发者,
使用 mirai 作为第三方依赖库引用任意一个 Kotlin, Java 或其他 JVM 平台的项目

若你希望一份更基础的教程, 请参阅: mirai-guide-getting-started

若你希望使用 Java 开发, 请参阅: mirai-japt

构建需求

  • Kotlin 1.3.61 (必须)
  • JDK 6 或更高 (必须)
  • Android SDK 29 (可选, 用于编译安卓目标)

获取 Demo

可在 mirai-demos 中获取已经配置好依赖的示例项目.

Quick Start

请将 VERSION 替换为 mirai-core 的最新版本号(如 0.23.0): Download

添加依赖

Maven

Kotlin 在 Maven 上只支持 JVM 平台.

<repositories>
    <repository>
        <id>jcenter</id>
        <url>https://jcenter.bintray.com/</url>
    </repository>
</repositories>
<dependencies>
    <dependency>
        <groupId>net.mamoe</groupId>
        <artifactId>mirai-core-qqandroid-jvm</artifactId>
        <version>0.23.0</version> <!-- 替换版本为最新版本 -->
    </dependency>
</dependencies>

Gradle

Mirai 只发布在 jcenter, 因此请确保添加 jcenter() 仓库:

repositories{
  jcenter()
}

注意: Mirai 核心由 API 模块(mirai-core)和协议模块组成。
只添加 API 模块将无法正常工作。
现在只推荐使用 QQAndroid 协议,请参照下文选择对应目标平台的依赖添加。

jvm (JVM 平台源集)

implementation("net.mamoe:mirai-core-qqandroid-jvm:VERSION")

common (Kotlin 多平台项目的通用源集)

implementation("net.mamoe:mirai-core-qqandroid-common:VERSION")

android (Android 平台源集)

implementation("net.mamoe:mirai-core-qqandroid-android:VERSION")

开始使用

val bot = Bot(qqId, password).alsoLogin()
bot.subscribeMessages {
  "你好" reply "你好!"
  contains("图片"){ File("C:\\image.png").sendAsImage() }
}
bot.subscribeAlways<MemberPermissionChangedEvent> {
  if (it.kind == BECOME_OPERATOR)
    reply("${it.member.id} 成为了管理员")
}