github-repos/mirai
1
0
Fork 0
mirror of https://github.com/mamoe/mirai.git synced 2024-12-29 10:00:13 +08:00
Code Issues Packages Projects Releases Wiki Activity
baf9ee4bf7
mirai/docs
History
米可绫夏 fe649726f3
[docs] 完善了用户文档部分的内容 (#2541) 
* 对 README 做了一丢丢改动

把用户和开发者部分的索引分开以便用户区分
调整了一点点细节

* 完善用户手册

补充了简单易懂的安装教程

* 规范 README 文档语法

* Apply suggestions from code review

Co-authored-by: Yurinann <1713574450@qq.com>
Co-authored-by: Him188 <Him188@mamoe.net>

* 规范了用户手册的文档内容

* 订正了一个空格错误

* 订正一个语法错误

* Update docs/UserManual.md

---------

Co-authored-by: Yurinann <1713574450@qq.com>
Co-authored-by: Him188 <Him188@mamoe.net>
2023-03-21 14:57:36 +00:00
..
.conf Mock Testing Framework (#1521) 2022-09-10 12:49:13 +08:00
.mirai_images Add docs 2020-05-11 16:05:41 +08:00
.UserManual_images Rewrite docs for beginners 2021-04-11 22:35:03 +08:00
contributing [mock] Add doc about disk allocation 2022-12-25 00:24:18 +08:00
files Add one-key installer for community SDKs 2021-04-12 00:33:03 +08:00
images [docs] Fix reference to images in docs/UsingSnapshots.md 2023-02-19 11:43:35 +00:00
mocking Update Mocking.md [skip-ci] 2022-10-03 10:19:56 +08:00
src Update docs: Contacts diagrams 2021-01-29 10:44:26 +08:00
Bots.md [core] Remove SwingSolver and SeleniumLoginSolver. Always use StandardCharImageLoginSolver on desktop JVM. Close #2410 2023-01-11 21:31:46 +00:00
ConciseAPI.md Update docs [no ci] 2021-12-11 18:20:57 +08:00
ConfiguringMultiplatformProjects.md [docs] Update docs for configuring projects. Helps #2275 2022-10-20 13:16:14 +01:00
ConfiguringProjects.md [docs] Update docs for configuring projects. Helps #2275 2022-10-20 13:16:14 +01:00
ConsoleTerminal.md typo: 群参数说明 (#2577) 2023-03-16 17:31:27 +08:00
Contacts.md Review docs and improve readability (#1291) 2021-06-02 20:29:36 +08:00
CoreAPI.md Create Concise API (#1326) 2021-06-18 04:46:11 +08:00
DebuggingNetwork.md [core] Improve NetworkHandler exception handling and optimize exception logging: 2022-08-26 15:20:04 +08:00
EventList.md 修改BotNudgedEvent为NudgeEvent (#2547) 2023-03-05 10:57:26 +00:00
Events.md update docs [skip ci] 2022-07-30 14:59:57 +08:00
Evolution.md Update docs 2021-01-13 16:07:02 +08:00
KotlinAndJava.md Update docs 2021-01-13 16:07:02 +08:00
Messages.md [core] feat: RockPaperScissors (#2220) 2023-01-03 10:00:32 +08:00
MigrationFrom1x.md Update docs 2021-03-21 11:36:09 +08:00
mirai-ecology.md Fix typo (#1912) 2022-03-07 22:56:41 +08:00
mirai.png 修改图标 2020-05-20 08:14:31 +08:00
mirai.svg 修改图标 2020-05-20 08:14:31 +08:00
Preparations.md update highlighted text (#2464) 2023-01-28 10:22:53 +00:00
README.md [docs] Rename miraiez to MiraiEz (#2479) 2023-02-09 11:59:24 +00:00
UserManual.md [docs] 完善了用户文档部分的内容 (#2541) 2023-03-21 14:57:36 +00:00
UsingSnapshots.md [docs] Fix reference to images in docs/UsingSnapshots.md 2023-02-19 11:43:35 +00:00

README.md

Mirai

欢迎来到 mirai 开发文档。

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

Mirai 生态概览

Mirai VuePress 文档

社区 SDK

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

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

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

原生接口

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

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

HTTP 接口

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

  • Mirai HTTP 由 Mirai 开发团队提供第一级支持，目前多数 SDK 都基于它；
  • OneBot 标准则兼容酷Q协议，可以让基于酷Q HTTP 插件的项目在 Mirai 平台运行。
名称 实现 维护者及项目地址
Mirai Http Mirai 标准 mamoe/mirai-api-http
OneBot Http OneBot 标准 yyuueexxiinngg/onebot-kotlin

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

语言和技术 维护者及项目地址
C# Executor-Cheng/mirai-CSharp
C# Hyperai
C# Coloryr/ColorMirai
C# AhpxChina/Mirai.Net
C# Cyl18/Chaldene
C# Miyakowww/CocoaFramework2
C++ cyanray/mirai-cpp
C++ Chlorie/miraipp
GDScript Xwdit/RainyBot-Core
Go Logiase/gomirai
JavaScript / Node.js RedBeanN/node-mirai
JavaScript / Node.js drinkal/Mirai-js
JavaScript / TypeScript YunYouJun/mirai-ts
JavaScript / TypeScript nepsyn/miraipie
Julia MiraiBots.jl
PHP MiraiEz
PHP MR-XieXuan/MiraiTravel
Python AliceBot
Python Ariadne
Python Avilla
Python easyMirai
Python Edoves
Python Elaina
Python NoneBot
Python jerrita/saaya
Python YiriMirai
Python Excaive/miraicle
Ruby Shimogawa/rubirai
Rust HoshinoTented/mirai-rs
易语言 only52607/e-mirai
易语言 Novices666/mirai-epl

按字母顺序排序，排序不代表排名
* 想在这里添加你的项目？欢迎提交 PR 。*

特别地，有一些 SDK 直接基于 mirai-core 开发，不需要 mirai-console：

使用 Mirai

Mirai 原生支持 Java、Kotlin 等 JVM 平台编程语言。

要使用 Mirai，可以使用 mirai-core 作为一个依赖库获得机器人功能，也可以为 mirai-console 开发插件。

生态详情可阅读：Mirai 生态概览。

JVM 平台 mirai-core 开发

本节介绍使用 Java、Kotlin 等 JVM 平台编程语言使用 mirai-core 作为一个依赖库获得机器人功能。 这通常适用于你在开发一个其他应用程序而需要使用机器人功能的情况。

  1. JVM 环境和开发准备工作
  2. 配置 mirai-core 项目依赖
  3. 阅读 mirai-core 文档

如果你希望先体验 mirai 的机器人功能，可克隆 mirai-hello-world 并在 IDE 内运行其中 Kotlin 或 Java 入口点 main。

JVM 平台 mirai-console 插件开发

本节介绍使用 Java、Kotlin 等 JVM 平台编程语言基于 mirai-core，开发可于 mirai-console 加载的插件来提供机器人功能。 这通常适用于你为了开发一个机器人程序的情况。开发 mirai-console 插件既可以单独使用，也可以使用来自社区的其他插件。

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

  2. 配置 mirai-console 插件项目

  3. 阅读 mirai-core 文档
    mirai-core 文档可让你了解如何使用 Bot 功能。

  4. 阅读 mirai-console 文档 mirai-console 文档可让你了解 mirai-console 的一些系统。

多平台 mirai-core 开发

本节介绍使用 Kotlin 使用 mirai-core 开发 Kotlin 多平台 应用程序。

  1. JVM 环境和开发准备工作
  2. 配置 mirai-core 多平台项目依赖
  3. 阅读 mirai-core 文档

发布项目

欢迎各类基于 mirai 开发的开源项目在论坛发布。

文档

mirai 在 GitHub 托管的文档可让你简要了解各个系统。

mirai 的源码内注释十分详细，包含各种实践示例。

mirai-core 文档

请在 CoreAPI.md 阅读 JVM 平台的 mirai-core 开发文档。

mirai-core API KDoc

可在 https://kdoc.mirai.mamoe.net/ 查看基于源码内注释生成的 KDoc（类似 JavaDoc）。 但更建议使用 IntelliJ IDEA 等 IDE 在开发时查询源码内注释。

mirai-console 文档

请在 mirai-console/docs 阅读 mirai-console 开发文档。