chore: fix casing typo and related context (#15656)

* chore: fix typo

* typo: "Request" spelling mistake

---------

Co-authored-by: 晓丶梦丶仁 <74444214+Daydreamer114@users.noreply.github.com>
This commit is contained in:
airwish
2026-02-10 23:48:44 +08:00
committed by GitHub
parent 3a80bbef0b
commit e137ac81c9
37 changed files with 91 additions and 91 deletions

View File

@@ -12,7 +12,7 @@ function(create_resource_link TARGET_NAME OUTPUT_DIR)
COMMENT "Creating junction for resource directory for ${TARGET_NAME}"
)
else()
# Unix/Linux/macOS 使用符号链接
# UNIX/Linux/macOS 使用符号链接
add_custom_command(
TARGET ${TARGET_NAME}
POST_BUILD

View File

@@ -15,7 +15,7 @@ You can [Ask DeepWiki](https://deepwiki.com/MaaAssistantArknights/MaaAssistantAr
## I don't know programming but just want to modify some JSON files/documents, how can I do it?
Welcome to the [Web-based PR Tutorial](./pr-tutorial.md) that anyone can understand (purely web-based on Github.com)
Welcome to the [Web-based PR Tutorial](./pr-tutorial.md) that anyone can understand (purely web-based on GitHub.com)
## I want to make simple modifications to a few lines of code, but configuring the environment is too tedious and pure web editing is difficult to use. What should I do?
@@ -126,17 +126,17 @@ We've preset several different development environments for you to choose from:
After opening Visual Studio, Git operations can be performed using VS's built-in "Git Changes" instead of command-line tools.
:::
## Using VSCode for Development (Optional)
## Using VS Code for Development (Optional)
::: warning
**Visual Studio is the recommended IDE for development.** The MAA project is primarily built around Visual Studio, and the complete environment setup described above covers all development needs with the best out-of-the-box experience. The VSCode workflow is provided only as an alternative for developers already familiar with VSCode + CMake + clangd, and requires more configuration effort.
**Visual Studio is the recommended IDE for development.** The MAA project is primarily built around Visual Studio, and the complete environment setup described above covers all development needs with the best out-of-the-box experience. The VS Code workflow is provided only as an alternative for developers already familiar with VS Code + CMake + clangd, and requires more configuration effort.
:::
If you prefer VSCode, you can use CMake, clangd, and related extensions for code completion, navigation, and debugging. After completing steps 16 above (clone, dependencies, CMake configuration), follow these steps:
If you prefer VS Code, you can use CMake, clangd, and related extensions for code completion, navigation, and debugging. After completing steps 16 above (clone, dependencies, CMake configuration), follow these steps:
### Recommended Extensions
Install from the VSCode marketplace:
Install from the VS Code marketplace:
| Extension | Purpose |
| --------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- |
@@ -150,7 +150,7 @@ When using clangd, set `C_Cpp.intelliSenseEngine` to `disabled` to avoid conflic
### Setup Steps
1. Open the project root folder in VSCode
1. Open the project root folder in VS Code
2. **CMake Tools**:
- Select a Configure Preset from the status bar (e.g. `windows-x64`, `linux-x64`)
- Select a Build Preset and run configure/build
@@ -173,7 +173,7 @@ The currently enabled formatting tools are as follows:
| File Type | Format Tool |
| --------- | --------------------------------------------------------------- |
| C++ | [clang-format](https://clang.llvm.org/docs/ClangFormat.html) |
| Json/Yaml | [Prettier](https://prettier.io/) |
| JSON/YAML | [Prettier](https://prettier.io/) |
| Markdown | [markdownlint](https://github.com/DavidAnson/markdownlint-cli2) |
### Use Pre-commit Hooks to Automatically Format Code

View File

@@ -3,7 +3,7 @@ order: 8
icon: iconoir:code-brackets
---
# Dedicated VSCode Extension Tutorial
# Dedicated VS Code Extension Tutorial
The extension provides a series of convenient development capabilities for MaaAssistantArknights/MaaFramework, including but not limited to the following features:
@@ -14,7 +14,7 @@ For details, please visit [Extension Store](https://marketplace.visualstudio.com
## Installation
Searching `Maa` and installing it from VSCode extensions list is recommended.
Searching `Maa` and installing it from VS Code extensions list is recommended.
::: tip
When used for the first time, the extension will automatically download the preset version of resources.
@@ -90,9 +90,9 @@ Scanning and selecting controllers, selecting resource, adding and manipulating
### Take screenshots and crop images / Quick recognition
Searching and launching `Maa: open crop tool` inside VSCode command panel can open `Screenshots / Crop` panel.
Searching and launching `Maa: open crop tool` inside VS Code command panel can open `Screenshots / Crop` panel.
> Use `Ctrl+Shift+P` (`Command+Shift+P` on MacOS) to open command panel
> Use `Ctrl+Shift+P` (`Command+Shift+P` on macOS) to open command panel
- After selecting and connecting to the controller, use `Screencap` button to obtain screenshots
- Use `Upload` button to manually upload images.
@@ -114,11 +114,11 @@ For MAA, the extension will maintain the models used automatically; you only nee
#### MaaFramework Log
Search and execute `Maa: open maa log` in the VSCode command panel to view the `maa.log` generated during debugging.
Search and execute `Maa: open maa log` in the VS Code command panel to view the `maa.log` generated during debugging.
#### Maa Pipeline Support Extension Log
Search and execute `Maa: open extension log` in the VSCode command panel to view the `mse.log` generated during debugging.
Search and execute `Maa: open extension log` in the VS Code command panel to view the `mse.log` generated during debugging.
### Bottom status bar

View File

@@ -9,7 +9,7 @@ icon: basil:apple-solid
### ✅ [PlayCover](https://playcover.io) (Runs most fluently as it's native 🚀)
Experimental support. Please submit issues if you encounter problems, and include `MacOS` in the title.
Experimental support. Please submit issues if you encounter problems, and include `macOS` in the title.
Note: Due to macOS system limitations, screenshot issues may occur when minimizing the game window, switching to other windows while in Stage Manager, or moving the window to other desktops/screens. Related issue: [#4371](https://github.com/MaaAssistantArknights/MaaAssistantArknights/issues/4371#issuecomment-1527977512)

View File

@@ -440,4 +440,4 @@ Configured in `MaaCore.vcxporj`, works out of the box. Prompts are somewhat cryp
### Visual Studio Code
Configured in `.vscode/settings.json`, use VSCode to open the **project folder** to use. Better prompt quality.
Configured in `.vscode/settings.json`, use VS Code to open the **project folder** to use. Better prompt quality.

View File

@@ -5,7 +5,7 @@ icon: devicon-plain:githubactions
# CI システム解析
MAA は Github Action を活用して、ウェブサイトの構築、自動リソース更新、最終ファイルの構築とリリースなど、大量の自動化作業を完了しました。時間の経過とともに、これらの CI は徐々にネスト化し始め、一部は他のリポジトリにリンクされています。このドキュメントは、MAA の CI システムを改善したい人のために簡単な紹介を提供することを目的としています。
MAA は GitHub Action を活用して、ウェブサイトの構築、自動リソース更新、最終ファイルの構築とリリースなど、大量の自動化作業を完了しました。時間の経過とともに、これらの CI は徐々にネスト化し始め、一部は他のリポジトリにリンクされています。このドキュメントは、MAA の CI システムを改善したい人のために簡単な紹介を提供することを目的としています。
このドキュメントを読む前に、MAA のプロジェクト構造と構成について基本的な概念を持っていることが推奨されます。
@@ -28,7 +28,7 @@ MAA は Github Action を活用して、ウェブサイトの構築、自動リ
さらに、[pre-commit.ci](https://pre-commit.ci/) を通じてコードの自動フォーマットと画像リソースの自動最適化を実現しており、PR を作成した後に自動的に実行されるため、通常は特に注意する必要はありません。
## Github Action 部分
## GitHub Action 部分
### コードテスト

View File

@@ -142,7 +142,7 @@ VSCodeを好む場合、CMake、clangdなどの拡張機能でコード補完、
### 推奨拡張機能
VSCode Marketplace からインストール:
VS Code Marketplace からインストール:
| 拡張機能 | 用途 |
| --------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
@@ -156,7 +156,7 @@ clangd を使用する場合、C/C++ 拡張機能の IntelliSense を無効化
### 設定手順
1. VSCode でプロジェクトルートを開く
1. VS Code でプロジェクトルートを開く
2. **CMake Tools**:ステータスバーで Configure Preset`windows-x64`、`linux-x64`を選択し、Build Preset でビルドを実行
3. **clangd**Windows で MSVC を使用する場合、`compile_commands.json` がなくても clangd で開発可能。Linux/macOS ではプリセットで `CMAKE_EXPORT_COMPILE_COMMANDS` が有効となり、clangd は `build/compile_commands.json` を自動使用
4. **デバッグ**:プロジェクトには `.vscode/launch.json` が含まれており、MaaWpfGui や Debug Demo の起動が可能
@@ -177,7 +177,7 @@ MAAは、リポジトリ内のコードとリソースファイルが美しく
| ファイルタイプ | フォーマットツール |
| -------------- | --------------------------------------------------------------- |
| C++ | [clang-format](https://clang.llvm.org/docs/ClangFormat.html) |
| Json/Yaml | [Prettier](https://prettier.io/) |
| JSON/YAML | [Prettier](https://prettier.io/) |
| Markdown | [markdownlint](https://github.com/DavidAnson/markdownlint-cli2) |
### Pre-commit Hooksを使用してコードを自動フォーマット

View File

@@ -163,4 +163,4 @@ ROIの範囲を変更するには
## 変更を送信する
[Github Pull Requst ガイド](../develop/development.md#github-pull-request-プロセス概要)を参照してください。
[GitHub Pull Request ガイド](../develop/development.md#github-pull-request-プロセス概要)を参照してください。

View File

@@ -11,7 +11,7 @@ icon: mingcute:git-pull-request-fill
::: warning
このガイドでは、多くの概念を簡略化し、より多くの人々が実際に使用できるように、不格好であるが簡単な操作が含まれています。また、正しくない説明もありますので、大変恐れ入りますが、専門家の方々にはお許しください。
Gitの使用経験とプログラミングの基礎がある場合、[Github Pull Request プロセス概要](./development.md#github-pull-request-プロセス概要)など、より上級のチュートリアルを見ることができます。
Gitの使用経験とプログラミングの基礎がある場合、[GitHub Pull Request プロセス概要](./development.md#github-pull-request-プロセス概要)など、より上級のチュートリアルを見ることができます。
:::
## 基本概念および用語の説明

View File

@@ -3,7 +3,7 @@ order: 8
icon: iconoir:code-brackets
---
# Dedicated VSCode Extension Tutorial
# Dedicated VS Code Extension Tutorial
The extension provides a series of convenient development capabilities for MaaAssistantArknights/MaaFramework, including but not limited to the following features:
@@ -14,7 +14,7 @@ For details, please visit [Extension Store](https://marketplace.visualstudio.com
## Installation
Searching `Maa` and installing it from VSCode extensions list is recommended.
Searching `Maa` and installing it from VS Code extensions list is recommended.
::: tip
When used for the first time, the extension will automatically download the preset version of resources.
@@ -90,9 +90,9 @@ Scanning and selecting controllers, selecting resource, adding and manipulating
### Take screenshots and crop images / Quick recognition
Searching and launching `Maa: open crop tool` inside VSCode command panel can open `Screenshots / Crop` panel.
Searching and launching `Maa: open crop tool` inside VS Code command panel can open `Screenshots / Crop` panel.
> Use `Ctrl+Shift+P` (`Command+Shift+P` on MacOS) to open command panel
> Use `Ctrl+Shift+P` (`Command+Shift+P` on macOS) to open command panel
- After selecting and connecting to the controller, use `Screencap` button to obtain screenshots
- Use `Upload` button to manually upload images.
@@ -114,11 +114,11 @@ For MAA, the extension will maintain the models used automatically; you only nee
#### MaaFramework Log
Search and execute `Maa: open maa log` in the VSCode command panel to view the `maa.log` generated during debugging.
Search and execute `Maa: open maa log` in the VS Code command panel to view the `maa.log` generated during debugging.
#### Maa Pipeline Support Extension Log
Search and execute `Maa: open extension log` in the VSCode command panel to view the `mse.log` generated during debugging.
Search and execute `Maa: open extension log` in the VS Code command panel to view the `mse.log` generated during debugging.
### Bottom status bar

View File

@@ -5,7 +5,7 @@ icon: devicon-plain:githubactions
# CI 시스템 해석
MAA는 Github Action을 활용하여 웹사이트 구축, 자동 리소스 업데이트, 최종 파일 빌드 및 릴리즈 등 대량의 자동화 작업을 완성했습니다. 시간이 지나면서 이러한 CI들은 점차 중첩되기 시작했고, 일부는 다른 저장소로 연결되기도 했습니다. 본 문서는 MAA의 CI 시스템을 개선하고자 하는 분들에게 간단한 소개를 제공하는 것을 목표로 합니다.
MAA는 GitHub Action을 활용하여 웹사이트 구축, 자동 리소스 업데이트, 최종 파일 빌드 및 릴리즈 등 대량의 자동화 작업을 완성했습니다. 시간이 지나면서 이러한 CI들은 점차 중첩되기 시작했고, 일부는 다른 저장소로 연결되기도 했습니다. 본 문서는 MAA의 CI 시스템을 개선하고자 하는 분들에게 간단한 소개를 제공하는 것을 목표로 합니다.
본 문서를 읽기 전에 MAA의 프로젝트 구조와 구성에 대한 기본적인 개념을 갖고 있는 것이 좋습니다.
@@ -42,7 +42,7 @@ MAA는 Github Action을 활용하여 웹사이트 구축, 자동 리소스 업
이 워크플로우는 코드의 전체 빌드 작업을 담당하며, MAA의 모든 구성 요소를 포함합니다. 빌드 결과물은 실행 가능한 MAA입니다.
필수적인 MaaCore 외에, Windows 빌드 결과물에는 MaaWpfGui가, MacOS 빌드 결과물에는 MaaMacGui가, Linux 빌드 결과물에는 MaaCLI가 포함됩니다.
필수적인 MaaCore 외에, Windows 빌드 결과물에는 MaaWpfGui가, macOS 빌드 결과물에는 MaaMacGui가, Linux 빌드 결과물에는 MaaCLI가 포함됩니다.
이 워크플로우는 새로운 Commit이나 PR이 발생할 때마다 자동으로 실행되며, 릴리즈 PR에 의해 트리거될 때는 이번 빌드 결과물이 직접 릴리즈에 사용되고 Release가 생성됩니다.

View File

@@ -134,14 +134,14 @@ Visual Studio 실행 시 Git 작업은 "Git 변경" 탭에서 명령어 없이
## VSCode로 개발하기 (선택 사항)
::: warning
**Visual Studio를 사용한 개발을 권장합니다.** MAA 프로젝트는 주로 Visual Studio를 기반으로 구축되며, 위의 완전한 환경 설정 과정이 모든 개발 요구를 충족하여 최상의 즉시 사용 가능한 경험을 제공합니다. VSCode 워크플로는 VSCode + CMake + clangd에 이미 익숙한 개발자를 위한 대안으로만 제공되며, 설정 난이도가 상대적으로 높습니다.
**Visual Studio를 사용한 개발을 권장합니다.** MAA 프로젝트는 주로 Visual Studio를 기반으로 구축되며, 위의 완전한 환경 설정 과정이 모든 개발 요구를 충족하여 최상의 즉시 사용 가능한 경험을 제공합니다. VS Code 워크플로는 VS Code + CMake + clangd에 이미 익숙한 개발자를 위한 대안으로만 제공되며, 설정 난이도가 상대적으로 높습니다.
:::
VSCode를 선호한다면 CMake, clangd 등의 확장을 사용해 코드 완성, 탐색, 디버깅을 할 수 있습니다. 위 16단계(클론, 의존성, CMake 설정)를 완료한 후 다음 단계로 설정하세요.
### 추천 확장
VSCode Marketplace에서 설치:
VS Code Marketplace에서 설치:
| 확장 | 용도 |
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------- |
@@ -176,7 +176,7 @@ MAA는 리포지토리의 코드 및 리소스 파일들을 아름답고 일관
| 파일 유형 | 포매팅 도구 |
| --------- | --------------------------------------------------------------- |
| C++ | [clang-format](https://clang.llvm.org/docs/ClangFormat.html) |
| Json/Yaml | [Prettier](https://prettier.io/) |
| JSON/YAML | [Prettier](https://prettier.io/) |
| Markdown | [markdownlint](https://github.com/DavidAnson/markdownlint-cli2) |
### Pre-commit Hooks를 사용하여 자동 포매팅을 활성화

View File

@@ -29,7 +29,7 @@ icon: jam:write-f
:::
```
또는 Github 스타일 구문 사용:
또는 GitHub 스타일 구문 사용:
```markdown
> [!컨테이너 타입]

View File

@@ -162,4 +162,4 @@ ROI 범위를 수정하는 방법:
## 변경사항 제출
[Github Pull Request 가이드](./pr-tutorial.md)를 참고하세요!
[GitHub Pull Request 가이드](./pr-tutorial.md)를 참고하세요!

View File

@@ -9,7 +9,7 @@ icon: mingcute:git-pull-request-fill
::: warning
이 가이드는 많은 개념을 단순화하여 더 많은 사람들이 실제로 사용할 수 있도록 설계되었습니다. 때로는 꽤 불안불안한 ~~하지만 간단한~~ 조치들과 약간 부정확한 설명이 있을 수 있으므로 전문가 분들의 이해를 부탁드립니다.
만약 Git 사용 경험이 있고 프로그래밍 기초 지식을 가지고 계시다면 ~~그럼 당신은 왜 보고 있나요🔨~~, 약간 더 발전된 가이드인 [Github Pull Request 진행과정](./development.md#완전한-환경-설정-windows)을 확인해주세요.
만약 Git 사용 경험이 있고 프로그래밍 기초 지식을 가지고 계시다면 ~~그럼 당신은 왜 보고 있나요🔨~~, 약간 더 발전된 가이드인 [GitHub Pull Request 진행과정](./development.md#완전한-환경-설정-windows)을 확인해주세요.
:::
## 기본 개념 및 용어 설명

View File

@@ -3,7 +3,7 @@ order: 8
icon: iconoir:code-brackets
---
# 전용 VSCode 확장 프로그램 가이드
# 전용 VS Code 확장 프로그램 가이드
이 확장 프로그램은 MaaAssistantArknights/MaaFramework에 대해 다음과 같은 기능들을 포함한 편리한 개발 기능들을 제공합니다:
@@ -14,7 +14,7 @@ icon: iconoir:code-brackets
## 설치
VSCode 확장 프로그램 목록에서 `Maa`를 검색하여 직접 설치하는 것을 권장합니다.
VS Code 확장 프로그램 목록에서 `Maa`를 검색하여 직접 설치하는 것을 권장합니다.
::: tip
처음 사용할 때 확장 프로그램은 사전 설정된 버전의 리소스를 자동으로 다운로드합니다.
@@ -90,7 +90,7 @@ VSCode 확장 프로그램 목록에서 `Maa`를 검색하여 직접 설치하
### 스크린샷 캡처 및 자르기 / 빠른 인식
VSCode 명령 팔레트에서 `Maa: 스크린샷 도구 열기(Maa: open crop tool)`를 검색하고 실행하여 `스크린샷 / 자르기(Screenshots / Crop)` 패널을 열 수 있습니다.
VS Code 명령 팔레트에서 `Maa: 스크린샷 도구 열기(Maa: open crop tool)`를 검색하고 실행하여 `스크린샷 / 자르기(Screenshots / Crop)` 패널을 열 수 있습니다.
> `Ctrl+Shift+P` (MacOS의 경우 `Command+Shift+P`)를 사용하여 명령 팔레트를 엽니다.
@@ -114,11 +114,11 @@ MAA의 경우, 확장 프로그램에서 사용되는 모델을 자동으로 관
#### MaaFramework 로그
VSCode 명령 팔레트에서 `Maa: maa 로그 열기(Maa: open maa log)`를 검색하고 실행하여 디버깅 중에 생성된 `maa.log` 로그를 볼 수 있습니다.
VS Code 명령 팔레트에서 `Maa: maa 로그 열기(Maa: open maa log)`를 검색하고 실행하여 디버깅 중에 생성된 `maa.log` 로그를 볼 수 있습니다.
#### Maa Pipeline Support 확장 로그
VSCode 명령 팔레트에서 `Maa: 확장 로그 열기(Maa: open extension log)`를 검색하고 실행하여 디버깅 중에 생성된 `mse.log` 로그를 볼 수 있습니다.
VS Code 명령 팔레트에서 `Maa: 확장 로그 열기(Maa: open extension log)`를 검색하고 실행하여 디버깅 중에 생성된 `mse.log` 로그를 볼 수 있습니다.
### 하단 상태 표시줄

View File

@@ -335,7 +335,7 @@ address = "127.0.0.1:7777" # 필요 시 사전 설정된 주소를 재정의할
#### 특수 프리셋
현재 `PlayCover (MacOS)`, `Waydroid (Linux)` 두 가지 특수 프리셋이 사전 구성되어 있습니다.
현재 `PlayCover (macOS)`, `Waydroid (Linux)` 두 가지 특수 프리셋이 사전 구성되어 있습니다.
- `PlayCover`는 macOS에서 `PlayCover`를 통해 네이티브로 실행되는 게임 클라이언트에 연결하는 데 사용됩니다. 이 경우 `adb_path`를 지정할 필요가 없으며, `address``adb` 연결 주소가 아닌 `PlayTools`의 주소입니다. 자세한 내용은 [PlayCover 지원 문서][playcover-doc]를 참고하세요.

View File

@@ -99,7 +99,7 @@ nix run github:Cryolitia/nur-packages#maa-cli-nightly
:::
안정 버전은 [nixpkgs](https://github.com/NixOS/nixpkgs/blob/nixos-unstable/pkgs/by-name/ma/maa-cli/package.nix)에 패키징되어 있으며, `nixpkgs`의 Rust 툴체인을 사용합니다. 나이틀리 빌드는 [NUR](https://github.com/Cryolitia/nur-packages/blob/master/pkgs/maa-assistant-arknights/maa-cli.nix)에 있으며, 베타 채널의 Rust 툴체인을 사용하며 Github Action에 의해 매일 자동으로 업데이트되고 빌드가 검증됩니다.
안정 버전은 [nixpkgs](https://github.com/NixOS/nixpkgs/blob/nixos-unstable/pkgs/by-name/ma/maa-cli/package.nix)에 패키징되어 있으며, `nixpkgs`의 Rust 툴체인을 사용합니다. 나이틀리 빌드는 [NUR](https://github.com/Cryolitia/nur-packages/blob/master/pkgs/maa-assistant-arknights/maa-cli.nix)에 있으며, 베타 채널의 Rust 툴체인을 사용하며 GitHub Action에 의해 매일 자동으로 업데이트되고 빌드가 검증됩니다.
#### Homebrew

View File

@@ -61,7 +61,7 @@ Mac 버전 개발에 인력이 부족하여 업데이트 속도가 비교적 느
완벽하게 지원됩니다.
추가로, macOS에서 녹스 에뮬레이터의 adb 이진 파일의 위치는 `/Applications/NoxAppPlayer.app/Contents/MacOS/adb`이며 부모 디렉토리 `MacOS`에서 `adb devices` 명령을 사용하여 adb 포트를 확인할 수 있습니다.
추가로, macOS에서 녹스 에뮬레이터의 adb 이진 파일의 위치는 `/Applications/NoxAppPlayer.app/Contents/macOS/adb`이며 부모 디렉토리 `macOS`에서 `adb devices` 명령을 사용하여 adb 포트를 확인할 수 있습니다.
### ✅ [AVD](https://developer.android.com/studio/run/managing-avds)

View File

@@ -23,7 +23,7 @@ DirectML을 사용하여 GPU를 호출하여 인식 추론을 가속화합니다
MAA는 시작 매개변수를 통해 구성을 자동으로 전환할 수 있습니다. MAA 프로세스 이름 뒤에 `--config <구성 이름>`을 추가하면 됩니다. 예: `./MAA/MAA.exe --config Official`
일부 기호는 이스케이프해야 합니다. `Json` 참조하세요. 예를 들어 구성 이름이 `"Official"`인 경우 매개변수는 --config `\"Official\"`가 되어야 합니다
일부 기호는 이스케이프해야 합니다. `JSON` 참조하세요. 예를 들어 구성 이름이 `"Official"`인 경우 매개변수는 --config `\"Official\"`가 되어야 합니다
## 시작 전/후 스크립트

View File

@@ -5,7 +5,7 @@ icon: devicon-plain:githubactions
# CI 系统解析
MAA 借助 Github Action 完成了大量的自动化工作,包括网站的构建,自动更新资源,最终文件的构建与发版等等过程。随着时间的推移,这些 CI 逐渐开始嵌套,部分甚至引向了其他的存储库。本文档旨在为想要对 MAA 的 CI 系统做出改进的各位做一个简要的介绍。
MAA 借助 GitHub Action 完成了大量的自动化工作,包括网站的构建,自动更新资源,最终文件的构建与发版等等过程。随着时间的推移,这些 CI 逐渐开始嵌套,部分甚至引向了其他的存储库。本文档旨在为想要对 MAA 的 CI 系统做出改进的各位做一个简要的介绍。
阅读本文之前,最好对 MAA 的项目结构以及组成有一个基本的概念。
@@ -28,7 +28,7 @@ MAA 借助 Github Action 完成了大量的自动化工作,包括网站的构
此外,我们还通过 [pre-commit.ci](https://pre-commit.ci/) 实现了代码的自动格式化和图片资源的自动优化,它在发起 PR 后会自动执行,一般无需特别在意。
## Github Action 部分
## GitHub Action 部分
### 代码测试

View File

@@ -15,7 +15,7 @@ icon: iconoir:developer
## 我不懂编程,只是想改一点点 JSON 文件/文档等,要怎么操作?
欢迎收看 [牛牛也能看懂的 GitHub Pull Request 使用指南](./pr-tutorial.md) (纯网页端操作 Github.com
欢迎收看 [牛牛也能看懂的 GitHub Pull Request 使用指南](./pr-tutorial.md) (纯网页端操作 GitHub.com
## 我只想简单修改几行代码,但配置环境太麻烦,纯网页编辑又很难用,怎么办?
@@ -126,17 +126,17 @@ icon: iconoir:developer
在打开 VS 之后,和 Git 有关的操作可以不用命令行工具,直接使用 VS 自带的“Git 更改”即可
:::
## 使用 VSCode 进行开发(可选)
## 使用 VS Code 进行开发(可选)
::: warning
**推荐优先使用 Visual Studio 进行开发。** MAA 项目主要基于 Visual Studio 构建上述完整环境配置流程已涵盖所有开发需求开箱即用体验最佳。VSCode 方案仅作为备选,适合已经熟悉 VSCode + CMake + clangd 工作流的开发者,配置门槛相对较高。
**推荐优先使用 Visual Studio 进行开发。** MAA 项目主要基于 Visual Studio 构建上述完整环境配置流程已涵盖所有开发需求开箱即用体验最佳。VSCode 方案仅作为备选,适合已经熟悉 VS Code + CMake + clangd 工作流的开发者,配置门槛相对较高。
:::
如果你偏好使用 VSCode可以配合 CMake、clangd 等扩展获得代码补全、跳转和调试能力。在完成前述 16 步克隆、依赖、CMake 配置)后,可按以下步骤配置:
### 推荐扩展
在 VSCode 扩展市场安装:
在 VS Code 扩展市场安装:
| 扩展 | 作用 |
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------- |
@@ -150,7 +150,7 @@ icon: iconoir:developer
### 配置步骤
1. 用 VSCode 打开项目根目录
1. 用 VS Code 打开项目根目录
2. 使用 **CMake Tools**
- 状态栏选择 Configure Preset如 `windows-x64`、`linux-x64` 等)
- 选择 Build Preset执行配置与构建
@@ -173,7 +173,7 @@ MAA 使用一系列的格式化工具来保证仓库中的代码和资源文件
| 文件类型 | 格式化工具 |
| --------- | --------------------------------------------------------------- |
| C++ | [clang-format](https://clang.llvm.org/docs/ClangFormat.html) |
| Json/Yaml | [Prettier](https://prettier.io/) |
| JSON/YAML | [Prettier](https://prettier.io/) |
| Markdown | [markdownlint](https://github.com/DavidAnson/markdownlint-cli2) |
### 利用 Pre-commit Hooks 自动进行代码格式化

View File

@@ -29,7 +29,7 @@ icon: jam:write-f
:::
```
或是使用 Github 风格语法
或是使用 GitHub 风格语法
```markdown
> [!容器类型]

View File

@@ -164,4 +164,4 @@ amplified roi: 426, 272, 177, 201
## 提交你的修改
请参考 [Github Pull Request 指南](./pr-tutorial.md)
请参考 [GitHub Pull Request 指南](./pr-tutorial.md)

View File

@@ -9,7 +9,7 @@ icon: mingcute:git-pull-request-fill
::: warning
本教程中对很多概念进行了简化,为了让更多朋友能实际用起来,甚至有一些很不优雅~~但是简单~~的操作,还有一些不那么正确的解释,还请大佬们轻喷。
若您有一定的 git 使用经验及编程基础,~~那你还看个 🔨~~,可以看稍微进阶一点的教程 [Github Pull Request 流程简述](./development.md)
若您有一定的 git 使用经验及编程基础,~~那你还看个 🔨~~,可以看稍微进阶一点的教程 [GitHub Pull Request 流程简述](./development.md)
:::
## 基本概念及名词解释

View File

@@ -3,7 +3,7 @@ order: 8
icon: iconoir:code-brackets
---
# 专用 VSCode 插件教程
# 专用 VS Code 插件教程
该插件针对 MaaAssistantArknights/MaaFramework 提供了一系列方便开发的能力,包括但不限于以下功能:
@@ -14,7 +14,7 @@ icon: iconoir:code-brackets
## 安装
推荐直接在 VSCode 的插件列表中搜索 `Maa` 来安装
推荐直接在 VS Code 的插件列表中搜索 `Maa` 来安装
::: tip
首次使用时, 插件会自动下载预设版本的资源
@@ -90,9 +90,9 @@ icon: iconoir:code-brackets
### 截图裁剪 / 快速识别
在 VSCode 的命令面板中搜索执行 `Maa: 打开截图工具`, 可打开 `截图 / 裁剪` 面板.
在 VS Code 的命令面板中搜索执行 `Maa: 打开截图工具`, 可打开 `截图 / 裁剪` 面板.
> 使用 `Ctrl+Shift+P` (MacOS 上则是 `Command+Shift+P`) 呼出命令面板
> 使用 `Ctrl+Shift+P` (macOS 上则是 `Command+Shift+P`) 呼出命令面板
- 选择并连接控制器后, 可使用 `截图` 按钮直接获取截图
- 可使用 `上传` 按钮手动上传
@@ -114,11 +114,11 @@ icon: iconoir:code-brackets
#### MaaFramework日志
在 VSCode 的命令面板中搜索执行 `Maa: 打开maa日志`, 可查看调试期间产生的`maa.log`日志.
在 VS Code 的命令面板中搜索执行 `Maa: 打开maa日志`, 可查看调试期间产生的`maa.log`日志.
#### Maa Pipeline Support扩展日志
在 VSCode 的命令面板中搜索执行 `Maa: 打开插件日志`, 可查看调试期间产生的`mse.log`日志.
在 VS Code 的命令面板中搜索执行 `Maa: 打开插件日志`, 可查看调试期间产生的`mse.log`日志.
### 底部状态栏

View File

@@ -335,7 +335,7 @@ address = "127.0.0.1:7777" # 如果你需要的话,你可以覆盖预设的地
#### 特殊预设
目前预配置了两种预设,为 `PlayCover (MacOS)`, `Waydroid (Linux)`
目前预配置了两种预设,为 `PlayCover (macOS)`, `Waydroid (Linux)`
- `PlayCover`用于在 macOS 上连接直接通过 `PlayCover` 原生运行的游戏客户端。这种情况下不需要指定 `adb_path``address` 不是 `adb` 连接的地址而是 `PlayTools` 的地址,具体使用参见 [PlayCover 支持文档][playcover-doc].

View File

@@ -99,7 +99,7 @@ nix run github:Cryolitia/nur-packages#maa-cli-nightly
:::
稳定版打包至 [nixpkgs](https://github.com/NixOS/nixpkgs/blob/nixos-unstable/pkgs/by-name/ma/maa-cli/package.nix) 中,使用 `nixpkgs` 中的 Rust 工具链;每夜构建位于 [NUR](https://github.com/Cryolitia/nur-packages/blob/master/pkgs/maa-assistant-arknights/maa-cli.nix) 中,使用 Beta channel 的 Rust 工具链,由 Github Actions 每日自动更新和构建验证。
稳定版打包至 [nixpkgs](https://github.com/NixOS/nixpkgs/blob/nixos-unstable/pkgs/by-name/ma/maa-cli/package.nix) 中,使用 `nixpkgs` 中的 Rust 工具链;每夜构建位于 [NUR](https://github.com/Cryolitia/nur-packages/blob/master/pkgs/maa-assistant-arknights/maa-cli.nix) 中,使用 Beta channel 的 Rust 工具链,由 GitHub Actions 每日自动更新和构建验证。
#### Homebrew

View File

@@ -9,9 +9,9 @@ icon: basil:apple-solid
### ✅ [PlayCover](https://playcover.io)(原生运行最流畅 🚀)
试验性支持,遇到问题请多多提 Issue并在标题中提及 `MacOS`
试验性支持,遇到问题请多多提 Issue并在标题中提及 `macOS`
注意:由于 `MacOS` 本身机制的问题,将游戏窗口最小化、台前调度状态下切换到别的窗口、将窗口移动到别的桌面/屏幕之后,截图会出现问题,导致无法正确运行。相关 Issue [#4371](https://github.com/MaaAssistantArknights/MaaAssistantArknights/issues/4371#issuecomment-1527977512)
注意:由于 `macOS` 本身机制的问题,将游戏窗口最小化、台前调度状态下切换到别的窗口、将窗口移动到别的桌面/屏幕之后,截图会出现问题,导致无法正确运行。相关 Issue [#4371](https://github.com/MaaAssistantArknights/MaaAssistantArknights/issues/4371#issuecomment-1527977512)
0. 要求MAA 版本 v4.13.0-rc.1 以上

View File

@@ -23,7 +23,7 @@ MAA 会以 1 秒的间隔持续轮询这个端点,尝试获取他要执行的
被控 MAA 需要将该端点填写到 MAA 配置的`获取任务端点`文本框中。
该端点必需能够接受一个 `Content-Type=application/json` 的 POST 请求,并该请求必须可以接受下面这个 Json 作为请求的 content
该端点必需能够接受一个 `Content-Type=application/json` 的 POST 请求,并该请求必须可以接受下面这个 JSON 作为请求的 content
```json
{
@@ -33,7 +33,7 @@ MAA 会以 1 秒的间隔持续轮询这个端点,尝试获取他要执行的
}
```
该端点必须返回一个 Json 格式的 Response并且至少要满足下列格式
该端点必须返回一个 JSON 格式的 Response并且至少要满足下列格式
```json
{
@@ -99,7 +99,7 @@ MAA 会以 1 秒的间隔持续轮询这个端点,尝试获取他要执行的
被控 MAA 需要将该端点填写到 MAA 配置的 `汇报任务端点` 文本框中。
该端点必需能够接受一个 `Content-Type=application/json` 的 POST 请求,并该请求必须可以接受下面这个 Json 作为请求的 content
该端点必需能够接受一个 `Content-Type=application/json` 的 POST 请求,并该请求必须可以接受下面这个 JSON 作为请求的 content
```json
{

View File

@@ -127,17 +127,17 @@ icon: iconoir:developer
開啟 Visual Studio 之後,和 Git 有關的操作可以不用命令列工具,直接使用 Visual Studio 內建的「Git 變更」功能即可。
:::
## 使用 VSCode 進行開發(可選)
## 使用 VS Code 進行開發(可選)
::: warning
**建議優先使用 Visual Studio 進行開發。** MAA 專案主要基於 Visual Studio 建置上述完整環境配置流程已涵蓋所有開發需求開箱即用體驗最佳。VSCode 方案僅作為備選,適合已經熟悉 VSCode + CMake + clangd 工作流的開發者,配置門檻相對較高。
**建議優先使用 Visual Studio 進行開發。** MAA 專案主要基於 Visual Studio 建置上述完整環境配置流程已涵蓋所有開發需求開箱即用體驗最佳。VSCode 方案僅作為備選,適合已經熟悉 VS Code + CMake + clangd 工作流的開發者,配置門檻相對較高。
:::
如果您偏好使用 VSCode可以搭配 CMake、clangd 等擴充套件獲得程式碼補全、跳轉與除錯能力。完成前述 16 步複製、相依、CMake 設定)後,可依下列步驟設定:
### 推薦擴充套件
於 VSCode 擴充套件市集安裝:
於 VS Code 擴充套件市集安裝:
| 擴充套件 | 作用 |
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------- |
@@ -151,7 +151,7 @@ icon: iconoir:developer
### 設定步驟
1. 使用 VSCode 開啟專案根目錄
1. 使用 VS Code 開啟專案根目錄
2. **CMake Tools**
- 於狀態列選擇 Configure Preset如 `windows-x64`、`linux-x64` 等)
- 選擇 Build Preset執行設定與建置
@@ -174,7 +174,7 @@ MAA 使用一系列的格式化工具來確保倉庫中的程式碼和資源檔
| 檔案類型 | 格式化工具 |
| --------- | --------------------------------------------------------------- |
| C++ | [clang-format](https://clang.llvm.org/docs/ClangFormat.html) |
| Json/Yaml | [Prettier](https://prettier.io/) |
| JSON/YAML | [Prettier](https://prettier.io/) |
| Markdown | [markdownlint](https://github.com/DavidAnson/markdownlint-cli2) |
### 利用 Pre-commit Hooks 自動進行程式碼格式化

View File

@@ -162,4 +162,4 @@ amplified roi: 426, 272, 177, 201
## 提交您的修改
請參考 [Github Pull Request 指南](./pr-tutorial.md)
請參考 [GitHub Pull Request 指南](./pr-tutorial.md)

View File

@@ -3,7 +3,7 @@ order: 8
icon: iconoir:code-brackets
---
# 專用 VSCode 擴充功能教學
# 專用 VS Code 擴充功能教學
此擴充功能針對 MaaAssistantArknights/MaaFramework 提供了一系列便利開發的功能,包括但不限於以下項目:
@@ -14,7 +14,7 @@ icon: iconoir:code-brackets
## 安裝
推薦直接在 VSCode 的擴充功能清單中搜尋 `Maa` 進行安裝。
推薦直接在 VS Code 的擴充功能清單中搜尋 `Maa` 進行安裝。
::: tip
首次使用時,擴充功能會自動下載預設版本的資源。
@@ -90,7 +90,7 @@ icon: iconoir:code-brackets
### 截圖裁剪與快速辨識
在 VSCode 的命令面板中搜尋並執行 `Maa: 開啟截圖工具`,即可開啟 `截圖 / 裁剪` 面板。
在 VS Code 的命令面板中搜尋並執行 `Maa: 開啟截圖工具`,即可開啟 `截圖 / 裁剪` 面板。
> 使用 `Ctrl + Shift + P` (macOS 為 `Command + Shift + P`) 呼叫命令面板。
@@ -112,11 +112,11 @@ icon: iconoir:code-brackets
#### MaaFramework 日誌
在 VSCode 的命令面板中搜尋並執行 `Maa: 開啟 maa 日誌`,可查看偵錯期間產生的 `maa.log` 日誌。
在 VS Code 的命令面板中搜尋並執行 `Maa: 開啟 maa 日誌`,可查看偵錯期間產生的 `maa.log` 日誌。
#### MAA Pipeline Support 擴充功能日誌
在 VSCode 的命令面板中搜尋並執行 `Maa: 開啟插件日誌`,可查看擴充功能運作期間產生的 `mse.log` 日誌。
在 VS Code 的命令面板中搜尋並執行 `Maa: 開啟插件日誌`,可查看擴充功能運作期間產生的 `mse.log` 日誌。
### 底部狀態列

View File

@@ -335,7 +335,7 @@ address = "127.0.0.1:7777" # 如果您需要的話,可以覆蓋預設的位址
#### 特殊預設
目前預先配置了兩種預設,為 `PlayCover (MacOS)`, `Waydroid (Linux)`
目前預先配置了兩種預設,為 `PlayCover (macOS)`, `Waydroid (Linux)`
- `PlayCover` 用於在 macOS 上連線直接透過 `PlayCover` 原生執行的遊戲客戶端。這種情況下不需要指定 `adb_path``address` 不是 `adb` 連線的位址而是 `PlayTools` 的位址,具體使用方式可參考 [PlayCover 支援文件][playcover-doc].

View File

@@ -9,9 +9,9 @@ icon: basil:apple-solid
### ✅ [PlayCover](https://playcover.io) 原生執行最流暢 🚀
實驗性支援,遇到問題請多加提交 Issue並在標題中提及 `MacOS`
實驗性支援,遇到問題請多加提交 Issue並在標題中提及 `macOS`
請注意:由於 `MacOS` 本身機制的限制,將遊戲視窗最小化、幕前排程 (Stage Manager) 狀態下切換到其他視窗、或將視窗移動到其他桌面 / 螢幕後,截圖會出現問題,導致無法正確執行。相關 Issue [#4371](https://github.com/MaaAssistantArknights/MaaAssistantArknights/issues/4371#issuecomment-1527977512)
請注意:由於 `macOS` 本身機制的限制,將遊戲視窗最小化、幕前排程 (Stage Manager) 狀態下切換到其他視窗、或將視窗移動到其他桌面 / 螢幕後,截圖會出現問題,導致無法正確執行。相關 Issue [#4371](https://github.com/MaaAssistantArknights/MaaAssistantArknights/issues/4371#issuecomment-1527977512)
0. 要求MAA 版本 v4.13.0-rc.1 以上

View File

@@ -367,7 +367,7 @@ You can cancel this popup by clicking the 「{key=Settings} - {key=IssueReport}
</system:String>
<system:String x:Key="GlobalSource">Global Source</system:String>
<system:String x:Key="ForceGithubGlobalSource">Force using GitHub</system:String>
<system:String x:Key="ForceGithubGlobalSourceTip">When updates are detected, force download update packages from Github</system:String>
<system:String x:Key="ForceGithubGlobalSourceTip">When updates are detected, force download update packages from GitHub</system:String>
<system:String x:Key="MirrorChyan">MirrorChyan</system:String>
<system:String x:Key="MirrorChyanSelectedButNoCdk">Please go to 「{key=Settings} - {key=UpdateSettings}」 to configure MirrorChyan CDK or switch to Global Source.</system:String>
<system:String x:Key="MirrorChyanResourceUpdateTip">Resource update {0} detected. Please go to 「{key=Settings} - {key=UpdateSettings} - {key=ResourceUpdate}」 to update manually, or fill in MirrorChayn CDK to update automatically.</system:String>
@@ -1031,9 +1031,9 @@ Right-click to clear inactive jobs</system:String>
<system:String x:Key="CopilotFileReadError">Failed to read file!</system:String>
<system:String x:Key="CopilotNoFound">No corresponding file found!</system:String>
<system:String x:Key="NetworkServiceError">Network service error!</system:String>
<system:String x:Key="CopilotJsonError">Copilot Json Error!</system:String>
<system:String x:Key="CopilotJsonError">Copilot JSON Error!</system:String>
<system:String x:Key="NotCopilotJson">Malformed file!</system:String>
<system:String x:Key="CheckTheFile">Malformed Copilot Json!</system:String>
<system:String x:Key="CheckTheFile">Malformed Copilot JSON!</system:String>
<system:String x:Key="CopilotSSSNotSupport">Unsupported type: SSS</system:String>
<system:String x:Key="CopilotInvalidStageNameForNavigation">Invalid stage name for navigation</system:String>
<system:String x:Key="CopilotStageNameNotFound">{0} not found, and also no stage name specified</system:String>
@@ -1272,9 +1272,9 @@ Before use, please ensure:
<!-- About -->
<system:String x:Key="Website">MAA Website</system:String>
<system:String x:Key="Github">Source code: GitHub</system:String>
<system:String x:Key="PrtsPlus">Copilot Json sharing site</system:String>
<system:String x:Key="PrtsPlus">Copilot JSON sharing site</system:String>
<system:String x:Key="MapPrts">Copilot Map and Coordinate</system:String>
<system:String x:Key="CustomInfrastGenerator">Custom Base Json Generator</system:String>
<system:String x:Key="CustomInfrastGenerator">Custom Base JSON Generator</system:String>
<system:String x:Key="QqGroup">QQ group</system:String>
<system:String x:Key="QqChannel">QQ channel</system:String>
<system:String x:Key="Telegram">Telegram</system:String>

View File

@@ -367,7 +367,7 @@
</system:String>
<system:String x:Key="GlobalSource">海外源</system:String>
<system:String x:Key="ForceGithubGlobalSource">强制使用 GitHub</system:String>
<system:String x:Key="ForceGithubGlobalSourceTip">检测到更新后,强制从 Github 下载更新包</system:String>
<system:String x:Key="ForceGithubGlobalSourceTip">检测到更新后,强制从 GitHub 下载更新包</system:String>
<system:String x:Key="MirrorChyan">Mirror酱</system:String>
<system:String x:Key="MirrorChyanSelectedButNoCdk">请前往 「{key=Settings} - {key=UpdateSettings}」 配置 Mirror酱 CDK 或切换海外源。</system:String>
<system:String x:Key="MirrorChyanResourceUpdateTip">检测到资源更新: {0}。请前往 「{key=Settings} - {key=UpdateSettings} - {key=ResourceUpdate}」 手动更新,或配置 Mirror酱 CDK 以自动更新。</system:String>
@@ -1622,7 +1622,7 @@ DEBUG 目录下保存的图片有数量限制,超出后会自动清理旧图
<system:String x:Key="Achievement.Lucky.Conditions">启动 MAA 时有极!小!概率触发</system:String>
<system:String x:Key="Achievement.CdnTorture.Title">网络折磨人</system:String>
<system:String x:Key="Achievement.CdnTorture.Description">比宇宙更远的地方,是 Github 的服务器。</system:String>
<system:String x:Key="Achievement.CdnTorture.Description">比宇宙更远的地方,是 GitHub 的服务器。</system:String>
<system:String x:Key="Achievement.CdnTorture.Conditions">下载资源失败超过 3 次</system:String>
<system:String x:Key="Achievement.AfkWatcher.Title">摇人挂机党</system:String>