Project Structure

Project Structure

Below is the project structure and its description.

`.github`

GitHub configuration.

`.github/ISSUE_TEMPLATE`

GitHub issue templates.

`.github/workflows`

GitHub workflow configurations.

`.github/cliff.toml`

Cliff configuration (used for automatically generating release notes).

`.vscode`

VSCode configuration.

`agent`

Contains code related to the agent.

`agent/custom`

Custom actions/recognition.

`agent/custom/action`

Custom actions.

`agent/custom/reco`

Custom recognition.

`agent/utils`

Utility functions.

`agent/main.py`

Processes before starting the agent and starts the AgentServer.

`assets`

Contains project resource files.

`assets/MaaCommonAssets`

Contains Maa common resources, such as OCR models.

`assets/resource`

Contains project resource files.

`assets/resource/base`

Contains official server resources, which serve as the base for other server resources.

`assets/resource/base/image`

Contains template images.

`assets/resource/base/model`

Contains OCR models, neural network classification models, and neural network detection models. Cooking Guide

`assets/resource/base/pipeline`

JSON files describing task pipelines, written according to the Task Pipeline Protocol.

`assets/resource/base/default_pipeline.json`

Sets default properties in the pipeline, refer to default_pipeline.json.

`assets/resource/bilibili`

Contains resources for the Bilibili server, overriding official server resources.

`assets/resource/global_en`

Contains resources for the global English server, overriding official and Japanese server resources.

`assets/resource/global_jp`

Contains resources for the Japanese server, overriding official server resources.

`assets/resource/cn.json`

Contains activity information for the CN server.

`assets/resource/en.json`

Contains activity information for the EN server.

`assets/resource/jp.json`

Contains activity information for the JP server.

`assets/interface.json`

A standardized project structure declaration for MaaFramework, following the Project Interface Protocol.

`deps`

Contains dependencies (extract the MaaFramework release package here).

`docs`

User manuals and development documentation.

`docs/zh_cn`

Chinese documentation.

`docs/zh_cn/develop`

Chinese Development documentation.

`docs/zh_cn/manual`

Chinese User manuals.

`docs/en_us`

English documentation.

`docs/en_us/develop`

English Development documentation.

`docs/en_us/manual`

English User manuals.

`docs/.markdownlint.yaml`

Markdownlint configuration.

`tools`

Project tools.

`tools/ci`

Tools used only in CI.

`tools/configure.py`

Configuration tool, copies MaaCommonAssets to the resource directory.

`tools/install.py`

Installation tool, assembles source code and dependencies into the install directory.

`.gitignore`

Git ignore list.

`.gitmodules`

Git submodules.

`.pre-commit-config.yaml`

Pre-commit configuration.

`.prettierrc`

Prettier configuration file.

`LICENSE`

Open source license.

`package-lock.json&package.json`

Prettier dependencies.

`README.html`

Project description.

`requirements.txt`

Dependencies required for the agent (Python).