mirror of https://github.com/MaaAssistantArknights/MaaAssistantArknights.git synced 2026-07-16 01:40:46 +08:00

Files

yali-hzy c2716e4ac7 docs: 修正开发文档中的格式错误及笔误 (#15516 )

* fix: 修正开发指南中的格式

* docs: Apply suggestion from @sourcery-ai[bot]

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>

* fix: 修改 zh-tw 中 sln 为 slnx

---------

Co-authored-by: AnnAngela <naganjue@vip.qq.com>
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>

2026-01-30 20:43:59 +08:00

8.5 KiB

Raw Blame History

order, icon

order	icon
1	iconoir:developer

開発ガイド

::: tip 本ページは主に PR プロセスおよび MAA のファイルフォーマット要件について説明します。MAA の実行ロジックを変更する具体的な方法については、プロトコル文書を参照してください。 :::

::: tip DeepWiki に質問して、MAA プロジェクトの全体的なアーキテクチャを概要的に理解することができます。 :::

プログラミングの仕方がわからないので、JSONファイルやドキュメントなどを少し変更したいのですが、どうすればいいですか？

「パラスちゃん」も理解できるGitHubのPull Requestの使用ガイドへようこそ（純WebサイトのPRチュートリアル）

数行のコードを少しだけ変更したいが、環境設定が面倒。純粋なWeb編集も使いにくい。どうすればよいですか？

GitHub Codespacesオンライン開発環境をご利用ください！

次のような、異なる開発環境を事前に準備しています：

空白環境（裸のLinuxコンテナ）（デフォルト）
軽量環境：ドキュメントサイトのフロントエンド開発に適している
完全環境：MAA Core関連の開発に適している（使用は推奨しません。ローカル開発を推奨します。関連環境を完全に設定。次のセクションを参照）

完全な環境セットアップ（Windows）

かなり前にフォークした場合は、まず自分のリポジトリの Settings の一番下で削除します
MAA メインリポジトリを開き、Fork → Create fork をクリック
自身のリポジトリの dev ブランチをクローン（サブモジュール含む）
```
git clone --recurse-submodules <リポジトリの git リンク> -b dev
```
::: warning Visual Studio など --recurse-submodules パラメータに対応していない Git GUI を使用する場合、クローン後に以下を実行：
```
git submodule update --init
```
:::
事前ビルド済みサードパーティライブラリのダウンロード

Python環境が必要（インストール方法は各自検索）
（tools/maadeps-download.py はプロジェクトルートに配置）
```
python tools/maadeps-download.py
```
開発環境の設定
- CMake をダウンロードしてインストール
- Visual Studio 2026 Community をインストール時、C++ によるデスクトップ開発 と .NET デスクトップ開発 を選択必須

cmake プロジェクト設定を実行

mkdir -p build
cmake -G "Visual Studio 18 2026" -B build -DBUILD_WPF_GUI=ON -DBUILD_DEBUG_DEMO=ON

build/MAA.slnx をダブルクリックで開き、Visual Studio にプロジェクトを自動ロード
VS の設定
- 上部設定バーで Debug x64 を選択
- MaaWpfGui 右クリック → スタートアッププロジェクトに設定
- F5 キーを押して実行
::: tip Win32Controller（Windows ウィンドウ制御）関連機能をデバッグする場合は、MaaFramework Releases から対応プラットフォームのアーカイブをダウンロードし、bin ディレクトリ内の MaaWin32ControlUnit.dll を MAA の DLL と同じディレクトリ（例：build/bin/Debug）に配置してください。自動ダウンロードスクリプトの PR 歓迎！ :::
これで自由に改造開発を始められます
一定量の変更ごとにコミット（メッセージ記入必須）
Git 未経験者は dev ブランチ直接変更ではなく新規ブランチ作成推奨：
```
git branch your_own_branch
git checkout your_own_branch
```
これで dev の更新影響を受けずに開発可能
開発完了後、変更をリモートリポジトリへプッシュ：
```
git push origin dev
```
MAA メインリポジトリで Pull Request を提出（master ではなく dev ブランチを指定）
上流リポジトリの更新を同期する場合：
1. 上流リポジトリを追加：
```
git remote add upstream https://github.com/MaaAssistantArknights/MaaAssistantArknights.git
```
2. 更新を取得：
```
git fetch upstream
```
3. リベース（推奨）またはマージ：
```
git rebase upstream/dev
```
  または
```
git merge
```
4. ステップ8、9、10、11 を繰り返し

::: tip Visual Studio 起動後、Git 操作は「Git 変更」画面からコマンドライン不要で可能 :::

MAAのファイルフォーマット要件

MAAは、リポジトリ内のコードとリソースファイルが美しく統一されるよう、一連のフォーマットツールを使用してメンテナンスと読み取りを容易にしています。

提出する前にフォーマットするか、またはPre-commit Hooksを使用してコードを自動フォーマットしてください。

現在有効になっているフォーマットツールは次のとおりです：

ファイルタイプ	フォーマットツール
C++	clang-format
Json/Yaml	Prettier
Markdown	markdownlint

Pre-commit Hooksを使用してコードを自動フォーマット

コンピュータにPython環境とNode環境があることを確認してください。
プロジェクトのルートディレクトリで次のコマンドを実行します：
```
pip install pre-commit
pre-commit install
```

pipインストール後もPre-commitを実行できない場合は、PIPインストールパスがPATHに追加されていることを確認してください。

次に、提出するたびにフォーマットツールが自動的に実行され、コード形式がスタイルガイドに準拠していることを確認します。

Visual Studioでclang-formatを有効にする

clang-format バージョン20.1.0以上をインストールします。
```
python -m pip install clang-format
```
'Everything'などのツールを使用して、clang-format.exeのインストール場所を見つけます。参考までに、Anacondaを使用している場合、clang-format.exeはYourAnacondaPath/Scripts/clang-format.exeにインストールされます。
Visual Studioで、 Tools-Optionsで 'clang-format'を検索します。
clang-formatサポートを有効にする をクリックし、下の カスタムのclang-format.exeファイルを使用する を選択し、最初取得した clang-format.exe を選択します。

そうすれば、 Visual Studio は c++20 構文をサポートする clang-format を問題なく使用できます！

tools\ClangFormatter\clang-formatter.py を使用して、clang-formatを直接呼び出して書式設定することもできます。プロジェクトのルートディレクトリで

python tools\ClangFormatter\clang-formatter.py --clang-format=PATH\TO\YOUR\clang-format.exe --input=src\MaaCore

を実行するだけです。

8.5 KiB Raw Blame History Unescape Escape