# Mirai

欢迎来到 mirai 开发文档。

本文面向要进行开发的用户。对于只使用现成插件的用户,请阅读 用户手册

Mirai 生态概览

Mirai VuePress 文档 (opens new window)

# 社区 SDK

mirai 官方提供 Kotlin/Java 等 JVM 平台语言开发支持。如果不熟悉这些语言,请使用以下社区 SDK:

要使用这些社区 SDK 需要先配置 Mirai Console,可以使用 一键安装 (opens new window)(32位,带 HTTP 插件),也可以阅读 用户手册 进行个性化安装。

你可以使用一个或多个语言来开发插件,而且在自己开发的同时也可以使用下载的插件

# 原生接口

这些接口直接在 JVM 上实现,不需要中间件,拥有更佳的性能。

技术 维护者及项目地址
Kotlin Scripting iTXTech/mirai-kts (opens new window)
C++ Nambers/MiraiCP (opens new window)
JavaScript iTXTech/mirai-js (opens new window)
酷 Q DLL 插件 iTXTech/mirai-native (opens new window)

# HTTP 接口

目前有两个 HTTP 协议插件。使用 HTTP 协议插件可以支持更多编程语言和技术。

名称 实现 维护者及项目地址
Mirai Http Mirai 标准 mamoe/mirai-api-http (opens new window)
OneBot Http OneBot (opens new window) 标准 yyuueexxiinngg/onebot-kotlin (opens new window)

下表列举基于 Mirai HTTP 插件实现对一些编程语言支持的项目列表。要使用它们,你需要在 Mirai Console 安装 mirai-api-http (opens new window)(如果使用上面的一键安装则不需要额外操作)。

语言和技术 维护者及项目地址
C# Executor-Cheng/mirai-CSharp (opens new window)
C# Hyperai (opens new window)
C# Coloryr/ColorMirai (opens new window)
C# AhpxChina/Mirai.Net (opens new window)
C# Miyakowww/CocoaFramework2 (opens new window)
C++ cyanray/mirai-cpp (opens new window)
C++ Chlorie/miraipp (opens new window)
Go Logiase/gomirai (opens new window)
JavaScript / Node.js RedBeanN/node-mirai (opens new window)
JavaScript / Node.js drinkal/Mirai-js (opens new window)
JavaScript / TypeScript YunYouJun/mirai-ts (opens new window)
JavaScript / TypeScript nepsyn/miraipie (opens new window)
PHP nkxingxh/miraiez (opens new window)
Python Ariadne (opens new window)
Python Avilla (opens new window)
Python Elaina (opens new window)
Python NoneBot (opens new window)
Python jerrita/saaya (opens new window)
Python YiriMirai (opens new window)
Python Excaive/miraicle (opens new window)
Ruby Shimogawa/rubirai (opens new window)
Rust HoshinoTented/mirai-rs (opens new window)
易语言 only52607/e-mirai (opens new window)

按字母顺序排序,排序不代表排名
想在这里添加你的项目?欢迎提交 PR (opens new window)

特别地,有一些 SDK 直接基于 mirai-core 开发,不需要 mirai-console (opens new window)

# JVM 平台 Mirai 开发

本节介绍使用 Java、Kotlin 等 JVM 平台编程语言开发 Mirai 或 Mirai Console 插件。

为了避免遇到各种问题,请逐步仔细阅读。

  1. JVM 环境和开发准备工作

  2. 选择框架 建议先阅读 Mirai 生态概览

    • 若要将 mirai 当做依赖库嵌入你的应用使用(你调用 mirai),则需要使用 mirai-core,请阅读 配置项目依赖

    • 若要以插件模式开发(mirai 调用你),可以使用 mirai-console,请阅读 mirai-console 的配置插件项目

  3. 阅读 API 文档(见下文)

如果你希望先确认 mirai 能够正常运行才能安心阅读文档,可克隆 mirai-hello-world (opens new window) 并运行其中 Kotlin 或 Java 入口点 main

之后...

# mirai-core API 文档

请在 CoreAPI.md 阅读 JVM 平台的 mirai-core-api 使用文档。