Skip to content

项目结构

sh
.
├── .github/                      # GitHub 相关配置
    ├── ISSUE_TEMPLATE/           # Issue 模板
    ├── workflows/                # GitHub Actions 工作流
    └── cliff.toml                # 变更日志生成配置
├── .vscode/                      # VSCode 编辑器配置
    ├── extensions.json           # 推荐扩展列表
    └── settings.json             # 项目设置
├── agent/                        # Agent模块代码
    ├── my_reco.py                # 自定义识别示例
    ├── my_action.py              # 自定义动作示例
    └── main.py                   # 主入口文件
├── assets/                       # 资源文件目录
    ├── config/                   # MaaPi 配置目录
        └── maa_pi_config.json    # MaaPi 配置文件
    ├── MaaCommonAssets/          # MAA 公共资源(子模块)
    ├── resource/                 # 项目资源文件
        ├── base/                 # 图像资源与 pipeline 基础节点
        ├── tasks/                # 任务组合配置
        └── default_pipeline.json # 默认任务流程配置
    └── interface.json            # MaaFramework 标准化项目结构声明
├── deps/                         # MaaFramework 依赖库(schema)
    └── tools/                    # JSON Schema 文件
├── docs/                         # 文档目录
    ├── .vitepress/               # 文档站配置与主题
        ├── theme/                # 自定义主题
        └── config.mts            # VitePress 配置文件
    ├── en_us/                    # 英文文档
    ├── zh_cn/                    # 中文文档
    ├── public/                   # 文档资源(图片等)
    ├── .markdownlint.yaml        # Markdown 代码检查配置
    └── index.md                  # 文档首页
├── tools/                        # 工具脚本目录
    ├── ci/                       # CI 相关脚本
        ├── sync_with_alist.py    # Alist 分发同步脚本
        ├── install.py            # 打包相关脚本
        └── configure.py          # OCR模型安装脚本
    ├── requirements.txt          # Python 依赖列表
    └── validate_schema.py        # Schema 校验脚本
├── .gitignore                    # Git 忽略文件配置
├── .gitmodules                   # Git 子模块配置
├── .pre-commit-config.yaml       # 预提交钩子配置
├── .prettierrc                   # 代码格式化配置
├── check_resource.py             # 资源完整性检查脚本
├── logo.ico                      # 项目图标
├── LICENSE                       # 许可证文件
├── README.md                     # 中文说明文档
├── package-lock.json             # npm 依赖锁定文件
├── package.json                  # Node.js 项目配置
└── prettierrc.txt                # 额外 Prettier 配置文件