From 3ab93277a0600a203498210b8fd4eac654fd7c29 Mon Sep 17 00:00:00 2001 From: uye <2396806385@qq.com> Date: Sun, 12 Feb 2023 20:32:01 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E6=9B=B4=E6=96=B0=E6=96=87=E6=A1=A3=20?= =?UTF-8?q?23/02/12?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/1.3-模拟器支持.md | 4 ++-- docs/2.1-Linux编译教程.md | 2 +- docs/2.5-外服适配教程.md | 4 ++-- docs/en-us/2.1-LINUX_TUTORIAL.md | 6 +++--- docs/en-us/2.5-Overseas Clients Adaptation.md | 2 +- docs/en-us/3.3-COPILOT_SCHEMA.md | 2 +- docs/ja-jp/2.5-Overseas Clients Adaptation.md | 2 +- docs/ja-jp/3.3-自動作戦API.md | 2 +- docs/zh-tw/2.1-Linux編譯教程.md | 8 ++++---- docs/zh-tw/2.5-外服適配教程.md | 2 +- docs/zh-tw/3.3-戰鬥流程協定.md | 2 +- 11 files changed, 18 insertions(+), 18 deletions(-) diff --git a/docs/1.3-模拟器支持.md b/docs/1.3-模拟器支持.md index 745f741016..39e24fc8fa 100644 --- a/docs/1.3-模拟器支持.md +++ b/docs/1.3-模拟器支持.md @@ -30,8 +30,8 @@ 4. 开启 MAA，LinkStart！ -- 如果你还需要多开或者你使用蓝叠 Pie 核心 Hyper-V 模拟器（不使用多开请忽略这步），可以再修改 MAA 检测配置文件的关键字。 - 参照上述步骤，添加 `Bluestacks.Config.Keyword` 字段 +- 如果你还需要多开或者你使用蓝叠 Pie 核心 Hyper-V 模拟器，可以再修改 MAA 检测配置文件的关键字。 + 参照上述步骤，添加 `Bluestacks.Config.Keyword` 字段，内容为`"bst.instance.模拟器编号.status.adb_port"`，模拟器编号可在模拟器路径的`BlueStacks_nxt\Engine`中看到。 示例： ```jsonc diff --git a/docs/2.1-Linux编译教程.md b/docs/2.1-Linux编译教程.md index d679b8a3ff..3b99923ef6 100644 --- a/docs/2.1-Linux编译教程.md +++ b/docs/2.1-Linux编译教程.md @@ -109,7 +109,7 @@ cmake --build build ## 集成文档 -[~~或许算不上文档~~](3.1-%E9%9B%86%E6%88%90%E6%96%87%E6%A1%A3.md) +[~~或许算不上文档~~](3.1-集成文档.md) ### Python diff --git a/docs/2.5-外服适配教程.md b/docs/2.5-外服适配教程.md index af72416429..4840f48714 100644 --- a/docs/2.5-外服适配教程.md +++ b/docs/2.5-外服适配教程.md @@ -5,7 +5,7 @@ 在开始这个教程之前，请确保你已经： 1. 安装并正确配置了所需软件。在国服或相应客户端的 `readme.md` 中应该会有相关信息，确保所支持的功能可以正常运行。 -2. 阅读了 `MaaAssistantArknights/docs/3.4-任务流程协议.md`，对各个字段的含义和用法有基本了解，并能理解 `@`、`#` 类型任务的含义和用法。 +2. 阅读了 `3.4-任务流程协议.md`，对各个字段的含义和用法有基本了解，并能理解 `@`、`#` 类型任务的含义和用法。 3. 了解外服的 `task.json` 和模板图片中未提及的和缺少的内容会使用国服的 `task.json` 和模板图片等内容作为备选。外服的 `task.json` 中的内容会覆盖并重写国服对应任务的相应字段。 4. 具备一定的英语能力，能够阅读英文日志，并能通过日志找出缺失的图片等信息。 5. 推建议按照任务链进行修改。例如，对于 `Award` 任务，根据国服 `task.json` 中 `Award` 任务的 `next` 顺序逐步替换 `模板图片` / `文本` / `修改 roi`，以确保修改后的每一步都能正常运行，或者能够迅速发现错误。这样可以避免因为一次修改修改了太多内容而不清楚程序因为哪一步卡住而不能运行。 @@ -135,4 +135,4 @@ amplified roi: 426, 272, 177, 201 ## 提交你的修改 -请参考 [Github Pull Requst 指南](2.2-%E5%BC%80%E5%8F%91%E7%9B%B8%E5%85%B3.md) +请参考 [Github Pull Requst 指南](2.2-开发相关.md) diff --git a/docs/en-us/2.1-LINUX_TUTORIAL.md b/docs/en-us/2.1-LINUX_TUTORIAL.md index e2b2f20107..b07db10ffd 100644 --- a/docs/en-us/2.1-LINUX_TUTORIAL.md +++ b/docs/en-us/2.1-LINUX_TUTORIAL.md @@ -113,12 +113,12 @@ Dependencies might depends on compilation argument of `opencv` and `fastdeploy`, ### Python -Refer to the implementation of `__main__` in [Python demo](../src/Python/sample.py) +Refer to the implementation of `__main__` in [Python demo](../../src/Python/sample.py) ### C -Refer to the implementation of [CppSample](../src/CppSample/main.cpp) +Refer to the implementation of [CppSample](../../src/CppSample/main.cpp) ### C sharp -Refer to the implementation of [MaaWpfGui](../src/MaaWpfGui/Helper/AsstProxy.cs) +Refer to the implementation of [MaaWpfGui](../../src/MaaWpfGui/Helper/AsstProxy.cs) diff --git a/docs/en-us/2.5-Overseas Clients Adaptation.md b/docs/en-us/2.5-Overseas Clients Adaptation.md index 41507061fd..a61e55214e 100644 --- a/docs/en-us/2.5-Overseas Clients Adaptation.md +++ b/docs/en-us/2.5-Overseas Clients Adaptation.md @@ -5,7 +5,7 @@ Before starting this tutorial, make sure you have: 1. Installed and properly configured the required software. There should be information in the `readme.md` of the ZH-CN client or the corresponding client to ensure that the supported features work properly. -2. Read `MaaAssistantArknights/docs/3.4-TASK_SCHEMA.md` and have a basic understanding of the meaning and usage of each field. You should also understand the meaning and usage of `@` and `#` in the code. +2. Read `3.4-TASK_SCHEMA.md` and have a basic understanding of the meaning and usage of each field. You should also understand the meaning and usage of `@` and `#` in the code. 3. Understand that the `task.json` file and template image of the ZH-CN client will be used as alternatives when they are unmentioned or missing for the overseas client. The content in the `task.json` for the overseas client should be rewritten according to the fields of the ZH-CN task. 4. Have some English ability, be able to read English logs, and be able to find missing pictures and other information through the logs. 5. Understand that it is recommended to perform the modification individually according to the task chain. For example, to modify the Award task, you should modify the `template image`, `text`, and `roi` step by step in accordance with the order in its `next` field. This will ensure that every task is working normally after modification and errors can be easily spotted. Additionally, this can prevent confusion and forgetting which task the software is stuck on when too much content is modified at once. diff --git a/docs/en-us/3.3-COPILOT_SCHEMA.md b/docs/en-us/3.3-COPILOT_SCHEMA.md index 23ac6206ca..1bf2dbe97a 100644 --- a/docs/en-us/3.3-COPILOT_SCHEMA.md +++ b/docs/en-us/3.3-COPILOT_SCHEMA.md @@ -136,4 +136,4 @@ Usage of `resource/copilot/*.json` and field description. ## Example -[OF-1](../resource/copilot/OF-1_credit_fight.json) +[OF-1](../../resource/copilot/OF-1_credit_fight.json) diff --git a/docs/ja-jp/2.5-Overseas Clients Adaptation.md b/docs/ja-jp/2.5-Overseas Clients Adaptation.md index 41507061fd..a61e55214e 100644 --- a/docs/ja-jp/2.5-Overseas Clients Adaptation.md +++ b/docs/ja-jp/2.5-Overseas Clients Adaptation.md @@ -5,7 +5,7 @@ Before starting this tutorial, make sure you have: 1. Installed and properly configured the required software. There should be information in the `readme.md` of the ZH-CN client or the corresponding client to ensure that the supported features work properly. -2. Read `MaaAssistantArknights/docs/3.4-TASK_SCHEMA.md` and have a basic understanding of the meaning and usage of each field. You should also understand the meaning and usage of `@` and `#` in the code. +2. Read `3.4-TASK_SCHEMA.md` and have a basic understanding of the meaning and usage of each field. You should also understand the meaning and usage of `@` and `#` in the code. 3. Understand that the `task.json` file and template image of the ZH-CN client will be used as alternatives when they are unmentioned or missing for the overseas client. The content in the `task.json` for the overseas client should be rewritten according to the fields of the ZH-CN task. 4. Have some English ability, be able to read English logs, and be able to find missing pictures and other information through the logs. 5. Understand that it is recommended to perform the modification individually according to the task chain. For example, to modify the Award task, you should modify the `template image`, `text`, and `roi` step by step in accordance with the order in its `next` field. This will ensure that every task is working normally after modification and errors can be easily spotted. Additionally, this can prevent confusion and forgetting which task the software is stuck on when too much content is modified at once. diff --git a/docs/ja-jp/3.3-自動作戦API.md b/docs/ja-jp/3.3-自動作戦API.md index 69490b73c4..7c10bc61e8 100644 --- a/docs/ja-jp/3.3-自動作戦API.md +++ b/docs/ja-jp/3.3-自動作戦API.md @@ -132,4 +132,4 @@ ## 実例 -[OF-1](../resource/copilot/OF-1_credit_fight.json) +[OF-1](../../resource/copilot/OF-1_credit_fight.json) diff --git a/docs/zh-tw/2.1-Linux編譯教程.md b/docs/zh-tw/2.1-Linux編譯教程.md index 69dee4f8a9..c284cb5ac7 100644 --- a/docs/zh-tw/2.1-Linux編譯教程.md +++ b/docs/zh-tw/2.1-Linux編譯教程.md @@ -39,7 +39,7 @@ sudo ldconfig sh ./update_resource.sh ``` -5. 透過 [Python 介面](../src/Python/asst.py) 或 [C 介面](../include/AsstCaller.h) 進行呼叫，需要自行編寫少量的程式碼 +5. 透過 [Python 介面](../../src/Python/asst.py) 或 [C 介面](../../include/AsstCaller.h) 進行呼叫，需要自行編寫少量的程式碼 6. `cmake` 可透過添加 `-DBUILD_TEST=ON` 選項來編譯一個測試小 demo ## 集成文件 @@ -48,12 +48,12 @@ sudo ldconfig ### Python -可參考 [Python demo](../src/Python/sample.py) 中 `__main__` 的實現 +可參考 [Python demo](../../src/Python/sample.py) 中 `__main__` 的實現 ### C -可參考 [CppSample](../src/CppSample/main.cpp) 中的實現 +可參考 [CppSample](../../src/CppSample/main.cpp) 中的實現 ### C sharp -可參考 [MaaWpfGui](../src/MaaWpfGui/Helper/AsstProxy.cs) 中的實現 +可參考 [MaaWpfGui](../../src/MaaWpfGui/Helper/AsstProxy.cs) 中的實現 diff --git a/docs/zh-tw/2.5-外服適配教程.md b/docs/zh-tw/2.5-外服適配教程.md index 128fc8b93d..8504d6bf4f 100644 --- a/docs/zh-tw/2.5-外服適配教程.md +++ b/docs/zh-tw/2.5-外服適配教程.md @@ -5,7 +5,7 @@ 在開始這個教程之前，請確保你已經： 1. 安裝並正確配置了所需軟體。在國服或相應客戶端的 `readme.md` 中應該會有相關資訊，確保所支持的功能可以正常運行。 -2. 閱讀了 `MaaAssistantArknights/docs/3.4-任務流程協議.md`，對各個字段的含義和用法有基本瞭解，並能理解 `@`、`#` 類型任務的含義和用法。 +2. 閱讀了 `3.4-任務流程協議.md`，對各個字段的含義和用法有基本瞭解，並能理解 `@`、`#` 類型任務的含義和用法。 3. 瞭解外服的 `task.json` 和範本圖片中未提及的和缺少的內容會使用國服的 `task.json` 和範本圖片等內容作為備選。外服的 `task.json` 中的內容會覆蓋並重寫國服對應任務的相應字段。 4. 具備一定的英語能力，能夠閱讀英文日誌，並能通過日誌找出缺失的圖片等資訊。 5. 推建議按照任務鏈進行修改。例如，對於 `Award` 任務，根據國服 `task.json` 中 `Award` 任務的 `next` 順序逐步替換 `範本圖片` / `文本` / `修改 roi`，以確保修改後的每一步都能正常運行，或者能夠迅速發現錯誤。這樣可以避免因為一次修改修改了太多內容而不清楚程式因為哪一步卡住而不能運行。 diff --git a/docs/zh-tw/3.3-戰鬥流程協定.md b/docs/zh-tw/3.3-戰鬥流程協定.md index c8ec72b5e7..9a1bf6b678 100644 --- a/docs/zh-tw/3.3-戰鬥流程協定.md +++ b/docs/zh-tw/3.3-戰鬥流程協定.md @@ -132,4 +132,4 @@ ## 舉例 -[OF-1](../resource/copilot/OF-1_credit_fight.json) +[OF-1](../../resource/copilot/OF-1_credit_fight.json)