MAA助手明日方舟项目开发环境搭建指南

项目概述

MAA助手明日方舟是一款为《明日方舟》游戏设计的自动化辅助工具，采用C++和.NET技术栈开发。本文将详细介绍如何搭建完整的开发环境，帮助开发者快速上手项目开发工作。

开发环境准备

基础工具安装

1. Git版本控制系统：用于代码版本管理
2. Visual Studio 2022 Community版：主开发IDE
   • 安装时需勾选"C++桌面开发"和".NET桌面开发"工作负载
3. Python环境：建议3.7+版本，用于脚本执行

代码获取与初始化

1. 克隆项目仓库（包含子模块）：

   git clone --recurse-submodules <仓库地址> -b dev
   

2. 若使用不支持子模块的GUI工具，需额外执行：

   git submodule update --init
   

3. 下载预编译依赖库：

   python maadeps-download.py
   

Visual Studio配置

1. 打开项目解决方案文件MAA.sln
2. 配置构建选项：
   • 选择RelWithDebInfo x64配置（发布构建/ARM平台可跳过）
3. 启用C++调试支持：
   • 右键MaaWpfGui项目 → 属性 → 调试 → 启用本机代码调试

代码规范与格式化

格式化工具配置

MAA项目使用多种格式化工具保持代码风格统一：

文件类型	格式化工具
C++	clang-format
Json/Yaml	Prettier
Markdown	markdownlint

自动格式化设置

1. 安装pre-commit工具：

   pip install pre-commit
   pre-commit install
   

2. 配置Visual Studio的clang-format：

   • 安装clang-format 20.1.0+版本
   • 在VS选项中找到clang-format设置
   • 启用自定义clang-format.exe路径

开发工作流程

1. 创建开发分支（推荐）：

   git branch your_branch
   git checkout your_branch
   

2. 定期提交代码变更（需填写有意义的提交信息）

3. 同步上游仓库变更：

   git remote add upstream <主仓库地址>
   git fetch upstream
   git rebase upstream/dev
   

4. 推送变更到个人仓库：

   git push origin your_branch
   

开发建议

1. 分支管理：建议在dev分支基础上创建特性分支开发，避免直接修改dev分支
2. 代码风格：提交前确保代码已格式化，保持风格统一
3. 调试技巧：利用VS的Git变更面板简化版本控制操作
4. 文档更新：代码变更涉及功能调整时，同步更新相关文档

常见问题解决

1. 子模块初始化失败：检查网络连接，必要时手动初始化子模块
2. 格式化工具不生效：确认pre-commit已正确安装，检查相关配置文件
3. 构建错误：确保所有依赖项已正确安装，特别是C++开发组件

通过以上步骤，开发者可以快速搭建MAA项目的完整开发环境，开始贡献代码或进行二次开发。项目采用规范的开发流程和代码风格，建议新开发者在熟悉这些规范后再进行实质性代码修改。