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

feat(docs): 文档大升级 (#5885)

Browse Source 
+ 迁移到[vuepress-hope](https://theme-hope.vuejs.press/zh/)主题
该主题有很多好用的特性，包括但不限于mermaid流程图，charts/echarts图表，更美观的提示卡片等
  + 优化的侧边栏和导航栏
  + 内置图标支持
  + 使用卡片来优化阅读体验
+ 修复了jsonc和cpp的高亮问题
This commit is contained in:
Sherkey
2023-08-10 09:53:28 +08:00
committed by GitHub
parent edb7224594
commit 902bcc4a6e
69 changed files with 13690 additions and 3325 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -20,7 +20,7 @@ Compatible.
3. **Exit** MAA, **then** open the `gui.json`, and add a new field `Bluestacks.Config.Path`, with the value of the full path of `bluestacks.conf` (backslashes should be escaped like `\\`).
For example: (suppose the file is at `C:\ProgramData\BlueStacks_nxt\bluestacks.conf`)
```jsonc
```json
{
"Configurations": {
"Default": {
@@ -37,7 +37,7 @@ Compatible.
Add field `Bluestacks.Config.Keyword` following the steps above
Example:
```jsonc
```json
"Bluestacks.Config.Keyword":"bst.instance.Nougat64.status.adb_port",
```

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

@@ -6,7 +6,7 @@
#### Prototype
```c++
```cpp
TaskId ASSTAPI AsstAppendTask(AsstHandle handle, const char* type, const char* params);
```
@@ -34,7 +34,7 @@ Appends a task.
- `StartUp`<br>
Start-up
```jsonc
```json
// Corresponding task parameters
{
"enable": bool, // Whether to enable this task, optional, true by default
@@ -47,7 +47,7 @@ Appends a task.
- `CloseDown`<br>
Close Game Client<br>
```jsonc
```json
// Corresponding task parameters
{
"enable": bool, // Whether to enable this task, optional, true by default
@@ -57,7 +57,7 @@ Appends a task.
- `Fight`<br>
Operation
```jsonc
```json
// Corresponding task parameters
{
"enable": bool, // Whether to enable this task, optional, true by default
@@ -89,7 +89,7 @@ Appends a task.
- `Recruit`<br>
Recruitment
```jsonc
```json
// Corresponding task parameters
{
"enable": bool, // Whether to enable this task, optional, by default true
@@ -124,7 +124,7 @@ Appends a task.
- `Infrast`<br>
Infrastructure shifting
```jsonc
```json
{
"enable": bool, // Whether to enable this task, optional, by default true
"mode": int, // Shift mode, optional. Editing in run-time is not supported.
@@ -151,7 +151,7 @@ Appends a task.
Collecting Credits and auto-purchasing
Will buy items in order following `buy_first` list, buy other items from left to right ignoring items in `blacklist`, and buy other items from left to right ignoring the `blacklist` while credit overflows.
```jsonc
```json
// Corresponding task parameters
{
"enable": bool, // Whether to enable this task, optional, by default true
@@ -171,7 +171,7 @@ Appends a task.
- `Award`<br>
Collecting daily awards.<br>
```jsonc
```json
// Corresponding task parameters
{
"enable": bool // Whether to enable this task, optional, by default true
@@ -181,7 +181,7 @@ Appends a task.
- `Roguelike`<br>
Integrated Strategies
```jsonc
```json
{
"enable": bool, // Whether to enable this task, optional, by default true
"theme": string, // Name of the theme, optional, by default "Phantom"
@@ -211,7 +211,7 @@ Appends a task.
- `Copilot`<br>
Copilot auto-combat feature
```jsonc
```json
{
"enable": bool, // Whether to enable this task, optional, by default true
"filename": string, // Filename and path of the task JSON, supporting absolute/relative paths. Editing in run-time is not supported.
@@ -224,7 +224,7 @@ For more details about auto-copilot JSON, please refer to [Copilot Schema](3.3-C
- `SSSCopilot`<br>
Copilot auto-combat feature for STATIONARY SECURITY SERVICE
```jsonc
```json
{
"enable": bool, // Whether to enable this task, optional, by default true
"filename": string, // Filename and path of the task JSON, supporting absolute/relative paths. Editing in run-time is not supported.
@@ -237,7 +237,7 @@ For more details about auto-copilot JSON, please refer to [Copilot Schema](3.7-S
- `Depot`
Depot recognition
```jsonc
```json
// Corresponding task parameters
{
"enable": bool // Whether to enable this task, optional, by default true
@@ -247,7 +247,7 @@ For more details about auto-copilot JSON, please refer to [Copilot Schema](3.7-S
- `OperBox`<br>
Operator box recognition
```jsonc
```json
// Corresponding task parameters
{
"enable": bool // Whether to enable this task, optional, by default true
@@ -257,7 +257,7 @@ For more details about auto-copilot JSON, please refer to [Copilot Schema](3.7-S
- `ReclamationAlgorithm`<br>
ReclamationAlgorithm ( A new mode in CN client)
```jsonc
```json
{
"enable": bool,
"mode": int // Mode, optional, by default 0
@@ -270,7 +270,7 @@ For more details about auto-copilot JSON, please refer to [Copilot Schema](3.7-S
Custom Task
```jsonc
```json
{
"enable": bool,
"task_names": [ // Execute the task on the first match in the array (and subsequent next, etc.)
@@ -285,7 +285,7 @@ For more details about auto-copilot JSON, please refer to [Copilot Schema](3.7-S
Single-step task (currently only supports copilot)
```jsonc
```json
{
"enable": bool,
"type": string, // currently only supports "copilot"
@@ -304,7 +304,7 @@ For more details about auto-copilot JSON, please refer to [Copilot Schema](3.7-S
Video recognition, currently only supports operation (combat) video
```jsonc
```json
{
"enable": bool,
"filename": string,
@@ -315,7 +315,7 @@ For more details about auto-copilot JSON, please refer to [Copilot Schema](3.7-S
#### Prototype
```c++
```cpp
bool ASSTAPI AsstSetTaskParams(AsstHandle handle, TaskId id, const char* params);
```
@@ -342,7 +342,7 @@ Set task parameters
#### Prototype
```c++
```cpp
bool ASSTAPI AsstSetStaticOption(AsstStaticOptionKey key, const char* value);
```
@@ -370,7 +370,7 @@ None
#### Prototype
```c++
```cpp
bool ASSTAPI AsstSetInstanceOption(AsstHandle handle, AsstInstanceOptionKey key, const char* value);
```
@@ -394,7 +394,7 @@ Set instance-level parameters
##### List of Key and value
```jsonc
```json
enum InstanceOptionKey
{
Invalid = 0,

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

@@ -4,7 +4,7 @@
## Prototype
```c++
```cpp
typedef void(ASST_CALL* AsstCallback)(int msg, const char* details, void* custom_arg);
```
@@ -13,7 +13,7 @@ typedef void(ASST_CALL* AsstCallback)(int msg, const char* details, void* custom
- `int msg`<br>
The message type
```c++
```cpp
enum class AsstMsg
{
/* Global Info */
@@ -50,7 +50,7 @@ Todo
### InitFailed
```jsonc
```json
{
"what": string, // Error type
"why": string, // Error reason
@@ -60,7 +60,7 @@ Todo
### ConnectionInfo
```jsonc
```json
{
"what": string, // Info type
"why": string, // Info reason
@@ -98,7 +98,7 @@ Todo
### AsyncCallInfo
```jsonc
```json
{
"uuid": string, // UUID
"what": string, // Call type, "Connect" | "Click" | "Screencap" | ...
@@ -112,7 +112,7 @@ Todo
### AllTasksCompleted
```jsonc
```json
{
"taskchain": string, // Last task chain
"uuid": string, // UUID
@@ -162,7 +162,7 @@ Todo
### Information Related to TaskChain
```jsonc
```json
{
"taskchain": string, // Current task chain
"taskid": int, // Current task ID
@@ -176,7 +176,7 @@ Todo
### Information Related to SubTask
```jsonc
```json
{
"subtask": string, // Subtask name
"class": string, // Subtask class
@@ -191,7 +191,7 @@ Todo
- `ProcessTask`<br>
```jsonc
```json
// Example of corresponding details field
{
"task": "StartButton2", // Task name
@@ -254,7 +254,7 @@ Todo
### SubTaskExtraInfo
```jsonc
```json
{
"taskchain": string, // Current task chain
"class": string, // Subtask class
@@ -269,7 +269,7 @@ Todo
- `StageDrops`<br>
Stage drop information
```jsonc
```json
// Example of corresponding details field
{
"drops": [ // dropped items
@@ -317,7 +317,7 @@ Todo
- `RecruitTagsDetected`<br>
Recruitment tags detected
```jsonc
```json
// Example of corresponding details field
{
"tags": [
@@ -333,7 +333,7 @@ Todo
- `RecruitSpecialTag`<br>
Special recruitment tags detected
```jsonc
```json
// Example of corresponding details field
{
"tag": "高级资深干员" // Senior operator
@@ -343,7 +343,7 @@ Todo
- `RecruitResult`<br>
Recruitment result
```jsonc
```json
// Example of corresponding details field
{
"tags": [ // All tags, Must be 5
@@ -420,7 +420,7 @@ Todo
- `RecruitTagsRefreshed`<br>
Recruitment tags refreshed
```jsonc
```json
// Example of corresponding details field
{
"count": 1, // Number of times that the slot has been refreshed
@@ -431,7 +431,7 @@ Todo
- `RecruitTagsSelected`<br>
Recruitment tags selected
```jsonc
```json
// Example of corresponding details field
{
"tags": [
@@ -450,7 +450,7 @@ Todo
- `EnterFacility`<br>
Entering the facility
```jsonc
```json
// Example of corresponding details field
{
"facility": "Mfg", // Facility name
@@ -461,7 +461,7 @@ Todo
- `NotEnoughStaff`<br>
Available operators not enough
```jsonc
```json
// Example of corresponding details field
{
"facility": "Mfg", // Facility name
@@ -472,7 +472,7 @@ Todo
- `ProductOfFacility`<br>
Production of the facility
```jsonc
```json
// Example of corresponding details field
{
"product": "Money", // Product
@@ -484,7 +484,7 @@ Todo
- `StageInfo`<br>
Auto-battle stage info
```jsonc
```json
// Example of corresponding details field
{
"name": string // Stage name
@@ -497,7 +497,7 @@ Todo
- `PenguinId`<br>
Penguin ID
```jsonc
```json
// Example of corresponding details field
{
"id": string
@@ -507,7 +507,7 @@ Todo
- `DepotInfo`<br>
Recognition result of depot
```jsonc
```json
// Example of corresponding details field
// Supports ArkPlanner format only. More formats may be supported in future.
"arkplanner": {
@@ -547,7 +547,7 @@ Todo
- `OperBoxInfo`<br>
Recognition result of operator box
```jsonc
```json
// Example of corresponding details field
"done": bool, // Whether the recognition has been completed, false means it is still in progress (data during the process)
"all_oper": [

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

@@ -4,7 +4,7 @@ Usage of `resource/copilot/*.json` and field description.
## Overview
```jsonc
```json
{
"stage_name": "暴君", // Stage name, required. The Chinese name of the level, code, stageId, levelId, etc. are all acceptable as long as they are unique.
"opers": [ // Operator list

6
docs/en-us/3.4-TASK_SCHEMA.md
View File

@@ -4,7 +4,7 @@ Usage of `resource/tasks.json` and description of each field
## Overview
```jsonc
```json
{
"TaskName" : { // Task name
@@ -128,7 +128,7 @@ Allows a task "A" to be used as a template, and then "B@A" to represent the task
- If task "B@A" is not explicitly defined in `tasks.json`, then add `B@` prefix to the `sub`, `next`, `onErrorNext`, `exceededNext`, `reduceOtherTimes` fields (or `B` if the task name starts with `#`) and the rest of the parameters are the same as for task "A". That is, if task "A" has the following parameters.
```jsonc
```json
"A": {
"template": "A.png",
...,
@@ -138,7 +138,7 @@ Allows a task "A" to be used as a template, and then "B@A" to represent the task
is equivalent to defining both
```jsonc
```json
"B@A": {
"template": "A.png",
...,

2
docs/en-us/3.5-INTEGRATED_STRATEGY_SCHEMA.md
View File

@@ -4,7 +4,7 @@ Usage of `resource/roguelike_copilot.json` and description of each field
## Overview
```jsonc
```json
[
{
"stage_name": "驯兽小屋", // Stage name, required

2
docs/en-us/3.6-INFRASTRUCTURE_SCHEDULING_SCHEMA.md
View File

@@ -10,7 +10,7 @@ Usage and Field Description for `resource/custom_infrast/*.json` files
## Complete Field List
```jsonc
```json
{
"title": "小号的换班方案", // Assignment name, optional
"description": "哈哈哈哈", // Assignment description, optional

2
docs/en-us/3.7-SECURITY_PRESENCE_SCHEMA.md
View File

@@ -4,7 +4,7 @@ This document is machine-translated. If you have the ability, please refer to th
**Note: As JSON format does not support comments, please remove the comments when using the examples below.**
```jsonc
```json
{
"type": "SSS", // Protocol type, SSS means a stationed preservation, required, unchangeable
"stage_name": "Duos Lore building site", // The name of the preservation location, required