Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Sign in / Register
Toggle navigation
M
Mirai
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Locked Files
Issues
0
Issues
0
List
Boards
Labels
Service Desk
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Security & Compliance
Security & Compliance
Dependency List
License Compliance
Packages
Packages
List
Container Registry
Analytics
Analytics
CI / CD
Code Review
Insights
Issues
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
MyCard
Mirai
Commits
63d56006
Commit
63d56006
authored
Jun 11, 2020
by
Him188
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Update docs
parent
c551702d
Changes
2
Show whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
49 additions
and
37 deletions
+49
-37
CONTRIBUTING.md
CONTRIBUTING.md
+9
-12
README.md
README.md
+40
-25
No files found.
CONTRIBUTING.md
View file @
63d56006
# 贡献
感谢你来到这里和你对 mirai 做的所有贡献。
**感谢你来到这里和你对 mirai 做的所有贡献。**
mirai 欢迎一切形式的代码贡献。你可以通过以下几种途径向 mirai 贡献。
...
...
@@ -8,21 +8,18 @@ mirai 欢迎一切形式的代码贡献。你可以通过以下几种途径向 m
**阅读文档**
:
[
docs/mirai.md
](
docs/mirai.md
)
**请基于 `dev` 分支进行除文档以外的修改**
### 能做什么?
**请
将文档修改之类的 PR 提交到 `master`, 将其他修改提交到 `dev`**
**请
基于 `master` 分支进行文档修改; 基于 `dev` 分支进行除其他修改 (否则你的修改可能被关闭或不会立即合并)**
(特殊情况除外)
### 代码优化
优化功能设计或实现, 或是引入一个新的设计(建议先通过 issue 与我们达成共识)
### 协议更新
为 mirai 添加更广泛的协议支持。
-
代码优化: 优化任何功能设计或实现, 或是引入一个新的设计(请先通过 issue 与维护者达成共识)
-
解决问题: 在
[
issues
](
https://github.com/mamoe/mirai/issues
)
查看 mirai 正遇到的所有问题, 或在
[
里程碑
](
https://github.com/mamoe/mirai/milestones
)
查看版本计划
-
协议支持: 添加新协议支持, 但需要避免添加
[
mirai.md#声明
](
docs/mirai.md#L9
)
中的内容
### 注意事项
-
mirai 使用
[
`kotlinx.io`
](
https://github.com/Kotlin/kotlinx-io
)
IO 库
-
尽量不要引用新的库
-
遵守 Kotlin 代码规范(提交前使用 IDE 格式化代码 (commit 时勾选 'Reformat code'))
-
不要手动拆解数据包. 请一定使用
`kotlinx.serialization`
拆解 ProtoBuf, 使用
mirai 的
`Jce`
序列化器拆解 Jce
数据包, 使用
`kotlinx.serialization`
拆解 Json 数据.
-
遵守 Kotlin
官方
代码规范(提交前使用 IDE 格式化代码 (commit 时勾选 'Reformat code'))
-
不要手动拆解数据包. 请一定使用
`kotlinx.serialization`
拆解 ProtoBuf, 使用
[
`jcekt`
](
https://github.com/him188/jcekt
)
拆解 Tars
数据包, 使用
`kotlinx.serialization`
拆解 Json 数据.
## 社区
...
...
README.md
View file @
63d56006
...
...
@@ -77,28 +77,46 @@ mirai 既可以作为项目中的 QQ 协议支持库, 也可以作为单独的
## 开始
### 文档
-
**开发文档**
:
[
docs/mirai.md
](
docs/mirai.md
)
-
**常见问题**
:
[
docs/FAQ.md
](
docs/FAQ.md
)
-
**更新日志**
:
[
CHANGELOG
](
https://github.com/mamoe/mirai/blob/master/CHANGELOG.md
)
或
[
release
](
https://github.com/mamoe/mirai/releases
)
-
**开发计划**
:
[
milestones
](
https://github.com/mamoe/mirai/milestones
)
-
**贡献**
:
[
CONTRIBUTING
](
CONTRIBUTING.md
)
### 开发者
#### **开发文档**: [docs/mirai.md](docs/mirai.md)
#### 使用 mirai-console 服务端,为 mirai-console 开发插件
官方支持 SDK 列表:
-
`Java`
,
`Kotlin`
等 JVM 语言: 为
[
mirai-console
](
https://github.com/mamoe/mirai-console
)
直接编写插件并与其他插件开发者合作共享
-
`Kotlin Script`
:
[
mirai-kts
](
https://github.com/iTXTech/mirai-kts
)
支持使用
`kts`
编写插件,享受
`Kotlin`
带来的一切便利(
**仅 OpenJDK 8 以上环境,不支持 Android**
)
-
`C`
,
`C++`
等原生语言:
[
mirai-native
](
https://github.com/iTXTech/mirai-native
)
支持酷 Q 插件在 mirai 上运行
**(仅限 `Windows 32 位 JRE`/支持 `Wine`)**
-
`JavaScript`
:
[
mirai-js
](
https://github.com/iTXTech/mirai-js
)
支持使用
`JavaScript`
编写插件并
**直接**
与 mirai 交互
-
*Http*
:使用由
[
mirai-api-http
](
https://github.com/mamoe/mirai-api-http
)
提供的 http 接口进行接入
<details>
<summary>
社区支持的 SDK 列表
</summary>
基于
`mirai-core`
(独立使用):
-
`Lua`
:
[
lua-mirai
](
https://github.com/only52607/lua-mirai
)
基于 mirai-core 的 Lua SDK,并提供了 Java 扩展支持,可在 Lua 中调用 Java 代码开发机器人
#### 使用 mirai 作为服务器,为 mirai 开发插件
-
(官方)
`Java`
或
`Kotlin`
: 为
[
mirai-console
](
https://github.com/mamoe/mirai-console
)
直接编写插件并与其他插件开发者合作共享
-
(官方)
`Kotlin Script`
:
[
mirai-kts
](
https://github.com/iTXTech/mirai-kts
)
支持使用
`kts`
编写插件,享受
`Kotlin`
带来的一切便利(
**仅支持OpenJDK 8以上环境,不支持Android**
)
-
(官方)
`C`
,
`C++`
等原生语言:
[
mirai-native
](
https://github.com/iTXTech/mirai-native
)
支持酷Q插件在mirai上运行
**(仅限`Windows 32位JRE`/支持`Wine`)**
-
(官方)
`JavaScript`
:
[
mirai-js
](
https://github.com/iTXTech/mirai-js
)
支持使用
`JavaScript`
编写插件并
**直接**
与
`Mirai`
交互
-
(社区)
`Python`
:
[
python-mirai
](
https://github.com/NatriumLab/python-mirai
)
基于
`mirai-api-http`
的机器人开发框架
-
(社区)
`JavaScript`
(
`Node.js`
):
[
node-mirai
](
https://github.com/RedBeanN/node-mirai
)
mirai 的 Node.js SDK
-
(社区)
`Go`
:
[
gomirai
](
https://github.com/Logiase/gomirai
)
基于 mirai-api-http 的 GoLang SDK
-
(社区)
`Mozilla Rhino`
:
[
mirai-rhinojs-sdk
](
https://github.com/StageGuard/mirai-rhinojs-sdk
)
为基于 Rhino(如 Auto.js 等安卓 app 或运行环境)的 JavaScript 提供简单易用的 SDK
-
(社区)
`Lua`
:
[
lua-mirai
](
https://github.com/only52607/lua-mirai
)
基于mirai-core 的Lua SDK,并提供了java扩展支持,可在lua中调用java代码开发机器人
-
(社区)
`C++`
:
[
mirai-cpp
](
https://github.com/cyanray/mirai-cpp
)
mirai-http-api 的 C++ 封装,方便使用 C++ 开发 mirai-http-api 插件
-
(社区)
`C++`
:
[
miraipp
](
https://github.com/Chlorie/miraipp-template
)
mirai-http-api 的另一个 C++ 封装,使用现代 C++ 特性,并提供了较完善的说明文档
-
(社区)
`C#`
:
[
Mirai-CSharp
](
https://github.com/Executor-Cheng/Mirai-CSharp
)
基于 mirai-api-http 的 C# SDK
-
(社区)
`Rust`
:
[
mirai-rs
](
https://github.com/HoshinoTented/mirai-rs
)
mirai-http-api 的 Rust 封装
-
(官方)其他任意语言:使用由
[
mirai-api-http
](
https://github.com/mamoe/mirai-api-http
)
提供的 http 接口进行接入
基于
`mirai-http-api`
(配合
[
mirai-console
](
https://github.com/mamoe/mirai-console
)
):
#### 使用 mirai 为第三方依赖库引入项目
-
`Python`
:
[
python-mirai
](
https://github.com/NatriumLab/python-mirai
)
基于
`mirai-api-http`
的机器人开发框架
-
`JavaScript`
(
`Node.js`
):
[
node-mirai
](
https://github.com/RedBeanN/node-mirai
)
mirai 的 Node.js SDK
-
`Go`
:
[
gomirai
](
https://github.com/Logiase/gomirai
)
基于 mirai-api-http 的 GoLang SDK
-
`Mozilla Rhino`
:
[
mirai-rhinojs-sdk
](
https://github.com/StageGuard/mirai-rhinojs-sdk
)
为基于 Rhino(如 Auto.js 等安卓 app 或运行环境)的 JavaScript 提供简单易用的 SDK
-
`C++`
:
[
mirai-cpp
](
https://github.com/cyanray/mirai-cpp
)
mirai-http-api 的 C++ 封装,方便使用 C++ 开发 mirai-http-api 插件
-
`C++`
:
[
miraipp
](
https://github.com/Chlorie/miraipp-template
)
mirai-http-api 的另一个 C++ 封装,使用现代 C++ 特性,并提供了较完善的说明文档
-
`C#`
:
[
Mirai-CSharp
](
https://github.com/Executor-Cheng/Mirai-CSharp
)
基于 mirai-api-http 的 C# SDK
-
`Rust`
:
[
mirai-rs
](
https://github.com/HoshinoTented/mirai-rs
)
mirai-http-api 的 Rust 封装
</details>
#### 使用 mirai-core 为第三方依赖库引入项目
Demos:
[
mirai-demos
](
https://github.com/mamoe/mirai-demos
)
...
...
@@ -108,17 +126,12 @@ Demos: [mirai-demos](https://github.com/mamoe/mirai-demos)
### 使用者
-
[
mirai-console
](
https://github.com/mamoe/mirai-console
)
支持插件
**本模块正在完善
**
-
[
mirai-console
](
https://github.com/mamoe/mirai-console
)
支持插件
的控制台服务端
**本模块正在开发中
**
###
其他平台的使用者
###
# 从其他平台迁移
-
酷Q的插件可以在 mirai 中加载, 详见
[
Mirai-Native
](
https://github.com/iTXTech/mirai-native
)
-
使用
`酷Q HTTP API`
的插件将可以在 mirai 中加载,
`Mirai-CQ-Adapter`
正在进行中
-
[
MiraiAndroid
](
https://github.com/mzdluo123/MiraiAndroid
)
让mirai-console的插件在Android运行
**实验性**
## 更新日志
*
在
[
CHANGELOG
](
https://github.com/mamoe/mirai/blob/master/CHANGELOG.md
)
查看版本更新记录 (仅发布的版本)
## [贡献](CONTRIBUTING.md)
...
...
@@ -131,6 +144,8 @@ Demos: [mirai-demos](https://github.com/mamoe/mirai-demos)
## 鸣谢
> IntelliJ IDEA 是一个在各个方面都最大程度地提高开发人员的生产力的 IDE, 适用于 JVM 平台语言。
特别感谢
[
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
)
...
...
@@ -147,7 +162,7 @@ Demos: [mirai-demos](https://github.com/mamoe/mirai-demos)
------
Copyright (C) 2019-2020
mamoe and M
irai contributors
Copyright (C) 2019-2020
Mamoe Technologies and m
irai contributors
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment