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

docs: 同步en-us文档

Browse Source
This commit is contained in:
Helloworld
2022-09-09 15:24:37 +08:00
parent 05564b6efd
commit 25becb6a6d
8 changed files with 133 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/en-us/1.1-USER_MANUAL.md
View File

@@ -66,7 +66,7 @@ Welcome to QQ Group: 912322156
#### Create Tasks
- A tool for creating tasks is provided in the directory of EXE file. See also: [copilot schema documenatation](3.3-COPILOT_SCHEMA.md) for help.
- A tool for creating tasks is provided in the directory of EXE file. See also: [Copilot Schema](3.3-COPILOT_SCHEMA.md) for help.
- How to get map coordinates: start an operation after filling in `stage_name`. A file named `map.png` will be generated for your reference. Features like displaying map on the creator tool will be supported in future.
- Drill plan is recommended for testing.
- If the name of operator is not recognized correctly, check the log `asst.log` to see what is the recognition result, and edit `resource/tasks.json` - `CharsNameOcrReplace` to replace it.

9
docs/en-us/1.2-FAQ.md
View File

@@ -64,3 +64,12 @@ Tip 2: Follow the steps below until the problem is solved.
- Download [adb](https://dl.google.com/android/repository/platform-tools-latest-windows.zip) and unzip it.
- Go to `Settings` - `Connection Settings`, and select the location of `adb.exe`, fill in the address of ADB (with the format of IP+port, e.g. `127.0.0.1:5555`), and choose the type of your emulator.
## The download speed is slow and the mirror site is not accessible
1. Go to [Download](../../README.md#Download) to get the link (non-mirror) to you want to download.
2. Find the link to your file you need to download.
3. Right click it and select `Copy link address`.
4. Paste the link into your browser.
5. Replace the `github.com` in the link with `download.fastgit.org`.
6. Press `Enter` to download.

16
docs/en-us/1.3-EMULATOR_SUPPORTS.md
View File

@@ -104,12 +104,28 @@ You may need to change the resolution manually since MAA supports only `16:9` re
adb devices # Checks the connection status of the current device, with the first column to be the device ID
```
After successful connection, you will see the following messages:
```bash
C:\Users\username>adb devices
List of devices attached
VFNDU1682100xxxx device # The data before "device" is the device ID
```
- If you are using remote ADB connection: go to `Settings -> WLAN -> View` to find the corresponding IP address, and the port will usually be 5555 or 5037.
```bash
adb connect <IP Address + Port> # E.g. 192.168.0.10:5555
```
- If it prompts `'adb' is not recognized as an internal or external command`, it is because the environment variable is not configured correctly. You need to give the full path of ADB to run it. For example:
```bash
D:\adb_unzip_path\adb.exe devices # Or you can simply drag the adb.exe to CMD window and type [SPACE] devices
```
It is suggested that you configure the environment variable for ADB if you need to run it frequently. Please refer to the articles on the Internet about how to configure it for help.
3. Enter the command prompt to proceed
```bash

18
docs/en-us/2.2-CONTRIBUTING.md → docs/en-us/2.2-DEVELOPMENT.md
View File

@@ -1,4 +1,6 @@
# Contributing to MaaAssistantArknights
# Development
## Introduction to GitHub pull request flow
1. If you have forked this repository before, please go to `Settings`, scroll down to the bottom, and click `Delete Repository`.
2. Go to [MAA main repository](https://github.com/MaaAssistantArknights/MaaAssistantArknights) and click `Fork`, then `Create fork`.
@@ -45,3 +47,17 @@
4. Repeat step 7-10.
Note: operations regarding Git can be done by VS2022 instead of command line tools, using the Git changes tab.
## Enable clang-format in Visual Studio
1. Download [clang-format.zip](https://github.com/MaaAssistantArknights/MaaAssistantArknights/files/9482197/clang-format.zip) or compile [zzyyyl/llvm-project](https://github.com/zzyyyl/llvm-project/tree/fix/clang-format). You will get a `clang-format.exe`.
2. Search `clang-format` in `Tools`-`Options`.
3. Click `Enable ClangFormat` and select `Use custom clang-format.exe file` to use the `clang-format.exe` you have got in Step 1.
![Enable clang-format in Visual Studio](https://user-images.githubusercontent.com/74587068/188262146-bf36f10a-db94-4a3c-9802-88b703342fb6.png)
You are all set with the clang-format integrated in Visual Studio supporting c++20 features!
You can also format with `tools\ClangFormatter\clang-formatter.py` directly, by executing in the root folder of the project:
- `python tools\ClangFormatter\clang-formatter.py --clang-format=PATH\TO\YOUR\clang-format.exe --input=src\MeoAssistant`

69
docs/en-us/2.3-ISSUE_BOT_USAGE.md Normal file
View File

@@ -0,0 +1,69 @@
# How to use Issue Bot
The action of Issue Bot is [issue-checker](https://github.com/zzyyyl/issue-checker), with configuration file [issue-checker.yml](.github/issue-checker.yml).
**Note that your merge request will be marked as `ambiguous` when you are not committing with Commitizen specification.**
## Features
### Auto Notification
- Adds comments to notify users that the files of their issues are not uploaded successfully.
- Adds tags to issues and pull requests, e.g., `module`, `Client`, `ambiguous`, `translation required`, etc.
Issue Bot will add categories based on keywords. You can modify tags manually as well.
Please refer to the [configuration file](.github/issue-checker.yml) for the keywords.
- Adds `MAA Team` tag for MAA team members with public visibility.
#### Pull Request
Issue Bot will check the title of your pull request. Unless the title starts with one of the following keywords, the pull request will be marked as `ambiguous`.
- `build` `chore` `ci` `doc` `docs` `feat` `fix` `perf` `refactor` `rfc` `style` `test`
- `Merge` `merge` `Revert` `revert`
### Triggering Manually
It is better to trigger Issue Bot with keywords instead of commands listed below, unless that **you are aware that your action may confuse Issue Bot**.
Try not to add or delete category tags manually because they may be removed after changes are made.
#### Issues and Their Comments
When adding/modifying an issue:
- `Add {LABEL_NAME}` will add a new label.
- `Remove {LABEL_NAME}` will delete a label.
- `Remove labels` will delete all labels.
When adding/modifying a comment:
- `Add ambiguous` will keep the `ambiguous` label, but will not add it if it is not present.
- `Remove {LABEL_NAME}` will make sure no labels of the specified type are added.<sup>1</sup>
- `Remove labels` will make sure no labels are added.<sup>1</sup>
- To add `fixed` tags, you can use any of the commands below:<sup>2</sup>
- `https://github.com/MaaAssistantArknights/MaaAssistantArknights/commit/{COMMIT_HASH} fixed`
- `fixed by https://github.com/MaaAssistantArknights/MaaAssistantArknights/commit/{COMMIT_HASH}`
- `{VERSION} fixed`
- `fixed by {VERSION}`
- `Duplicate of #{ISSUE_NUMBER}` will add `duplicate` tag to the issue.
- **You can add some `remove` operations if your comment may confuse Issue Bot.**
_Note<sup>1</sup>: `Remove ambiguous` and `Remove labels` will delete `ambiguous` tag._
_Note<sup>2</sup>: The `COMMIT_HASH` here is the full 40-character hash._
#### Pull Requests and Their Comments
Similar to [#Issues and Their Comments](#issues-and-their-comments). Furthermore:
- `Release {VERSION}` will add `release` tag.
- `fixed`, `duplicated` will **NOT** be auto-added.
#### Push
For any commit in a push:
- `fixed` tag will be added if the commit message contains one of the following:
- `fix #{ISSUE_NUMBER}`
- `close #{ISSUE_NUMBER}`
- `fix https://github.com/MaaAssistantArknights/MaaAssistantArknights/issues/{ISSUE_NUMBER}`
- `close https://github.com/MaaAssistantArknights/MaaAssistantArknights/issues/{ISSUE_NUMBER}`

7
docs/en-us/3.1-INTEGRATION.md
View File

@@ -52,6 +52,8 @@ Appends a task.
{
"enable": bool, // Whether to enable this task, optional, true by default
"stage": string, // Stage name, optional, by default crrent / last stage. Editing in run-time is not supported.
// Supports all mainline stages, such as "1-7", "S3-2", etc.
// Supports some of the special stages, such as "CE-6", etc. (Please refer to C# integration example.)
"medicine": int, // Maximum number Sanity Potion used, optional, by default 0
"stone": int, // Maximum number of Originite Prime used, optional, by default 0
"times": int, // Maximum times, optional, by default infinite
@@ -178,8 +180,11 @@ Appends a task.
"starts_count": int, // Number of starts, optional, by default INT_MAX
"investments_count": int,
// Number of investments, optional, by default INT_MAX
"stop_when_investment_full": bool
"stop_when_investment_full": bool,
// Stop the task when investment is full, optional, by default false
"squad": string, // Squad name like "assault squad", optional, by default "Default Squad"
"roles": string, // Roles, optional
"core_char": string // Operator name, optional. Will recognize auto-selection of levels.
}
```

9
docs/en-us/3.2-CALLBACK_SCHEMA.md
View File

@@ -494,7 +494,16 @@ Todo
"@type": "@penguin-statistics/depot"
},
"data": "{\"@type\":\"@penguin-statistics/depot\",\"items\":[{\"id\":\"2004\",\"have\":4,\"name\":\"高级作战记录\"},{\"id\":\"mod_unlock_token\",\"have\":25,\"name\":\"模组数据块\"},{\"id\":\"2003\",\"have\":20,\"name\":\"中级作战记录\"}]}"
},
"lolicon": { // https://arkn.lolicon.app/#/material
"object": {
"2004" : 4,
"mod_unlock_token": 25,
"2003": 20
},
"data": "{\"2003\":20,\"2004\": 4,\"mod_unlock_token\": 25}"
}
// Only ArkPlanner and Lolicon formats are supported. More websites will be supported in future.
```
- `UnsupportedLevel`

8
docs/en-us/3.3-COPILOT_SCHEMA.md
View File

@@ -51,21 +51,25 @@ Usage of `resource/copilot/*.json` and field description.
"actions": [ // Actions in order, required. Will be executed sequentially
{
"type": "部署", // Action type, optional, "Deploy" by default
// "Deploy" | "Skill" | "Retreat" | "SpeedUp" | "BulletTime" | "SkillUsage" | "Ouput" | "SkillDaemon"
// "Deploy" | "Skill" | "Retreat" | "SpeedUp" | "BulletTime" | "SkillUsage" | "Output" | "SkillDaemon"
// "部署" | "技能" | "撤退" | "二倍速" | "子弹时间" | "技能用法" | "打印" | "摆完挂机"
// Both English and Chinese are supported
// "Deploy" will wait until the cost is enough (unless timeout)
// "Skill" will wait until the skill is ready (unless timeout)
// "SpeedUp" is switchable, i.e. after using it will become 2x speed, and using it again will make it back to normal speed
// "BulletTime", Reserved field, not implemented, it is the 1/5 speed after clicking any operator. Proceeding with any other action will make it back to normal speed
// "Ouput" (Output) will print out the content of the doc (for subtities, etc.)
// "Output" will print out the content of the doc (for subtities, etc.)
// "SkillDaemon" will cast skills when they are ready, and do nothing else until the end
// The relationship between the following three fields is AND, i.e. &&
"kills": 0, // Waiting until the number of kills required is reached, optional, 0 by default
"cost_changes": 5, // Waiting until the cost changes for the amount specified, optional, 0 by default
// Note that it calculates since the action starts (based on the cost of the previous action)
// Recognition is accurate when the cost is 2 digits. Not recommended for 3-digit costs.
"cooling": 2, // Waiting until the number of operators in CD reaches the number, optional, -1 by default for "ignore".
// TODO: Other conditions
// TODO: "condition_type": 0, // Condition aggregation type, optional, 0 by default
// // 0 - AND； 1 - OR