mirror of
https://github.com/mamoe/mirai.git
synced 2025-02-26 20:20:14 +08:00
update docs
This commit is contained in:
jasonczc
parent
a2af1b3535
commit
16fc510fcd
29
README.md
29
README.md
@ -1,6 +1,7 @@
|
||||
<div align="center">
|
||||
<img width="160" src="http://img.mamoe.net/2020/02/16/a759783b42f72.png" alt="logo"></br>
|
||||
|
||||
|
||||
<img width="95" src="http://img.mamoe.net/2020/02/16/c4aece361224d.png" alt="title">
|
||||
|
||||
----
|
||||
@ -30,27 +31,37 @@ Mirai既可以作为你项目中的QQ协议支持Lib, 也可以作为单独的Ap
|
||||
|
||||
加入 Gitter, 或加入 QQ 群: 655057127
|
||||
|
||||
|
||||
|
||||
## 开始使用Mirai
|
||||
|
||||
Mirai支持以多种方式进行部署，但是目前，我们在集中对mirai-core，mirai-japt, mirai-api-http, mirai-console等核心模块进行特性的开发。
|
||||
|
||||
### 开发者
|
||||
|
||||
#### 以编写机器人逻辑为主
|
||||
|
||||
- 需了解 `Java` 或 `Kotlin`, 使用 [mirai-console](https://github.com/mamoe/mirai/tree/master/mirai-console) 直接进行插件逻辑编写并与其他插件开发者合作共享
|
||||
|
||||
- 假如你倾向其他语言开发，可以通过了解 [mirai-api-http](https://github.com/mamoe/mirai/tree/master/mirai-api-http) 进行接入，欢迎开发不同平台的mirai-sdk
|
||||
|
||||
|
||||
|
||||
#### 使用Mirai为第三方库
|
||||
|
||||
- 假如你倾向使用Kotlin及包管理工具，请参阅[Mirai Guide - Quick Start](/docs/guide_quick_start.md)
|
||||
- 假如你想要试用Kotlin，希望一份较详细的起步教程，请参阅[Mirai Guide - Getting Started](/docs/guide_getting_started.md)
|
||||
- 假如你倾向Java作为开发语言，请参阅[mirai-japt](/mirai-japt/README.md)
|
||||
- 假如你倾向其他语言开发，可以通过了解 [mirai-api-http](https://github.com/mamoe/mirai/tree/master/mirai-api-http) 进行接入，欢迎开发不同平台的mirai-sdk
|
||||
- 假如你倾向Java作为开发语言，请参阅[mirai-japt](https://github.com/mamoe/mirai-japt)
|
||||
- 此外，你还可以在 [Wiki](https://github.com/mamoe/mirai/wiki/Home) 中查看各类帮助，**如 API 示例**。
|
||||
|
||||
|
||||
|
||||
### 使用者
|
||||
|
||||
- [mirai-console](https://github.com/mamoe/mirai/tree/master/mirai-console) 支持插件, **全平台可运行(UI版, Unix版, Android版, Web版)** **本模块正在完善**
|
||||
|
||||
|
||||
|
||||
### 我是其他平台的使用者
|
||||
|
||||
#### 酷Q平台用户:
|
||||
@ -58,11 +69,15 @@ Mirai支持以多种方式进行部署，但是目前，我们在集中对mirai-
|
||||
- 酷Q的插件可以在 `Mirai` 中加载, 详见 [Mirai-Native](https://github.com/iTXTech/mirai-native)
|
||||
- 使用 `酷Q HTTPAPI` 的插件将可以在`mirai`中加载，`Mirai-CQ-Adapter` 正在计划中
|
||||
|
||||
|
||||
|
||||
## 更新日志
|
||||
|
||||
* 在 [Project](https://github.com/mamoe/mirai/projects/3) 查看已支持功能和计划
|
||||
* 在 [CHANGELOG](https://github.com/mamoe/mirai/blob/master/CHANGELOG.md) 查看版本更新记录 (仅发布的版本)
|
||||
|
||||
|
||||
|
||||
## 模块
|
||||
|
||||
### mirai-core
|
||||
@ -87,7 +102,10 @@ TIM PC （2.3.2 版本，2019 年 8 月）协议的实现
|
||||
- 群管功能：群员列表，禁言
|
||||
（目前不再更新此协议，请关注上文的安卓协议）
|
||||
|
||||
|
||||
|
||||
## 加入开发
|
||||
|
||||
### 基于mirai的项目-如其他语言的SDK, 功能的拓展(无排名)
|
||||
|
||||
- [mirai-native](https://github.com/iTXTech/mirai-native) 支持酷Q插件在mirai上运行
|
||||
@ -101,12 +119,15 @@ TIM PC （2.3.2 版本，2019 年 8 月）协议的实现
|
||||
|
||||
您的 `star` 是对我们最大的鼓励(点击项目右上角)
|
||||
|
||||
|
||||
|
||||
## 鸣谢
|
||||
|
||||
特别感谢 [JetBrains](https://www.jetbrains.com/?from=mirai) 为开源项目提供免费的 [IntelliJ IDEA](https://www.jetbrains.com/idea/?from=mirai) 等 IDE 的授权
|
||||
[<img src=".github/jetbrains-variant-3.png" width="200"/>](https://www.jetbrains.com/?from=mirai)
|
||||
|
||||
### 第三方类库(无排名)
|
||||
|
||||
- [kotlin-stdlib](https://github.com/JetBrains/kotlin)
|
||||
- [kotlinx-coroutines](https://github.com/Kotlin/kotlinx.coroutines)
|
||||
- [kotlinx-io](https://github.com/Kotlin/kotlinx-io)
|
||||
@ -123,6 +144,8 @@ TIM PC （2.3.2 版本，2019 年 8 月）协议的实现
|
||||
- [toml4j](https://github.com/mwanji/toml4j)
|
||||
- [snakeyaml](https://mvnrepository.com/artifact/org.yaml/snakeyaml)
|
||||
|
||||
|
||||
|
||||
## 许可证
|
||||
|
||||
协议原版权归属腾讯科技股份有限公司所有，本项目其他代码遵守：
|
||||
@ -148,4 +171,4 @@ TIM PC （2.3.2 版本，2019 年 8 月）协议的实现
|
||||
GNU Affero General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Affero General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
@ -1,8 +1,8 @@
|
||||
# Mirai Guide - Build For Mirai
|
||||
|
||||
由于Mirai项目在快速推进中，因此内容时有变动，本文档的最后更新日期为```2020-02-22```，对应版本```0.19.1```
|
||||
由于Mirai项目在快速推进中，因此内容时有变动，本文档的最后更新日期为```2020-02-29```，对应版本```0.23.0```
|
||||
|
||||
本页面采用Kotlin作为开发语言，**若你希望使用 Java 开发**, 请参阅: [mirai-japt](mirai-japt/README.md)
|
||||
本页面采用Kotlin作为开发语言，**若你希望使用 Java 开发**, 请参阅: [mirai-japt](https://github.com/mamoe/mirai-japt)
|
||||
|
||||
本页面是[Mirai Guide - Subscribe Events](/docs/guide_subscribe_events.md)的后续Guide
|
||||
|
||||
@ -155,7 +155,7 @@ repositories {
|
||||
}
|
||||
|
||||
dependencies {
|
||||
implementation 'net.mamoe:mirai-core-qqandroid-jvm:0.19.1'
|
||||
implementation 'net.mamoe:mirai-core-qqandroid-jvm:0.23.0'
|
||||
implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8"
|
||||
testCompile group: 'junit', name: 'junit', version: '4.12'
|
||||
}
|
||||
|
||||
@ -1,22 +1,17 @@
|
||||
# Mirai Guide - Getting Started
|
||||
|
||||
由于Mirai项目在快速推进中，因此内容时有变动，本文档的最后更新日期为```2020-02-20```，对应版本```0.17.0```
|
||||
由于Mirai项目在快速推进中，因此内容时有变动，本文档的最后更新日期为```2020-02-29```，对应版本```0.23.0```
|
||||
|
||||
假如仅仅使用Mirai，不需要对整个项目进行Clone，只需在项目内添加Gradle Dependency或使用即可。
|
||||
|
||||
下面介绍详细的入门步骤。
|
||||
|
||||
本页采用Kotlin作为开发语言，**若你希望使用 Java 开发**, 请参阅: [mirai-japt](mirai-japt/README.md)
|
||||
本页采用Kotlin作为开发语言，**若你希望使用 Java 开发**, 请参阅: [mirai-japt](https://github.com/mamoe/mirai-japt)
|
||||
|
||||
## Use Console
|
||||
|
||||
使用mirai-console，以插件形式对服务器功能进行管理，启动无需任何IDE。
|
||||
|
||||
**由于mirai-console还没有开发完成，暂时不提供入门**
|
||||
|
||||
## Use Loader
|
||||
|
||||
通过编写Kotlin程序启动mirai-core，并定义你的Mirai Bot行为。
|
||||
## 起步步骤
|
||||
通过编写Kotlin程序，以第三方库的形式调用```mirai-core```，并定义你的Mirai Bot行为。
|
||||
|
||||
假如已经对Gradle有一定了解，可跳过1，2
|
||||
|
||||
@ -59,7 +54,7 @@ JDK要求6以上
|
||||
|
||||
```groovy
|
||||
dependencies {
|
||||
implementation 'net.mamoe:mirai-core-qqandroid-jvm:0.17.0'//此处版本应替换为当前最新
|
||||
implementation 'net.mamoe:mirai-core-qqandroid-jvm:0.23.0'//此处版本应替换为当前最新
|
||||
implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8"
|
||||
testCompile group: 'junit', name: 'junit', version: '4.12'
|
||||
}
|
||||
@ -125,7 +120,7 @@ suspend fun main() {
|
||||
<dependency>
|
||||
<groupId>net.mamoe</groupId>
|
||||
<artifactId>mirai-core-qqandroid-jvm</artifactId>
|
||||
<version>0.17.0</version> <!-- 替换版本为最新版本 -->
|
||||
<version>0.23.0</version> <!-- 替换版本为最新版本 -->
|
||||
</dependency>
|
||||
</dependencies>
|
||||
```
|
||||
|
||||
@ -1,12 +1,12 @@
|
||||
# Mirai Guide - Quick Start
|
||||
|
||||
由于Mirai项目在快速推进中，因此内容时有变动，本文档的最后更新日期为```2020-02-20```，对应版本```0.17.0```
|
||||
由于Mirai项目在快速推进中，因此内容时有变动，本文档的最后更新日期为```2020-02-29```，对应版本```0.23.0```
|
||||
|
||||
本文适用于对kotlin较熟悉的开发者
|
||||
|
||||
**若你希望一份更为基础且详细的guide**, 请参阅: [mirai-guide-getting-started](guide_getting_started.md)
|
||||
|
||||
**若你希望使用 Java 开发**, 请参阅: [mirai-japt](/mirai-japt/README.md)
|
||||
**若你希望使用 Java 开发**, 请参阅: [mirai-japt](https://github.com/mamoe/mirai-japt)
|
||||
|
||||
## Build Requirements
|
||||
|
||||
@ -25,7 +25,7 @@
|
||||
|
||||
**mirai-core 为独立设计, 可以作为库内置于任意 Java(JVM)/Android 项目中使用.**
|
||||
|
||||
请将 `VERSION` 替换为最新的版本(如 `0.15.0`):
|
||||
请将 `VERSION` 替换为最新的版本(如 `0.23.0`):
|
||||
[](https://bintray.com/him188moe/mirai/mirai-core/)
|
||||
**Mirai 目前还处于实验性阶段, 我们无法保证任何稳定性, API 也可能会随时修改.**
|
||||
|
||||
@ -47,7 +47,7 @@ Kotlin 在 Maven 上只支持 JVM 平台.
|
||||
<dependency>
|
||||
<groupId>net.mamoe</groupId>
|
||||
<artifactId>mirai-core-qqandroid-jvm</artifactId>
|
||||
<version>0.15.1</version> <!-- 替换版本为最新版本 -->
|
||||
<version>0.23.0</version> <!-- 替换版本为最新版本 -->
|
||||
</dependency>
|
||||
</dependencies>
|
||||
```
|
||||
|
||||
@ -1,8 +1,8 @@
|
||||
# Mirai Guide - Subscribe Events
|
||||
|
||||
由于Mirai项目在快速推进中，因此内容时有变动，本文档的最后更新日期为```2020-02-21```，对应版本```0.17.0```
|
||||
由于Mirai项目在快速推进中，因此内容时有变动，本文档的最后更新日期为```2020-02-29```，对应版本```0.23.0```
|
||||
|
||||
本页面采用Kotlin作为开发语言，**若你希望使用 Java 开发**, 请参阅: [mirai-japt](mirai-japt/README.md)
|
||||
本页面采用Kotlin作为开发语言，**若你希望使用 Java 开发**, 请参阅: [mirai-japt](https://github.com/mamoe/mirai-japt)
|
||||
|
||||
本页面是[Mirai Guide - Getting Started](/docs/guide_getting_started.md)的后续Guide
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user