README_en.md

MaaFramework

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

English | 简体中文

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

• Quick Start
• Integration
• Pipeline Protocol

Best Practices

• M9A 1999 Assistant
  The 1999 Assistant, based on a brand new architecture. Image technology + simulation control, freeing your hands! Powered by MaaFramework.

• MAABH3 Honkai Impact 3 Assistant
  A one-click tool for the daily tasks of Honkai Impact, based on a brand new architecture. Image technology + simulation control, freeing your hands! Powered by MaaFramework.

• MAALimbusCompany Limbus Company Assistant
  Based on a brand new architecture. Image technology + simulation control, freeing your hands! Powered by MaaFramework.

• MBA BA Assistant
  A BA Assistant based on MAA's new architecture. Image technology + simulation control, no more clicking! Powered by MaaFramework.

• MAS Skland Assistant
  Based on a brand new architecture. Image technology + simulation control, freeing your hands! Powered by MaaFramework.

• MRA Maa Resonance
  A Conductor Assistant based on MAA's new architecture. Image technology + simulation control, no more clicking! Powered by MaaFramework.

• MaaHatsuboshiTA Hatsuboshi Teaching Assistant
  A Tool For Producers PLaying Gakuen-Idolmaster. Powered by MaaFramework.

• MCCA CrossCore Assistant
  The CrossCore Assistant, based on a brand new architecture. Image technology + simulation control, freeing your hands! Powered by MaaFramework.

• MSBA Snow break Assistant !
  The Snow break Assistant, based on a brand new architecture. Image technology + simulation control, freeing your hands! Powered by MaaFramework.

• MaaAeonFantasy Aeon Fantasy Assistant !
  The Aeon Fantasy Assistant, based on a brand new architecture. Image technology + simulation control, let your hands do what they should do! Powered by MaaFramework.

• maa-whmx Wuhua Mixin Assistant
  An assistant for Wuhua Mixin based on a brand new architecture. Image technology + simulation control, freeing your hands! Powered by MaaFramework.

• MAA-for-Millennium-Tour Millennium Tour Assistant
  An assistant for Millennium Tour based on a brand new architecture. Image technology + simulation control, freeing your hands! Powered by MaaFramework.

• MFAWPF MFA Task Manager
  A Universal GUI based on MAA's new architecture. Powered by MaaFramework.

• MET Eternal Tree Assistant
  An assistant for Eternal Tree based on a brand new architecture. Image technology + simulation control, freeing your hands! Powered by MaaFramework.

• MaaYYs Onmyoji Assistant
  A brand new Onmyoji assistant powered by advanced architecture. Combining image recognition and simulated control, it automates daily tasks and frees your hands like a cyber-helper! Powered by MaaFramework!

• MaaJR Warship Girls R Assistant
  An assistant for Warship Girls R based on a brand new architecture. Image technology + simulation control, freeing your hands! Powered by MaaFramework.

• MPA Punishing Assistant
  The Punishing Gray Raven Assistant, based on a brand new architecture. Image technology + simulation control, freeing your hands! Powered by MistEO's Black Coffee 2.0.

• MaaYuan Ashes of the kingdom Assistant
  The Ashes of the kingdom Assistant, based on a brand new architecture. Image technology + simulation control, freeing your hands! Powered by MaaFramework.

Eco-Building

MAA is planned to be a category of projects rather than just a single piece of software.

If your project depends on MaaFramework, we welcome you to name it as MaaXXX, MXA, MAX, and so on. Of course, this is permission, not limitation. You can freely choose other names unrelated to MAA, depending on your own ideas!

We also welcome you to submit a PR to add your project to the best practices list above!

License

MaaFramework is open-sourced under the LGPL-3.0 license.

Development

Please note that you only need to read this chapter if you are ready to develop MaaFramework itself. If you only want to develop applications based on MaaFramework, please refer to Get Started.

• How to build
• API Design

Acknowledgments

Open Source Libraries

• opencv
  Open Source Computer Vision Library
• fastdeploy
  ⚡️An Easy-to-use and Fast Deep Learning Model Deployment Toolkit for ☁️Cloud 📱Mobile and 📹Edge. Including Image, Video, Text and Audio 20+ main stream scenarios and 150+ SOTA models with end-to-end optimization, multi-platform and multi-framework support.
• onnxruntime
  ONNX Runtime: cross-platform, high performance ML inferencing and training accelerator
• boost
  Boost provides free peer-reviewed portable C++ source libraries.
• meojson
  A modern all-platform Json/Json5 parser/serializer, which is header-only and used magic!
• minitouch
  Minimal multitouch event producer for Android.
• maatouch
  Android native implementation of minitouch input protocol
• minicap
  Stream real-time screen capture data out of Android devices.
• zlib
  A massively spiffy yet delicately unobtrusive compression library.
• gzip-hpp
  Gzip header-only C++ library
• protobuf
  Protocol Buffers - Google's data interchange format
• grpc
  The C based gRPC (C++, Python, Ruby, Objective-C, PHP, C#)
• thrift
  Apache Thrift

Developers

Thanks to the following developers for their contributions to MaaFramework:

Discussion

• QQ Group: 595990173