Notes Before Development

About 377 wordsAbout 1 min

Tips

You only need to read this page if you want to take part in the development of M9A! Users should refer to the M9A User Manual. For developing MaaFramework or your own projects, please visit MaaXYZ/MaaFramework.

A Brief Overview of the GitHub Pull Request Process

I don't know programming and just want to make small changes to JSON files/documents. What should I do?

Check out the GitHub Pull Request Guide for Beginners.

If you forked the repository a long time ago, go to Settings in your repository, scroll to the bottom, and delete it.
Open the M9A Main Repository, click Fork, and then click Create fork.
Clone your own repository locally and pull the submodules:
```
git clone --recursive https://github.com/<your-username>/M9A.git
```
Warning
Do not forget --recursive! Do not forget --recursive! Do not forget --recursive!
OCR failures are often caused by forgetting to include --recursive.
If you already cloned but find resources missing, run:
```
git submodule update --init --recursive
```
Copy the OCR model from the submodule:
```
python tools/configure.py
```

Set up the development environment:

Install Python 3.13
Install Node.js (≥24) and pnpm
Install uv (Python Package and Project Management Tool)
Download and install VSCode.

Optionally install debugging/development tools:

Tool	Description
MaaDebugger	Standalone debugging tool
Maa Pipeline Support	VSCode plugin for debugging, screenshots, ROI extraction, color picking, etc.
MFAToolsPlus	Cross-platform toolbox providing convenient data acquisition and simulation testing methods
ImageCropper(Not recommended)	Standalone tool for screenshots and ROI extraction
MaaLogAnalyzer	Visual analysis of logs from MaaFramework-based applications