目录

• 简介
• 功能亮点
• 速通模式
• 开发文档
• 常用命令行参数
• 外部通知
• 计划任务
• 热更新
• 动态加载自定义动作/识别器
• 使用 GitHub Action 自动构建
• 许可证
• 致谢

简介

MFW-ChainFlow Assistant 旨在为 MaaFramework 用户提供开箱即用的可视化运行器，覆盖配置管理、任务调度、通知联动以及自定义扩展，降低自动化流程的开发和运维成本。

功能亮点

• 完整支持 interface v2 协议 V2.9.1
• 跨平台支持：Windows / Linux / macOS
• 可带参数启动：指定配置 ID 与自动执行任务
• 外部通知：钉钉、飞书、SMTP、WxPusher、企业微信机器人、Gotify
• 内置计划任务：单次 / 每日 / 每周 / 每月，多策略执行
• 动态加载自定义动作与识别器的同时支持Agent，适配个性化流程
• 嵌入式 Agent：在 CFA_setting.json 中启用内置模式，自动转换为 custom 加载方式，使用 UI 内部环境，更小更轻盈
• 速通模式：按日 / 周 / 月限制运行次数与最小间隔，避免重复执行
• 热更新：资源仓库与本地 CFA_setting.json 的 update_flag 一致时自动启用，速度更快且无需重启

速通模式

• 在 interface.json 的任务节点下添加 speedrun 块定义周期与次数控制，并设置 speedrun.enabled: true 后生效。
• 支持 daily / weekly / monthly，配置运行次数与最小间隔，超限时自动跳过。
• 详细字段与示例见 docs/speedrun_mode.md。

开发文档

• 开发环境、启动调试、测试、i18n 与打包流程见 docs/development.md。

常用命令行参数

MFW 开关写在分隔符 -- 之前；之后仅传给 Qt。

• --config-id <ID>：使用指定配置 ID 启动（可用 --config-id=<ID>）
• --direct-run：启动后直接运行任务
• --force-restart：强制启动，会关闭同目录下正在运行的其他 MFW 实例
• --reuse-existing：优先复用已有实例；单独使用不会运行任务，只有同时指定 --direct-run 才会执行（已有实例忙时跳过；再与 --force-restart 同时使用时先停止当前任务再运行，不关闭进程）
• --dev：启用调试模式（显示测试页）

示例：

• MFW.exe --direct-run --force-restart --config-id c_xxx
• MFW.exe --direct-run --reuse-existing --config-id c_xxx

外部通知

当前支持：钉钉、飞书、SMTP、WxPusher、企业微信机器人、Gotify，可按需在配置中启用。

计划任务

支持单次、每日、每周、每月的定时运行，可选择强制启动或按队列执行，列表中可直接启用/禁用或删除计划。

热更新

在资源包根目录放置 CFA_setting.json，当本地与远端仓库中的 update_flag 字段一致时，会启用热更新模式，速度更快并且无需重启。

{
  "update_flag": "1",
  "embedded": false
}

兼容旧版：若不存在 CFA_setting.json，会回退读取 update_flag.txt（仅提供 update_flag，不含 embedded）。

动态加载自定义动作/识别器

参考 MaaFramework 的自定义动作/识别器说明：

1. 自定义动作/识别器需使用 Python 3.12。
2. 若包含第三方库，请在构建时将依赖纳入 MFW，或由独立 Agent 环境提供；macOS 上不要修改 MFW.app 内部文件。
3. 在 custom.json 中声明自定义对象，并在 interface.json 的 custom 键指出 custom.json 路径（{custom_path} 默认为仓库根目录下的 custom/）。
4. Pipeline 中通过名字引用自定义动作/识别器。

示例 custom.json 片段：

{
  "动作名字1": {
    "file_path": "{custom_path}/任意位置/任意名字_动作1.py",
    "class": "动作对象1",
    "type": "action"
  },
  "识别器名字1": {
    "file_path": "{custom_path}/任意位置/任意名字_识别器1.py",
    "class": "识别器对象1",
    "type": "recognition"
  }
}

在 pipeline 中引用：

"我的自定义任务": {
  "recognition": "Custom",
  "custom_recognition": "识别器名字1",
  "action": "Custom",
  "custom_action": "动作名字1"
}

自定义类示例：

class 动作对象1(CustomAction):
    def apply(self, context, ...):
        image = context.tasker.controller.cached_image
        # 在此处进行图像处理并返回结果

更多示例可参考仓库：MAA_Punish/assets。

嵌入式 Agent

在 CFA_setting.json 中设置 "embedded": true，系统会自动将 agent 转换为 custom 加载方式。这种方式使用 UI 内部环境运行，无需独立进程，资源占用更小、启动更快。热更新完成后，该值会同步写入 interface.json 的 agent.embedded 字段。

示例 CFA_setting.json：

{
  "update_flag": "1",
  "embedded": true
}

interface.json 中仍需保留 agent 入口配置，例如：

{
  "agent": {
    "child_args": ["{PROJECT_DIR}/agent/main.py"]
  }
}

启用内置模式后，系统会自动：

1. 复制 agent 入口目录
2. 自动生成对应的 custom.json 配置
3. 保留 agent 字段，并额外注入 custom 字段用于加载生成产物

使用 GitHub Action 自动构建

0. 注意:此方案只适用于使用maafw模板构建的项目
1. 将 deploy/install.yml 中的 MaaXXX 替换为你的项目名。
2. 提交并推送到 GitHub 仓库的 .github/workflows 目录。
3. 推送新版本后，GitHub Action 会自动构建发布。

自行打包

1. 根据自身需求下载对应系统和架构的项目资产
2. 将 interface.json、资源目录等代码或描述文件放入发行根
3. 运行

macOS 发行物使用 Nuitka app-dist，目录结构如下：

MFW/
├── MFW.app/
├── MFWUpdater/
│   └── MFWUpdater
├── maafw/
├── interface.json
├── resource/
├── bundle/
└── config/

请整体移动、解压或更新 MFW/ 目录，不要只移动 MFW.app。应用包保持只读，资源热更新写入外置 resource/ / bundle/；UI 全量更新由外置 MFW-Updater（MIT）独立仓库编译的 MFWUpdater/ 在主程序退出后整包替换 MFW.app。

许可证

MFW-PyQt6 使用 AGPL-3.0 许可证 开源。

致谢

开源项目

• PyQt-Fluent-Widgets
  A fluent design widgets library based on C++ Qt/PyQt/PySide. Make Qt Great Again.
• MaaFramework
  基于图像识别的自动化黑盒测试框架。
• MaaDebugger
  基于 MaaFramework 的调试器，用于查看和分析 MaaFramework 运行时的状态。
• AutoMAA
  明日方舟 MAA 插件，多账号管理与自动化工具。

思路灵感

• MFAAvalonia
  基于 Avalonia 的 MAAFramework 通用 GUI 项目 | A universal GUI project for MAAFramework based on Avalonia
  MFW-ChainFlow Assistant 参考了 MFAAvalonia 的布局,但未使用其任何源代码。

• MFWPH
  基于 MaaFramework 的 UI 启动器，可加载与管理多种自动化资源脚本
  MFW-ChainFlow Assistant 参考了 MFWPH 的布局,但未使用其任何源代码。

其他支持

• MirrorChyan
  Mirror酱更新服务
  MFW-ChainFlow Assistant 使用了 MirrorChyan 的更新服务。

开发者

感谢所有为 MFW-PyQt6 做出贡献的开发者。

完整贡献者列表请参阅 AUTHORS.md。