fz-mirrors/MaaAssistantArknights
0
0
Fork 0
mirror of https://github.com/MaaAssistantArknights/MaaAssistantArknights.git synced 2026-07-19 10:32:19 +08:00
Code Issues Packages Projects Releases Wiki Activity

style: 优化部分文件排版

Browse Source
This commit is contained in:
SherkeyXD
2025-04-20 21:27:47 +08:00
parent fafd1970be
commit 0743e1773b
11 changed files with 468 additions and 384 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
.prettierignore
View File

@@ -6,5 +6,10 @@ src/maa-cli
src/MaaMacGui
website/
docs/
resource/Arknights-Tile-Pos/
tools/OptimizeTemplates/optimize_templates.json
CITATION.cff
CHANGELOG.md

6
README.md
View File

@@ -33,7 +33,7 @@ MAA 的意思是 MAA Assistant Arknights
基于图像识别技术，一键完成全部日常任务！
绝赞更新中 ✿✿ヽ(°▽°)ノ✿
绝赞更新中 ✿✿ヽ(°▽°)ノ✿
</div>
@@ -206,9 +206,9 @@ MAA 以中文（简体）为第一语言，翻译词条均以中文（简体）
Discord 服务器: [邀请链接](https://discord.gg/23DfZ9uA4V)
用户交流 TG 群：[Telegram 群](https://t.me/+Mgc2Zngr-hs3ZjU1)
自动战斗 JSON 作业分享：[prts.plus](https://prts.plus)
Bilibili 直播间：[MrEO 直播间](https://live.bilibili.com/2808861) 直播敲代码 & [MAA-Official 直播间](https://live.bilibili.com/27548877) 游戏/杂谈
Bilibili 直播间：[MrEO 直播间](https://live.bilibili.com/2808861) 直播敲代码 & [MAA-Official 直播间](https://live.bilibili.com/27548877) 游戏/杂谈
技术群（舟无关、禁水）：[内卷地狱！(QQ 群)](https://jq.qq.com/?_wv=1027&k=ypbzXcA2)
开发者群：[QQ 群](https://jq.qq.com/?_wv=1027&k=JM9oCk3C)
开发者群：[QQ 群](https://jq.qq.com/?_wv=1027&k=JM9oCk3C)
如果觉得软件对你有帮助，帮忙点个 Star 吧！~（网页最上方右上角的小星星），这就是对我们最大的支持了！

2
src/Dart/CHANGELOG.md
View File

@@ -1,3 +1,3 @@
## 0.0.1
* TODO: Describe initial release.
- TODO: Describe initial release.

1
src/Dart/README.md
View File

@@ -12,4 +12,3 @@ Android and/or iOS.
For help getting started with Flutter, view our
[online documentation](https://flutter.dev/docs), which offers tutorials,
samples, guidance on mobile development, and a full API reference.

464
src/Java/Readme.md
View File

@@ -5,18 +5,18 @@
## 接口实现情况
| 功能名称 | 接口路径(命令) | HTTP实现 | WebSocket实现 |
|:-------|:--------------|:-------|:------------|
| 获取版本号 | getVersion | Yes | Yes |
| 创建连接 | connect | Yes | Yes |
| 添加任务 | appendTask | Yes | Yes |
| 设定任务参数 | setTaskParams | Yes | Yes |
| 开始执行 | start | Yes | Yes |
| 停止执行 | stop | Yes | Yes |
| 销毁实例 | destroy | Yes | Yes |
| 列出实例连接 | listInstance | Yes | Yes |
| 消息回调通知 | callBack | No | Yes |
| 获取截图 | getImage | Yes | No |
| 功能名称 | 接口路径(命令) | HTTP实现 | WebSocket实现 |
| :----------- | :------------- | :------- | :------------ |
| 获取版本号 | getVersion | Yes | Yes |
| 创建连接 | connect | Yes | Yes |
| 添加任务 | appendTask | Yes | Yes |
| 设定任务参数 | setTaskParams | Yes | Yes |
| 开始执行 | start | Yes | Yes |
| 停止执行 | stop | Yes | Yes |
| 销毁实例 | destroy | Yes | Yes |
| 列出实例连接 | listInstance | Yes | Yes |
| 消息回调通知 | callBack | No | Yes |
| 获取截图 | getImage | Yes | No |
## 环境依赖
@@ -34,7 +34,7 @@
```text
MaaCoreArknights_v3.9.0-beta.8
│ MAA.exe
│ MaaCore.dll
│ MaaCore.dll
│ ...
└───Java-HTTP
│ Maa-HTTP-0.0.1.jar
@@ -58,17 +58,17 @@
提供了如下功能
| 功能名称 | 接口路径 |
|:-------|:--------------|
| 获取版本号 | getVersion |
| 创建连接 | connect |
| 添加任务 | appendTask |
| 功能名称 | 接口路径 |
| :----------- | :------------ |
| 获取版本号 | getVersion |
| 创建连接 | connect |
| 添加任务 | appendTask |
| 设定任务参数 | setTaskParams |
| 开始执行 | start |
| 停止执行 | stop |
| 销毁实例 | destroy |
| 列出连接 | listInstance |
| 获取截图 | getImage |
| 开始执行 | start |
| 停止执行 | stop |
| 销毁实例 | destroy |
| 列出连接 | listInstance |
| 获取截图 | getImage |
---
@@ -86,11 +86,11 @@
```json
{
"data": {
"version": "v3.9.0-beta"
},
"code": 0,
"message": "success"
"data": {
"version": "v3.9.0-beta"
},
"code": 0,
"message": "success"
}
```
@@ -108,39 +108,39 @@
```json
{
"adbPath": "C:\\MaaCoreArknights3\\platform-tools\\adb.exe",
"host": "127.0.0.1:62001",
"detailJson": ""
"adbPath": "C:\\MaaCoreArknights3\\platform-tools\\adb.exe",
"host": "127.0.0.1:62001",
"detailJson": ""
}
```
###### Post 参数
| 字段名称 | 字段说明 | 类型 | 必填 | 备注 |
| ---- |-----------------|--------|-----|-----|
| adbPath | ADB地址 | String | Y | - |
| host | 实例地址 | String | Y | - |
| detailJson | 有什么用我也不知道，反正就是有 | String | N | - |
| 字段名称 | 字段说明 | 类型 | 必填 | 备注 |
| ---------- | ------------------------------ | ------ | ---- | ---- |
| adbPath | ADB地址 | String | Y | - |
| host | 实例地址 | String | Y | - |
| detailJson | 有什么用我也不知道，反正就是有 | String | N | - |
###### 4) 请求返回结果
```json
{
"data": {
"id": "46b9d5cd60382f100b336b17d6817f8eda255f73",
"result": true
},
"code": 0,
"message": "success"
"data": {
"id": "46b9d5cd60382f100b336b17d6817f8eda255f73",
"result": true
},
"code": 0,
"message": "success"
}
```
###### 5) 请求返回结果参数说明
| 字段名称 | 字段说明 | 类型 | 备注 |
|------|-------------|---------|---- |
| id | 给连接实例创建的ID | String | - |
| result | 是否成功 | Boolean | - |
| 字段名称 | 字段说明 | 类型 | 备注 |
| -------- | ------------------ | ------- | ---- |
| id | 给连接实例创建的ID | String | - |
| result | 是否成功 | Boolean | - |
---
@@ -158,41 +158,41 @@
```json
{
"id": "46b9d5cd60382f100b336b17d6817f8eda255f73",
"type": "Fight",
"params": {
"stage": "LastBattle"
}
"id": "46b9d5cd60382f100b336b17d6817f8eda255f73",
"type": "Fight",
"params": {
"stage": "LastBattle"
}
}
```
###### Post 参数
| 字段名称 | 字段说明 | 类型 | 必填 | 备注 |
| ---- |-------------------------------------------------------------------------------------------------------------------------------|--------|---- |-----|
| id | 创建连接返回的实例ID | String | Y | - |
| type | 任务类型,此次示例为刷理智战斗,详情参考[集成文档](https://raw.githubusercontent.com/MaaAssistantArknights/MaaAssistantArknights/master/docs/集成文档.md) | String | Y | - |
| params | 任务参数 | Json | Y | - |
| 字段名称 | 字段说明 | 类型 | 必填 | 备注 |
| -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ---- | ---- |
| id | 创建连接返回的实例ID | String | Y | - |
| type | 任务类型,此次示例为刷理智战斗,详情参考[集成文档](https://raw.githubusercontent.com/MaaAssistantArknights/MaaAssistantArknights/master/docs/集成文档.md) | String | Y | - |
| params | 任务参数 | Json | Y | - |
###### 4) 请求返回结果
```json
{
"data": {
"id": "46b9d5cd60382f100b336b17d6817f8eda255f73",
"taskId": 0
},
"code": 0,
"message": "success"
"data": {
"id": "46b9d5cd60382f100b336b17d6817f8eda255f73",
"taskId": 0
},
"code": 0,
"message": "success"
}
```
###### 5) 请求返回结果参数说明
| 字段名称 | 字段说明 | 类型 | 备注 |
|------|------------|--------|---- |
| id | 实例ID | String | - |
| taskId | 任务ID,为0则失败 | Int | - |
| 字段名称 | 字段说明 | 类型 | 备注 |
| -------- | ---------------- | ------ | ---- |
| id | 实例ID | String | - |
| taskId | 任务ID,为0则失败 | Int | - |
---
@@ -208,43 +208,43 @@
```json
{
"id": "46b9d5cd60382f100b336b17d6817f8eda255f73",
"type": "Fight",
"taskId": 0,
"params": {
"stage": "LastBattle"
}
"id": "46b9d5cd60382f100b336b17d6817f8eda255f73",
"type": "Fight",
"taskId": 0,
"params": {
"stage": "LastBattle"
}
}
```
###### Post 参数
| 字段名称 | 字段说明 | 类型 | 必填 | 备注 |
| ---- |-------------------------------------------------------------------------------------------------------------------------------|--------|---- |-----|
| id | 创建连接返回的实例ID | String | Y | - |
| taskId | 任务ID | Int | Y | - |
| type | 任务类型,此次示例为刷理智战斗,详情参考[集成文档](https://raw.githubusercontent.com/MaaAssistantArknights/MaaAssistantArknights/master/docs/集成文档.md) | String | Y | - |
| params | 任务参数 | Json | Y | - |
| 字段名称 | 字段说明 | 类型 | 必填 | 备注 |
| -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ---- | ---- |
| id | 创建连接返回的实例ID | String | Y | - |
| taskId | 任务ID | Int | Y | - |
| type | 任务类型,此次示例为刷理智战斗,详情参考[集成文档](https://raw.githubusercontent.com/MaaAssistantArknights/MaaAssistantArknights/master/docs/集成文档.md) | String | Y | - |
| params | 任务参数 | Json | Y | - |
###### 4) 请求返回结果
```json
{
"data": {
"id": "46b9d5cd60382f100b336b17d6817f8eda255f73",
"result": false
},
"code": 0,
"message": "success"
"data": {
"id": "46b9d5cd60382f100b336b17d6817f8eda255f73",
"result": false
},
"code": 0,
"message": "success"
}
```
###### 5) 请求返回结果参数说明
| 字段名称 | 字段说明 | 类型 | 备注 |
|------|-------------|---------|---- |
| id | 给连接实例创建的ID | String | - |
| result | 是否成功 | Boolean | - |
| 字段名称 | 字段说明 | 类型 | 备注 |
| -------- | ------------------ | ------- | ---- |
| id | 给连接实例创建的ID | String | - |
| result | 是否成功 | Boolean | - |
---
@@ -260,35 +260,35 @@
```json
{
"id": "ccd76e0c367511158ca774ff951a22e8bb62f5d3"
"id": "ccd76e0c367511158ca774ff951a22e8bb62f5d3"
}
```
###### Post 参数
| 字段名称 | 字段说明 | 类型 | 必填 | 备注 |
| ---- |--------|--------|---- |-----|
| id | 创建连接返回的实例ID | String | Y | - |
| 字段名称 | 字段说明 | 类型 | 必填 | 备注 |
| -------- | -------------------- | ------ | ---- | ---- |
| id | 创建连接返回的实例ID | String | Y | - |
###### 4) 请求返回结果
```json
{
"data": {
"id": "ccd76e0c367511158ca774ff951a22e8bb62f5d3",
"result": true
},
"code": 0,
"message": "success"
"data": {
"id": "ccd76e0c367511158ca774ff951a22e8bb62f5d3",
"result": true
},
"code": 0,
"message": "success"
}
```
###### 5) 请求返回结果参数说明
| 字段名称 | 字段说明 | 类型 | 备注 |
|------|-------------|---------|---- |
| id | 给连接实例创建的ID | String | - |
| result | 是否成功 | Boolean | - |
| 字段名称 | 字段说明 | 类型 | 备注 |
| -------- | ------------------ | ------- | ---- |
| id | 给连接实例创建的ID | String | - |
| result | 是否成功 | Boolean | - |
---
@@ -304,35 +304,35 @@
```json
{
"id": "ccd76e0c367511158ca774ff951a22e8bb62f5d3"
"id": "ccd76e0c367511158ca774ff951a22e8bb62f5d3"
}
```
###### Post 参数
| 字段名称 | 字段说明 | 类型 | 必填 | 备注 |
| ---- |--------|--------|---- |-----|
| id | 创建连接返回的实例ID | String | Y | - |
| 字段名称 | 字段说明 | 类型 | 必填 | 备注 |
| -------- | -------------------- | ------ | ---- | ---- |
| id | 创建连接返回的实例ID | String | Y | - |
###### 4) 请求返回结果
```json
{
"data": {
"id": "ccd76e0c367511158ca774ff951a22e8bb62f5d3",
"result": true
},
"code": 0,
"message": "success"
"data": {
"id": "ccd76e0c367511158ca774ff951a22e8bb62f5d3",
"result": true
},
"code": 0,
"message": "success"
}
```
###### 5) 请求返回结果参数说明
| 字段名称 | 字段说明 | 类型 | 备注 |
|------|-------------|---------|---- |
| id | 给连接实例创建的ID | String | - |
| result | 是否成功 | Boolean | - |
| 字段名称 | 字段说明 | 类型 | 备注 |
| -------- | ------------------ | ------- | ---- |
| id | 给连接实例创建的ID | String | - |
| result | 是否成功 | Boolean | - |
---
@@ -348,35 +348,35 @@
```json
{
"id": "ccd76e0c367511158ca774ff951a22e8bb62f5d3"
"id": "ccd76e0c367511158ca774ff951a22e8bb62f5d3"
}
```
###### Post 参数
| 字段名称 | 字段说明 | 类型 | 必填 | 备注 |
| ---- |--------|--------|---- |-----|
| id | 创建连接返回的实例ID | String | Y | - |
| 字段名称 | 字段说明 | 类型 | 必填 | 备注 |
| -------- | -------------------- | ------ | ---- | ---- |
| id | 创建连接返回的实例ID | String | Y | - |
###### 4) 请求返回结果
```json
{
"data": {
"id": "ccd76e0c367511158ca774ff951a22e8bb62f5d3",
"result": true
},
"code": 0,
"message": "success"
"data": {
"id": "ccd76e0c367511158ca774ff951a22e8bb62f5d3",
"result": true
},
"code": 0,
"message": "success"
}
```
###### 5) 请求返回结果参数说明
| 字段名称 | 字段说明 | 类型 | 备注 |
|------|-------------|---------|---- |
| id | 给连接实例创建的ID | String | - |
| result | 是否成功 | Boolean | - |
| 字段名称 | 字段说明 | 类型 | 备注 |
| -------- | ------------------ | ------- | ---- |
| id | 给连接实例创建的ID | String | - |
| result | 是否成功 | Boolean | - |
---
@@ -394,31 +394,31 @@
```json
{
"data": {
"list": [
{
"id": "ccd76e0c367511158ca774ff951a22e8bb62f5d3",
"host": "127.0.0.1:62026",
"adbPath": "C:\\Users\\atmzx\\Desktop\\MaaCoreArknights3\\platform-tools\\adb.exe",
"uuid": "",
"status": 0
}
]
},
"code": 0,
"message": "success"
"data": {
"list": [
{
"id": "ccd76e0c367511158ca774ff951a22e8bb62f5d3",
"host": "127.0.0.1:62026",
"adbPath": "C:\\Users\\atmzx\\Desktop\\MaaCoreArknights3\\platform-tools\\adb.exe",
"uuid": "",
"status": 0
}
]
},
"code": 0,
"message": "success"
}
```
###### 5) 请求返回结果参数说明
| 字段名称 | 字段说明 | 类型 | 备注 |
|------|-------------|--------|---- |
| id | 实例ID | String | - |
| host | 连接的Host | String | - |
| adbPath | 使用的Adb地址 | String | - |
| uuid | 设备备ID，保留 | String | - |
| status | 0待机中,1任务执行中 | Int | - |
| 字段名称 | 字段说明 | 类型 | 备注 |
| -------- | ------------------- | ------ | ---- |
| id | 实例ID | String | - |
| host | 连接的Host | String | - |
| adbPath | 使用的Adb地址 | String | - |
| uuid | 设备备ID，保留 | String | - |
| status | 0待机中,1任务执行中 | Int | - |
---
@@ -434,9 +434,9 @@
###### Get参数
| 字段名称 | 字段说明 | 类型 | 必填 | 备注 |
| ---- |--------|--------|---- |-----|
| id | 创建连接返回的实例ID | String | Y | - |
| 字段名称 | 字段说明 | 类型 | 必填 | 备注 |
| -------- | -------------------- | ------ | ---- | ---- |
| id | 创建连接返回的实例ID | String | Y | - |
###### 4) 请求返回结果: 图片内容, PNG 格式
@@ -448,16 +448,16 @@
提供了如下功能
| 功能名称 | 命令 |
|:-------|:--------------|
| 获取版本号 | getVersion |
| 创建连接 | connect |
| 添加任务 | appendTask |
| 功能名称 | 命令 |
| :----------- | :------------ |
| 获取版本号 | getVersion |
| 创建连接 | connect |
| 添加任务 | appendTask |
| 设定任务参数 | setTaskParams |
| 开始执行 | start |
| 停止执行 | stop |
| 销毁实例 | destroy |
| 列出实例连接 | listInstance |
| 开始执行 | start |
| 停止执行 | stop |
| 销毁实例 | destroy |
| 列出实例连接 | listInstance |
| 消息回调通知 | callBack |
所有的的WebSocket接口跟HTTP接口请求响应参数均完全一致
@@ -468,37 +468,37 @@
```json
{
"command": "getVersion",
"msgId": 114514,
"data": {}
"command": "getVersion",
"msgId": 114514,
"data": {}
}
```
| 字段名称 | 字段说明 | 类型 | 必填 | 备注 |
| ---- |-----------------------------------|--------|---- |-----|
| command | 操作命令 | String |,Y | - |
| msgId | 消息ID，服务端收到此次请求，会用同一个ID答复，便于请求响应关联 | Int | Y | - |
| data | 请求参数，请参考同名接口的HTTP接口文档，与HTTP接口完全一致 | Json | Y | - |
| 字段名称 | 字段说明 | 类型 | 必填 | 备注 |
| -------- | -------------------------------------------------------------- | ------ | ---- | ---- |
| command | 操作命令 | String | ,Y | - |
| msgId | 消息ID，服务端收到此次请求，会用同一个ID答复，便于请求响应关联 | Int | Y | - |
| data | 请求参数，请参考同名接口的HTTP接口文档，与HTTP接口完全一致 | Json | Y | - |
###### 请求返回结果
```json
{
"data": {
"version": "v3.9.0-beta"
},
"command": "getVersion",
"msgId": 114514,
"code": 0,
"message": "success"
"data": {
"version": "v3.9.0-beta"
},
"command": "getVersion",
"msgId": 114514,
"code": 0,
"message": "success"
}
```
| 字段名称 | 字段说明 | 类型 | 备注 |
|------|-----------------------------------|--------|---- |
| command | 操作命令,与请求一致 | String | - |
| msgId | 消息ID，此次请求的消息ID为114514则响应也是114514 | Int | - |
| data | 响应内容,请参考同名接口的HTTP接口文档，与HTTP接口完全一致 | Json | - |
| 字段名称 | 字段说明 | 类型 | 备注 |
| -------- | --------------------------------------------------------- | ------ | ---- |
| command | 操作命令,与请求一致 | String | - |
| msgId | 消息ID，此次请求的消息ID为114514则响应也是114514 | Int | - |
| data | 响应内容,请参考同名接口的HTTP接口文档，与HTTP接口完全一致 | Json | - |
---
@@ -506,41 +506,41 @@
```json
{
"command": "connect",
"msgId": 114514,
"data": {
"adbPath": "C:\\Users\\atmzx\\Desktop\\MaaCoreArknights3\\platform-tools\\adb.exe",
"host": "127.0.0.1:62001"
}
"command": "connect",
"msgId": 114514,
"data": {
"adbPath": "C:\\Users\\atmzx\\Desktop\\MaaCoreArknights3\\platform-tools\\adb.exe",
"host": "127.0.0.1:62001"
}
}
```
| 字段名称 | 字段说明 | 类型 | 必填 | 备注 |
| ---- |---------------------------------|--------|---- |-----|
| command | 操作命令 | String |,Y | - |
| msgId | 消息ID，服务端收到此次请求，会用同一个ID答复，便于请求响应关联 | Int | Y | - |
| data | 请求参数，请参考同名接口的HTTP文档，与HTTP接口完全一致 | Json | Y | - |
| 字段名称 | 字段说明 | 类型 | 必填 | 备注 |
| -------- | -------------------------------------------------------------- | ------ | ---- | ---- |
| command | 操作命令 | String | ,Y | - |
| msgId | 消息ID，服务端收到此次请求，会用同一个ID答复，便于请求响应关联 | Int | Y | - |
| data | 请求参数，请参考同名接口的HTTP文档，与HTTP接口完全一致 | Json | Y | - |
###### 请求返回结果
```json
{
"data": {
"id": "46b9d5cd60382f100b336b17d6817f8eda255f73",
"result": true
},
"command": "connect",
"msgId": 114514,
"code": 0,
"message": "success"
"data": {
"id": "46b9d5cd60382f100b336b17d6817f8eda255f73",
"result": true
},
"command": "connect",
"msgId": 114514,
"code": 0,
"message": "success"
}
```
| 字段名称 | 字段说明 | 类型 | 备注 |
|------|-----------------------------------|--------|---- |
| command | 操作命令,与请求一致 | String | - |
| msgId | 消息ID，此次请求的消息ID为114514则响应也是114514 | Int | - |
| data | 响应内容,请参考同名接口的HTTP接口文档，与HTTP接口完全一致 | Json | - |
| 字段名称 | 字段说明 | 类型 | 备注 |
| -------- | --------------------------------------------------------- | ------ | ---- |
| command | 操作命令,与请求一致 | String | - |
| msgId | 消息ID，此次请求的消息ID为114514则响应也是114514 | Int | - |
| data | 响应内容,请参考同名接口的HTTP接口文档，与HTTP接口完全一致 | Json | - |
appendTask setTaskParams start stop等接口不再描述，均可遵循以上规则，参考HTTP接口文档实现。
@@ -552,32 +552,32 @@ appendTask setTaskParams start stop等接口不再描述，均可遵循以上规
```json
{
"data": {
"id": "46b9d5cd60382f100b336b17d6817f8eda255f73",
"logId": 1,
"msg": 2,
"details": {
"uuid": "",
"details": {
"adb": "C:\\MaaCoreArknights3\\platform-tools\\adb.exe",
"address": "127.0.0.1:62001",
"config": "General",
"width": 1280,
"height": 720
},
"what": "ResolutionGot",
"why": ""
}
},
"command": "callBack",
"msgId": 0,
"code": 0,
"message": "success"
"data": {
"id": "46b9d5cd60382f100b336b17d6817f8eda255f73",
"logId": 1,
"msg": 2,
"details": {
"uuid": "",
"details": {
"adb": "C:\\MaaCoreArknights3\\platform-tools\\adb.exe",
"address": "127.0.0.1:62001",
"config": "General",
"width": 1280,
"height": 720
},
"what": "ResolutionGot",
"why": ""
}
},
"command": "callBack",
"msgId": 0,
"code": 0,
"message": "success"
}
```
| 字段名称 | 字段说明 | 类型 | 备注 |
|------|-----------------------------------|--------|---- |
| command | 操作命令,callBack类型 | String | - |
| msgId | 消息ID，callBack 一律为0 | Int | - |
| data | 响应内容,详情参考[集成文档](https://raw.githubusercontent.com/MaaAssistantArknights/MaaAssistantArknights/master/docs/集成文档.md) | Json | - |
| 字段名称 | 字段说明 | 类型 | 备注 |
| -------- | ---------------------------------------------------------------------------------------------------------------------------------- | ------ | ---- |
| command | 操作命令,callBack类型 | String | - |
| msgId | 消息ID，callBack 一律为0 | Int | - |
| data | 响应内容,详情参考[集成文档](https://raw.githubusercontent.com/MaaAssistantArknights/MaaAssistantArknights/master/docs/集成文档.md) | Json | - |

2
src/MaaCore/README.md
View File

@@ -4,4 +4,4 @@ MAA 底层 C++ 模块
## 开发相关
[参与开发](../../README.md#参与开发)
[参与开发](../../README.md#参与开发)

2
src/MaaWpfGui/README.md
View File

@@ -1,5 +1,5 @@
# MaaWpfGui
使用 C# WPF 编写的界面模块
使用 C# WPF 编写的界面模块
非常感谢 [tcyh035](https://github.com/tcyh035)（[B 站@怒火的使徒](https://space.bilibili.com/7291855)）大佬帮忙设计重构界面！！！

351
src/Rust/Readme.md
View File

@@ -1,9 +1,14 @@
# maa的rust绑定，及http api
## rust绑定:
对unsafe ffi进行最基础的绑定，只依赖std
## http api
以下api调用方式均为http post
使用方式:将server程序放入maa文件夹内并运行server
#### 接口名称 获取版本号
###### 1) 请求地址
@@ -16,15 +21,17 @@
```json
{
"core": "2022-07-24-16-43-52-8218e7f",
"result": 0,
"server": "v0.0.1"
"core": "2022-07-24-16-43-52-8218e7f",
"result": 0,
"server": "v0.0.1"
}
```
| 字段名称 | 字段说明 | 类型 | 备注 |
|------|------------|--------|---- |
| core | maa本体版本号 | string | - |
| server | 本服务器版本号 | string | - |
| 字段名称 | 字段说明 | 类型 | 备注 |
| -------- | -------------- | ------ | ---- |
| core | maa本体版本号 | string | - |
| server | 本服务器版本号 | string | - |
#### 接口名称 创建maa实例
###### 1) 请求地址
@@ -37,14 +44,17 @@
```json
{
"id": 1,
"result": 0,
"id": 1,
"result": 0
}
```
| 字段名称 | 字段说明 | 类型 | 备注 |
|------|------------|--------|---- |
| id |实例的id| int | - |
| 字段名称 | 字段说明 | 类型 | 备注 |
| -------- | -------- | ---- | ---- |
| id | 实例的id | int | - |
---
#### 接口名称 删除maa实例
###### 1) 请求地址
@@ -52,22 +62,27 @@
> <http://127.0.0.1:11451/instance/delete>
###### 2) 请求参数:
```json
{
"id":1
"id": 1
}
```
| 字段名称 | 字段说明 | 类型 | 备注 |
|------|------------|--------|---- |
| id |实例的id| int | - |
| 字段名称 | 字段说明 | 类型 | 备注 |
| -------- | -------- | ---- | ---- |
| id | 实例的id | int | - |
###### 3) 返回结果示例
```json
{
"result": 0,
"result": 0
}
```
---
#### 接口名称 获取所有maa实例
###### 1) 请求地址
@@ -80,16 +95,17 @@
```json
{
"instances": [
1
],
"instances": [1],
"result": 0
}
```
| 字段名称 | 字段说明 | 类型 | 备注 |
|------|------------|--------|---- |
| instances |实例的id的列表| []int | - |
| 字段名称 | 字段说明 | 类型 | 备注 |
| --------- | -------------- | ----- | ---- |
| instances | 实例的id的列表 | []int | - |
---
#### 接口名称 连接模拟器
###### 1) 请求地址
@@ -97,20 +113,23 @@
> <http://127.0.0.1:11451/connect/attach>
###### 2) 请求参数:
```json
{
"id":1,
"adb_path":"adb.exe",
"target":"127.0.0.1:62025",
"config":null
"id": 1,
"adb_path": "adb.exe",
"target": "127.0.0.1:62025",
"config": null
}
```
| 字段名称 | 字段说明 | 类型 | 备注 |
|------|------------|--------|---- |
| id |实例的id| int | - |
| adb_path |adb的地址| string | - |
| target |连接的地址| string | - |
| config |设置| object | 具体参考maa abi文档 |
| 字段名称 | 字段说明 | 类型 | 备注 |
| -------- | ---------- | ------ | ------------------- |
| id | 实例的id | int | - |
| adb_path | adb的地址 | string | - |
| target | 连接的地址 | string | - |
| config | 设置 | object | 具体参考maa abi文档 |
###### 3) 返回结果示例
```json
@@ -118,7 +137,9 @@
"result": 0
}
```
---
#### 接口名称 获取实例连接的adb地址
###### 1) 请求地址
@@ -126,14 +147,17 @@
> <http://127.0.0.1:11451/connect/target>
###### 2) 请求参数:
```json
{
"id":1,
"id": 1
}
```
| 字段名称 | 字段说明 | 类型 | 备注 |
|------|------------|--------|---- |
| id |实例的id| int | - |
| 字段名称 | 字段说明 | 类型 | 备注 |
| -------- | -------- | ---- | ---- |
| id | 实例的id | int | - |
###### 3) 返回结果示例
```json
@@ -142,10 +166,13 @@
"target": "127.0.0.1:62025"
}
```
| 字段名称 | 字段说明 | 类型 | 备注 |
|------|------------|--------|---- |
| target |连接的地址| string | - |
| 字段名称 | 字段说明 | 类型 | 备注 |
| -------- | ---------- | ------ | ---- |
| target | 连接的地址 | string | - |
---
#### 接口名称 获取最近nums条回调消息
###### 1) 请求地址
@@ -153,16 +180,19 @@
> <http://127.0.0.1:11451/message/get>
###### 2) 请求参数:
```json
{
"uuid":"af01fba4f43da740\r\n",
"nums":5
"uuid": "af01fba4f43da740\r\n",
"nums": 5
}
```
| 字段名称 | 字段说明 | 类型 | 备注 |
|------|------------|--------|---- |
| uuid |设备的uuid| string | - |
| nums |消息条数| int or null | nums为null时，一次性返回所有消息 |
| 字段名称 | 字段说明 | 类型 | 备注 |
| -------- | ---------- | ----------- | -------------------------------- |
| uuid | 设备的uuid | string | - |
| nums | 消息条数 | int or null | nums为null时，一次性返回所有消息 |
###### 3) 返回结果示例
```json
@@ -171,28 +201,31 @@
{
"body": {
"details": {
"adb": "adb.exe",
"address": "127.0.0.1:62025",
"adb": "adb.exe",
"address": "127.0.0.1:62025",
"config": "General"
},
"uuid": "af01fba4f43da740",
"what": "Connected",
},
"uuid": "af01fba4f43da740",
"what": "Connected",
"why": ""
},
"time": 1658687213962,
},
"time": 1658687213962,
"type": 2
}
],
],
"result": 0
}
```
| 字段名称 | 字段说明 | 类型 | 备注 |
|------|------------|--------|---- |
| msgs |消息的列表| []object | - |
| msg.body |消息正文| object | 具体参考maa回调文档 |
| msg.time |时间戳| int | - |
| msg.type |消息类型| int | 具体参考maa回调文档 |
| 字段名称 | 字段说明 | 类型 | 备注 |
| -------- | ---------- | -------- | ------------------- |
| msgs | 消息的列表 | []object | - |
| msg.body | 消息正文 | object | 具体参考maa回调文档 |
| msg.time | 时间戳 | int | - |
| msg.type | 消息类型 | int | 具体参考maa回调文档 |
---
#### 接口名称 删除uuid对应的所有消息
###### 1) 请求地址
@@ -200,14 +233,17 @@
> <http://127.0.0.1:11451/message/drop>
###### 2) 请求参数:
```json
{
"uuid":"af01fba4f43da740\r\n",
"uuid": "af01fba4f43da740\r\n"
}
```
| 字段名称 | 字段说明 | 类型 | 备注 |
|------|------------|--------|---- |
| uuid |设备的uuid| string | - |
| 字段名称 | 字段说明 | 类型 | 备注 |
| -------- | ---------- | ------ | ---- |
| uuid | 设备的uuid | string | - |
###### 3) 返回结果示例
```json
@@ -215,7 +251,9 @@
"result": 0
}
```
---
#### 接口名称 获取数据库内所有uuid
###### 1) 请求地址
@@ -228,16 +266,17 @@
```json
{
"result": 0,
"uuid": [
"af01fba4f43da740"
]
"result": 0,
"uuid": ["af01fba4f43da740"]
}
```
| 字段名称 | 字段说明 | 类型 | 备注 |
|------|------------|--------|---- |
| uuid |uuid列表| []string | 即使uuid没有对应的实例，依旧会返回uuid |
| 字段名称 | 字段说明 | 类型 | 备注 |
| -------- | -------- | -------- | -------------------------------------- |
| uuid | uuid列表 | []string | 即使uuid没有对应的实例，依旧会返回uuid |
---
#### 接口名称 获取实例对应的uuid
###### 1) 请求地址
@@ -245,14 +284,17 @@
> <http://127.0.0.1:11451/uuid/get>
###### 2) 请求参数:
```json
{
"id":1
"id": 1
}
```
| 字段名称 | 字段说明 | 类型 | 备注 |
|------|------------|--------|---- |
| id |实例的id| int | - |
| 字段名称 | 字段说明 | 类型 | 备注 |
| -------- | -------- | ---- | ---- |
| id | 实例的id | int | - |
###### 3) 返回结果示例
```json
@@ -261,10 +303,13 @@
"uuid": "af01fba4f43da740\r\n"
}
```
| 字段名称 | 字段说明 | 类型 | 备注 |
|------|------------|--------|---- |
| uuid |设备的uuid| string | - |
| 字段名称 | 字段说明 | 类型 | 备注 |
| -------- | ---------- | ------ | ---- |
| uuid | 设备的uuid | string | - |
---
#### 接口名称 创建任务
###### 1) 请求地址
@@ -272,18 +317,21 @@
> <http://127.0.0.1:11451/task/create>
###### 2) 请求参数:
```json
{
"id":1,
"types":"StartUp",
"params":{}
"id": 1,
"types": "StartUp",
"params": {}
}
```
| 字段名称 | 字段说明 | 类型 | 备注 |
|------|------------|--------|---- |
| id |实例的id| int | - |
| types |任务类型| string | - |
| params |任务参数| object | 具体参考maa abi文档 |
| 字段名称 | 字段说明 | 类型 | 备注 |
| -------- | -------- | ------ | ------------------- |
| id | 实例的id | int | - |
| types | 任务类型 | string | - |
| params | 任务参数 | object | 具体参考maa abi文档 |
###### 3) 返回结果示例
```json
@@ -292,10 +340,13 @@
"task_id": 1
}
```
| 字段名称 | 字段说明 | 类型 | 备注 |
|------|------------|--------|---- |
| task_id |任务的id| int | - |
| 字段名称 | 字段说明 | 类型 | 备注 |
| -------- | -------- | ---- | ---- |
| task_id | 任务的id | int | - |
---
#### 接口名称 设置任务参数
###### 1) 请求地址
@@ -303,26 +354,31 @@
> <http://127.0.0.1:11451/task/set>
###### 2) 请求参数:
```json
{
"id":1,
"task_id":1,
"params":{}
"id": 1,
"task_id": 1,
"params": {}
}
```
| 字段名称 | 字段说明 | 类型 | 备注 |
|------|------------|--------|---- |
| id |实例的id| int | - |
| task_id |任务的id| int | - |
| params |任务参数| object | 具体参考maa abi文档 |
| 字段名称 | 字段说明 | 类型 | 备注 |
| -------- | -------- | ------ | ------------------- |
| id | 实例的id | int | - |
| task_id | 任务的id | int | - |
| params | 任务参数 | object | 具体参考maa abi文档 |
###### 3) 返回结果示例
```json
{
"result": 0,
"result": 0
}
```
---
#### 接口名称 获取当前任务队列
###### 1) 请求地址
@@ -330,31 +386,37 @@
> <http://127.0.0.1:11451/task/all>
###### 2) 请求参数:
```json
{
"id":1,
"id": 1
}
```
| 字段名称 | 字段说明 | 类型 | 备注 |
|------|------------|--------|---- |
| id |实例的id| int | - |
| 字段名称 | 字段说明 | 类型 | 备注 |
| -------- | -------- | ---- | ---- |
| id | 实例的id | int | - |
###### 3) 返回结果示例
```json
{
"result": 0,
"result": 0,
"tasks": {
"1": {
"params": "{}",
"params": "{}",
"type": "StartUp"
}
}
}
```
| 字段名称 | 字段说明 | 类型 | 备注 |
|------|------------|--------|---- |
| tasks |任务队列| []object | tasks字段内的键值对，键为task_id，不一定从1开始 |
| 字段名称 | 字段说明 | 类型 | 备注 |
| -------- | -------- | -------- | ----------------------------------------------- |
| tasks | 任务队列 | []object | tasks字段内的键值对，键为task_id，不一定从1开始 |
---
#### 接口名称 开始运行
###### 1) 请求地址
@@ -362,22 +424,27 @@
> <http://127.0.0.1:11451/run/start>
###### 2) 请求参数:
```json
{
"id":1,
"id": 1
}
```
| 字段名称 | 字段说明 | 类型 | 备注 |
|------|------------|--------|---- |
| id |实例的id| int | - |
| 字段名称 | 字段说明 | 类型 | 备注 |
| -------- | -------- | ---- | ---- |
| id | 实例的id | int | - |
###### 3) 返回结果示例
```json
{
"result": 0,
"result": 0
}
```
---
#### 接口名称 中止运行
###### 1) 请求地址
@@ -385,22 +452,27 @@
> <http://127.0.0.1:11451/run/stop>
###### 2) 请求参数:
```json
{
"id":1,
"id": 1
}
```
| 字段名称 | 字段说明 | 类型 | 备注 |
|------|------------|--------|---- |
| id |实例的id| int | - |
| 字段名称 | 字段说明 | 类型 | 备注 |
| -------- | -------- | ---- | ---- |
| id | 实例的id | int | - |
###### 3) 返回结果示例
```json
{
"result": 0,
"result": 0
}
```
---
#### 接口名称 获取安卓截图
###### 1) 请求地址
@@ -408,19 +480,25 @@
> <http://127.0.0.1:11451/device/screenshot>
###### 2) 请求参数:
```json
{
"id":1,
"id": 1
}
```
| 字段名称 | 字段说明 | 类型 | 备注 |
|------|------------|--------|---- |
| id |实例的id| int | - |
| 字段名称 | 字段说明 | 类型 | 备注 |
| -------- | -------- | ---- | ---- |
| id | 实例的id | int | - |
###### 3) 返回结果示例
| 字段名称 | 字段说明 | 类型 | 备注 |
|------|------------|--------|---- |
| 无 |无| 一张截图(png格式) | 建议自己想象一个 |
| 字段名称 | 字段说明 | 类型 | 备注 |
| -------- | -------- | ----------------- | ---------------- |
| 无 | 无 | 一张截图(png格式) | 建议自己想象一个 |
---
#### 接口名称 点击安卓屏幕
###### 1) 请求地址
@@ -428,22 +506,27 @@
> <http://127.0.0.1:11451/device/click>
###### 2) 请求参数:
```json
{
"id":1,
"x":114,
"y":514
"id": 1,
"x": 114,
"y": 514
}
```
| 字段名称 | 字段说明 | 类型 | 备注 |
|------|------------|--------|---- |
| id |实例的id| int | - |
| x |横坐标| int | 坐标原点在屏幕左上角 |
| y |纵坐标| int | - |
| 字段名称 | 字段说明 | 类型 | 备注 |
| -------- | -------- | ---- | -------------------- |
| id | 实例的id | int | - |
| x | 横坐标 | int | 坐标原点在屏幕左上角 |
| y | 纵坐标 | int | - |
###### 3) 返回结果示例
```json
{
"result": 0,
}
"result": 0
}
```
---

3
src/Woolang/README.md
View File

@@ -33,6 +33,3 @@ woodriver demo.wo
```
运行示例项目。

10
tools/AutoLocalization/README.md
View File

@@ -23,16 +23,16 @@ options:
-h, --help show this help message and exit
positional arguments:
{init,create,update}
init 初始化工具
create 初始化其他语言的文档
-f, --force 强制覆盖已有的部分
-t, --test 跳过chatgpt翻译进行测试
-l, --language 指定语言，可选参数：en-us, zh-tw, ja-jp, ko-kr
update 更新本地化翻译
-t, --test 跳过chatgpt翻译进行测试
-l, --language 指定语言，可选参数：en-us, zh-tw, ja-jp, ko-kr
@@ -67,7 +67,7 @@ Enjoy!
check duplicate Key()
if exist duplicate Key:
throw (or raise) an exception
zh-cn -> zh-tw
if exist en-us:
en-us -> ja-jp

6
tools/MaaBuilder/README.md
View File

@@ -8,7 +8,7 @@ Maa 的构建工具
在解决方案根目录执行：
``` sh
```sh
# PowerShell
./build.ps1 --target <TARGET>
# Command Prompt
@@ -28,7 +28,7 @@ Maa 的构建工具
关于 Target 之间的流程联系，请在安装 `Nuke.GlobalTool` 后再 Repo 的任意位置执行
``` sh
```sh
nuke --plan
```
@@ -36,7 +36,7 @@ nuke --plan
[可选] 安装 `Nuke.GlobalTool`
``` sh
```sh
dotnet tool install Nuke.GlobalTool --global
```