Skip to content
This repository was archived by the owner on Oct 20, 2023. It is now read-only.

Commit f096bb7

Browse files
authored
Update README.md
1 parent dc9a3b0 commit f096bb7

File tree

1 file changed

+37
-42
lines changed

1 file changed

+37
-42
lines changed

README.md

Lines changed: 37 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -12,30 +12,26 @@
1212

1313
<img width="95" src="https://cdn.jsdelivr.net/gh/mzdluo123/blog_imgs/img/20200531205726.png" alt="title">
1414

15-
</div>
16-
17-
18-
# MiraiAndroid
19-
20-
<img alt="GitHub Workflow Status" src="https://img.shields.io/github/workflow/status/mzdluo123/MiraiAndroid/Android Build?style=flat-square">
21-
22-
<img alt="GitHub issues" src="https://img.shields.io/github/issues/mzdluo123/MiraiAndroid?style=flat-square">
15+
----
16+
[Mirai](https://github.com/mamoe/mirai) 是一个在全平台下运行,提供 QQ Android 协议支持的高效率机器人库
2317

24-
<img alt="GitHub pull requests" src="https://img.shields.io/github/issues-pr/mzdluo123/MiraiAndroid?style=flat-square">
18+
图标以及形象由画师<a href = "https://github.com/DazeCake">DazeCake</a>绘制
2519

26-
mirai-console的Android前端程序,可作为qq机器人使用,支持多种脚本接口,已适配MiraiConsole 2.0
20+
</div>
2721

28-
如果你不知道什么是mirai或者是mirai-console,请到这里了解更多信息[mirai](https://github.com/mamoe/mirai)
2922

30-
相比使用`Termux`或者是`Linux Deploy`等应用运行mirai的方案,该项目提供的方案具有更好的性能以及更少的资源占用,但可能存在兼容性问题
23+
# MiraiAndroid
3124

32-
最新的构建版本你可以到release或QQ群内找到
25+
[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/mzdluo123/MiraiAndroid/Android%20Build?style=flat-square&logo=github)](https://github.com/mzdluo123/MiraiAndroid/actions)
26+
[![Release](https://img.shields.io/github/v/release/mzdluo123/MiraiAndroid?style=flat-square&color=orange&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAGQAAABkCAMAAABHPGVmAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAAxQTFRFOqTdPpDDDjdWAAAA01db/wAAAAR0Uk5T////AEAqqfQAAAGRSURBVHja7NrRTsMwEETRO+v//2cKQtDSNNm1PSuE8Ht0FOcpM8NoOPwpJM6P5g/yI/gRsCNgR8COgB0BOwJ2BOwI2BGwI2BHwI6AHQE7AnYE7AjYEbAjYEfAjoAdATsCdgTsCNgRsCNgR8COgB2BdiTkRxQlZQq5GbdnzMi7McKLfBhjyIkoPv805UMU8fU/a0O+jfRnKSN3RvrCqojiIQCQA1HEj5jBgPw0cp+lhjwZuQsrIQdGSqkgiuP0ZyeiOEZiJ/LCSFxYHnlpXF9YFpHiLJTb9CZnxlAHcqGkkasUcwdynZV2IFpHErHvciKRC5c7kLGGJHPyWEHSabzmkUrmP4vUmoUORHNIsSSZCjrrVUwHMurIRKtUDp+nuivVkNmGrILM93AdiPLIQqWY7k/WissOZOSQxQ421WktN726Rnb0yR3IuEK2VOM6RzYV8Ke17L6avwMZr5GNi4WXVfnWXYSOkd3riw4kjpDtQxI9I4a5ytPawzOKeURc05t7xLXvkTq2RC3I+Ed+KfImwADzdEfKPNJbbAAAAABJRU5ErkJggg==&logoWidth=12)](https://github.com/mzdluo123/MiraiAndroid/releases)
27+
![QQ Group](https://img.shields.io/badge/交流群-206073050-informational?style=flat-square&logo=tencent-qq)
28+
[![MiraiForum](https://img.shields.io/badge/官方论坛-mirai--forum-blueviolet?style=flat-square&logo=appveyor)](https://mirai.mamoe.net)
3329

34-
MiraiAndroid交流群:~~`1131127734`(旧群群主被封)~~ 新群`206073050` 但是请注意,如果您违反了群内相关规定或是有其他不当行为你可能会被无理由移出本群
30+
MiraiAndroid 是 基于 [Mirai](https://github.com/mamoe/mirai) 的 QQ 机器人 Android 前端程序,支持多种脚本接口,具有 轻量、简洁、易用、高效 的特点,依赖于 [mirai-console](https://github.com/mamoe/mirai-console)
3531

36-
MiraiForum:mirai官方论坛 https://mirai.mamoe.net
32+
相比使用 `Termux` 或者是 `Linux Deploy` 等部署并运行 [Mirai](https://github.com/mamoe/mirai) 的方案, MiraiAndroid 提供了更好的性能、更少的资源占用,以及更方便的操作界面。
3733

38-
图标以及形象由画师<a href = "https://github.com/DazeCake">DazeCake</a>绘制
34+
最新的构建版本你可以到 [releases](https://github.com/mzdluo123/MiraiAndroid/releases) 或 上方交流群 内找到。其中请注意,如果您违反了交流群内相关规定或是有其他不当行为你可能会被无理由移出交流群。
3935

4036
## 声明
4137

@@ -66,40 +62,39 @@ MiraiForum:mirai官方论坛 https://mirai.mamoe.net
6662
- **间接接触(包括但不限于使用 `httpapi` 或 跨进程技术)到 `mirai` 的软件使用 `AGPLv3` 开源**
6763
- **不鼓励,不支持一切商业使用**
6864

65+
## 已实现的功能
6966

70-
# 已实现的功能
71-
72-
* 兼容mirai-console插件(实验性)
67+
* 兼容 mirai-console 插件(实验性)
7368
* 带验证码的登录处理
74-
* 内置Google d8 dex编译器,可直接编译JVM的console插件在Android运行(实验性)
75-
* lua脚本接口(测试版)
69+
* 内置 Google d8 dex 编译器,可直接编译 JVM 的 console 插件在 Android 运行(实验性)
70+
* lua 脚本接口(测试版)
7671
* 网络掉线提醒
7772

78-
# 安装脚本
73+
## 安装脚本
7974

8075
目前脚本系统仍在开发中,对于2.x版本的lua或js脚本系统正在迁移中,请等待后续更新
8176

82-
# 安装插件
77+
## 安装插件
8378

84-
对于apk(Android软件包)格式的插件,请直接安装到系统内即可,关于这类插件的开发说明请看[这里](docs/develop.md)
79+
对于 apk(Android 软件包) 格式的插件,请直接安装到系统内即可,关于这类插件的开发说明请看[这里](docs/develop.md)
8580

8681
对于jar格式的插件,你有两个办法安装插件
8782

88-
## 使用app直接打开jar文件安装
83+
### 使用 app 直接打开 jar 文件安装
8984

90-
这是最简单的方式。app切换到插件管理点击右上角选择即可,你也可以使用系统文件选择器直接打开jar文件
85+
这是最简单的方式。 app 切换到插件管理点击右上角选择即可,你也可以使用系统文件选择器直接打开 jar 文件
9186

92-
对于已经经过d8转换过的插件,请直接导入
87+
对于已经经过 d8 转换过的插件,请直接导入
9388

94-
**如果你无法选择文件**,请使用第三方文件选择器选择(例如Mix
89+
**如果你无法选择文件**,请使用第三方文件选择器选择(例如 Mix
9590

96-
## 使用pc转换后导入
91+
### 使用 pc 转换后导入
9792

9893
请按照以下方法操作
9994

100-
* 找到`d8`编译器的运行脚本
95+
* 找到 `d8` 编译器的运行脚本
10196

102-
d8工具已在新版`Android sdk`中自带,它就在`build-tools`中对应版本的文件夹下。在Windows平台他是一个bat文件
97+
d8工具已在新版 `Android sdk` 中自带,它就在 `build-tools` 中对应版本的文件夹下。在Windows平台他是一个bat文件
10398

10499
如果没有可到上面的交流群内下载
105100

@@ -114,38 +109,38 @@ d8.bat --output 输出文件.jar 源文件
114109

115110
* 复制资源
116111

117-
使用压缩软件打开源jar文件,将里面的`plugin.yml``META-INF`和其他资源文件(除存放class文件夹的其他文件)复制到新的jar文件内
112+
使用压缩软件打开源jar文件,将里面的 `plugin.yml``META-INF` 和其他资源文件(除存放class文件夹的其他文件)复制到新的jar文件内
118113

119114
* 安装插件
120115

121-
将上一步的新的jar文件复制到手机的`/sdcard/Android/data/io.github.mzdluo123.mirai.android/files/plugins/`
116+
将上一步的新的jar文件复制到手机的 `/sdcard/Android/data/io.github.mzdluo123.mirai.android/files/plugins/`
122117

123118
重启即可使用插件,当然部分插件可能也会存在兼容性问题
124119

125-
# FAQ
120+
## FAQ
126121

127122
Q: 后台运行被系统杀死<br>
128123
A:请手动将应用添加到系统后台白名单
129124

130125
Q:应用崩溃或后台报错<br>
131126
A:如果是后台报错一般是插件或者是mirai-core的问题,是mirai-core的问题请在菜单内找到分享日志并到群内或开启issue反馈,插件的问题请联系对应开发者;如果是应用崩溃,请重启并按照上面的方法提交日志给我们
132127

133-
# 兼容的Console插件列表
128+
## 兼容的 Console 插件列表
134129

135130
以下插件由群友测试未发现问题,你可以到群内下载,或是到[插件中心](https://github.com/mamoe/mirai-plugins)手动下载jvm版并导入
136131

137132
* mirai-api-http
138133
* chatcommand
139134

140-
对于其他插件请自行尝试;此外,如果你的插件使用了一些Android不支持的api(例如BufferedImage)那么使用了这个api的功能将绝对不能正常工作
135+
对于其他插件请自行尝试;此外,如果你的插件使用了一些 Android 不支持的 api(例如BufferedImage) 那么使用了这个api的功能将绝对不能正常工作
141136

142-
# 关于支持的Android版本
137+
## 关于支持的 Android 版本
143138

144-
MiraiAndroid只能在Android8.0及以上版本的系统中工作,因为上游MiaiCore使用了大量Java8特性
139+
MiraiAndroid 只能在 Android8.0 及以上版本的系统中工作,因为上游 MiaiCore 使用了大量 Java8 特性
145140

146-
目前测试过的版本中Android10无问题,Android8.1无法在移动端编译插件
141+
目前测试过的版本中 Android10 无问题, Android8.1 无法在移动端编译插件
147142

148-
# 消息推送(2.9新增)
143+
## 消息推送(2.9新增)
149144

150145
必须使用自动登录并在设置中开启才能使用该功能
151146

@@ -163,7 +158,7 @@ sendBroadcast(Intent("io.github.mzdluo123.mirai.android.PushMsg").apply {
163158
})
164159
```
165160

166-
以下是auto.js的示例
161+
以下是 auto.js 的示例
167162

168163
```js
169164
app.sendBroadcast({
@@ -172,7 +167,7 @@ app.sendBroadcast({
172167
})
173168
```
174169

175-
以下是tasker的示例
170+
以下是 tasker 的示例
176171

177172
```yaml
178173
ma (2)

0 commit comments

Comments
 (0)