diff --git a/docs/README.md b/docs/README.md index ffb1db774..c7a5f6c66 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,6 +2,39 @@ 欢迎来到 mirai-console 开发文档! +## 目录 + +- **[准备工作](#准备工作)** +- **[启动 Console](#Run.md)** + +### 后端插件开发基础 + +- 插件 - [Plugin 模块](Plugins.md) +- 指令 - [Command 模块](Commands.md) +- 存储 - [PluginData 模块](PluginData.md) +- 权限 - [Permission 模块](Permissions.md) + +### 后端插件开发进阶 + +- 扩展 - [Extension 模块和扩展点](Extensions.md) +- 扩展 - [实现 PluginLoader](PluginLoader.md) +- 扩展 - [实现 PermissionService](PermissionService.md) + +### 实现前端 +- [FrontEnd](FrontEnd.md) + +[`Plugin`]: ../backend/mirai-console/src/main/kotlin/net/mamoe/mirai/console/plugin/Plugin.kt +[`Annotations`]: ../backend/mirai-console/src/main/kotlin/net/mamoe/mirai/console/util/Annotations.kt +[`PluginData`]: ../backend/mirai-console/src/main/kotlin/net/mamoe/mirai/console/data/PluginData.kt +[`JavaPluginScheduler`]: ../backend/mirai-console/src/main/kotlin/net/mamoe/mirai/console/plugin/jvm/JavaPluginScheduler.kt +[`JvmPlugin`]: ../backend/mirai-console/src/main/kotlin/net/mamoe/mirai/console/plugin/jvm/JvmPlugin.kt +[`PluginConfig`]: ../backend/mirai-console/src/main/kotlin/net/mamoe/mirai/console/data/PluginConfig.kt +[`PluginLoader`]: ../backend/mirai-console/src/main/kotlin/net/mamoe/mirai/console/plugin/PluginLoader.kt +[`ConsoleInput`]: ../backend/mirai-console/src/main/kotlin/net/mamoe/mirai/console/util/ConsoleInput.kt +[`PluginDataStorage`]: ../backend/mirai-console/src/main/kotlin/net/mamoe/mirai/console/data/PluginDataStorage.kt +[`BotManager`]: ../backend/mirai-console/src/main/kotlin/net/mamoe/mirai/console/util/BotManager.kt +[`Command`]: ../backend/mirai-console/src/main/kotlin/net/mamoe/mirai/console/command/Command.kt + ## 准备工作 ***如果跳过本节内容,你很可能遇到无法解决的问题。*** @@ -43,36 +76,6 @@ - 对于 Java 使用者,请阅读 [Java 用户的使用指南](#java-用户的使用指南),[在 Java 使用 Mirai Console 中的 Kotlin `suspend` 函数](#在-java-使用-mirai-console-中的-kotlin-suspend-函数) - 对于 Kotlin 使用者,请熟知 [Kotlin `1.4` 版本带来的新特性](#mirai-console-使用的-kotlin-14-版本的新特性) -## 目录 - -### 后端插件开发基础 - -- 插件 - [Plugin 模块](Plugins.md) -- 指令 - [Command 模块](Commands.md) -- 存储 - [PluginData 模块](PluginData.md) -- 权限 - [Permission 模块](Permissions.md) - -### 后端插件开发进阶 - -- 扩展 - [Extension 模块和扩展点](Extensions.md) -- 扩展 - [实现 PluginLoader](PluginLoader.md) -- 扩展 - [实现 PermissionService](PermissionService.md) - -### 实现前端 -- [FrontEnd](FrontEnd.md) - -[`Plugin`]: ../backend/mirai-console/src/main/kotlin/net/mamoe/mirai/console/plugin/Plugin.kt -[`Annotations`]: ../backend/mirai-console/src/main/kotlin/net/mamoe/mirai/console/util/Annotations.kt -[`PluginData`]: ../backend/mirai-console/src/main/kotlin/net/mamoe/mirai/console/data/PluginData.kt -[`JavaPluginScheduler`]: ../backend/mirai-console/src/main/kotlin/net/mamoe/mirai/console/plugin/jvm/JavaPluginScheduler.kt -[`JvmPlugin`]: ../backend/mirai-console/src/main/kotlin/net/mamoe/mirai/console/plugin/jvm/JvmPlugin.kt -[`PluginConfig`]: ../backend/mirai-console/src/main/kotlin/net/mamoe/mirai/console/data/PluginConfig.kt -[`PluginLoader`]: ../backend/mirai-console/src/main/kotlin/net/mamoe/mirai/console/plugin/PluginLoader.kt -[`ConsoleInput`]: ../backend/mirai-console/src/main/kotlin/net/mamoe/mirai/console/util/ConsoleInput.kt -[`PluginDataStorage`]: ../backend/mirai-console/src/main/kotlin/net/mamoe/mirai/console/data/PluginDataStorage.kt -[`BotManager`]: ../backend/mirai-console/src/main/kotlin/net/mamoe/mirai/console/util/BotManager.kt -[`Command`]: ../backend/mirai-console/src/main/kotlin/net/mamoe/mirai/console/command/Command.kt - ## 附录 @@ -164,4 +167,4 @@ Mirai Console 的版本号遵循 [语义化版本 2.0.0](https://semver.org/lang 在 `1.2.0` 上升为 `ERROR`(使用时会得到一个编译错误); 在 `1.3.0` 上升为 `HIDDEN`(使用者无法看到这些 API)。 -`HIDDEN` 的 API 仍然会保留在代码中并正常编译,以提供二进制兼容性,直到下一个主版本更新。 \ No newline at end of file +`HIDDEN` 的 API 仍然会保留在代码中并正常编译,以提供二进制兼容性,直到下一个主版本更新。 diff --git a/docs/Run.md b/docs/Run.md new file mode 100644 index 000000000..435f45900 --- /dev/null +++ b/docs/Run.md @@ -0,0 +1,29 @@ +# Mirai Console - Run + +Mirai Console 可以独立启动,也可以被嵌入到某个应用中。 + +## 使用第三方工具自动启动 + +## 独立启动 + +### 环境 +- JDK 11 + +### 准备文件 + +要启动 Mirai Console,你需要: +- mirai-core-qqandroid +- mirai-console 后端 +- mirai-console 任一前端 +- 相关依赖 + +只有 mirai-console 前端才有入口点 `main` 方法。目前只有一个 pure 前端可用。 + +### 启动 mirai-console-pure 前端 + +mirai 在版本发布时会同时发布打包依赖的 Shadow JAR,存放在 [mirai-repo]。 + +1. 在 [mirai-repo] 下载如下三个模块的最新版本文件: + - [] + +[mirai-repo]: https://github.com/project-mirai/mirai-repo/