MaaFramework

✨ An automation black-box testing framework based on image recognition ✨

English | 简体中文

[!NOTE] This document is a machine-translated version of the original Chinese text. In case of any discrepancies, omissions, or ambiguities, the Chinese version shall prevail.

Introduction

MaaFramework is a next-generation automation black-box testing framework, completely rewritten and refined based on image recognition technology and the development experience of MAA.

It offers low-code simplicity while maintaining high extensibility. The framework aims to create a rich, leading-edge, and practical open-source library, empowering developers to easily write better black-box test programs and promoting widespread use.

Get Started

[!TIP] Visit our website for a better documentation experience.
Can't find the relevant documents? Try asking AI !
Discover more community-contributed skills, pipelines, customs, and experiences on MaaHub.

• Quick Start & Terms
• Integration & API
• Pipeline Low-code Protocol
• Project Interface Protocol

Community Project

Generic UI

• MFAAvalonia
  A generic GUI based on Avalonia. Powered by MaaFramework!

• MFW-PyQt6
  A generic GUI based on PyQt6. Powered by MaaFramework!

• MXU
  A lightweight cross-platform generic GUI based on Tauri 2 + React. Powered by MaaFramework!

• MWU
  A lightweight cross-platform generic WebUI based on Vue + FastAPI. Powered by MaaFramework!

Development Tool

• MaaDebugger
  MaaFramework Pipeline Debugger

• maa-support-extension
  MaaFramework VSCode Extension

• MFAToolsPlus
  A cross-platform development toolbox built on the Avalonia framework, providing convenient data acquisition and simulation testing methods.

• MaaPipelineEditor
  Visual reading and construction Pipeline, fully functional, extremely lightweight cross-platform, progressive local function extension, seamless compatibility between old and new projects.

• MaaInspector
  A visual editor based on vue-flow — a simple and user-friendly MaaFramework Pipeline Editor that integrates node preview, editing, and debugging all in one.

• MaaLogAnalyzer
  MaaFramework log analysis tool, providing user-friendly, multi-perspective visual analysis of task execution processes.

• MaaLogs
  MaaFramework log analysis tool that supports multi-project log parsing, visual task processes, and AI intelligent analysis.

• prettier-plugin-maafw-sort
  Prettier plugin that sorts pipeline keys according to lifecycle order.

• Auto Green Background
  An automatic green screen painting tool (Python/OpenCV, for TemplateMatch), supporting multi-algorithm segmentation, fixed canvas output, real-time preview, and a portable, out-of-the-box package.

• maafw-cli
  A MaaFramework command-line interface (CLI) for AI Agents.

• maaframework-skills
  Claude Code skill for MaaFramework — structured reference docs for AI-assisted pipeline development.

• MaaOWM
  A MaaFramework multi-resource-pack development tool. Mount: merges base+mod into a full-field workspace; Unmount: diffs out a minimal mod delta.

• create-maa-project
  MaaFW project scaffolding CLI & MCP Server for interactive creation and incremental maintenance of Pipeline / Agent projects.

Application

• M9A ![Pipeline](https://img.shields.io/badge/Pipeline-%23876f69?logo=