ContextQMD
Back to Maaassistantarknights

MAA

docs/en-us/readme.md

6.9.212.5 KB
Original Source
<!-- markdownlint-disable -->

::: center

<!-- markdownlint-restore -->

MAA





<a href="https://deepwiki.com/MaaAssistantArknights/MaaAssistantArknights"></a>
<a href="https://trendshift.io/repositories/979" target="_blank"></a>

MAA stands for MAA Assistant Arknights

An Arknights assistant

Based on image recognition technology, complete all daily tasks with one click!

Development actively in progress ✿✿ヽ(°▽°)ノ✿

:::

Download and Installation

Please read the documentation and then visit the official website or Releases to download. Refer to Getting Started for installation instructions.

Key Features

  • Auto-farming sanity, drop item recognition and auto-uploading to Penguin Stats, Yituliu.
  • Intelligent base shift management, auto-calculating operator efficiency for optimal solutions within facilities; also supports customized scheduling.
  • Auto-recruitment with option to use expedited plans, clearing all at once! Auto-uploading recruitment data to Penguin Stats, Yituliu.
  • Manual recruitment tag identification for better high-star recruitment decisions (Will that Senior Operator tag give you SilverAsh or SilverAsh?)
  • Operator list recognition, counting owned and missing operators and their potentials, displayed during recruitment identification.
  • Material recognition and export to Penguin Stats Planner, Arknights Toolbox, ARK-NIGHTS Operator Builds.
  • Visiting friends, collecting credits and shopping, collecting daily rewards, etc. - one-click daily automation.
  • Fully automatic Integrated Strategy (IS) for farming Originium Ingots and levels, auto-farming and direct upgrades, smart operator recognition.
  • Select JSON copilot files for automatic stage clearing, Video demonstration.
  • Support for C, Python, Java, Rust, Golang, Java HTTP, Rust HTTP and other interfaces, easy integration and customization for your MAA!

See it in action!

<ImageGrid :imageList="[ { light: 'images/en-us/readme/1-light.png', dark: 'images/en-us/readme/1-dark.png' }, { light: 'images/en-us/readme/2-light.png', dark: 'images/en-us/readme/2-dark.png' }, { light: 'images/en-us/readme/3-light.png', dark: 'images/en-us/readme/3-dark.png' }, { light: 'images/en-us/readme/4-light.png', dark: 'images/en-us/readme/4-dark.png' } ]" />

Usage Instructions

Feature Introduction

Please refer to the User Manual.

Support for Overseas Clients

Most features now support Global (EN), Japanese, Korean, and Traditional Chinese servers. However, due to the smaller number of overseas users and limited project personnel, many features haven't been thoroughly tested, so please try them yourself.
If you encounter bugs or have specific feature requests, please let us know in Issues and Discussions, or join us to help improve MAA! Please refer to the Overseas Clients Adaptation section.

::: tip For Global (EN) server, due to interface layout issues, the only supported resolution is 1920x1080 :::

CLI Support

MAA supports command-line interface (CLI) operation on Linux, macOS, and Windows, useful for automation scripts or on servers without graphical interfaces. Please refer to the CLI Usage Guide

Join Us

Multilingual Support (i18n)

MAA uses Chinese (Simplified) as its primary language, and all translation entries are based on Chinese (Simplified).

Development Participation

Please refer to the Development Guide.

API

Overseas Clients Adaptation

Please refer to the Overseas Clients Adaptation Guide. For features already supported in the CN server, most adaptation work for overseas clients only requires screenshots + simple JSON modifications.

Issue bot

Please refer to the Issue Bot Usage Guide

Acknowledgements

Open-source Libraries

Data Sources

Contributors

Thanks to all friends who have participated in development and testing - your help makes MAA better and better! (*´▽｀)ノノ

Disclaimer

  • This software is open source under the GNU Affero General Public License v3.0 only license, with additional Terms of Service.
  • The software's logo is NOT licensed under AGPL 3.0. The artists 耗毛, vie, and all the software developers reserve all rights. The logo must not be used without authorization, even with AGPL 3.0 license claims, and must not be used for any commercial purposes without authorization.
  • This software is open source and free, intended only for learning and communication purposes. If you encounter merchants using this software for paid services, they may be charging for equipment and time costs; any problems and consequences arising from this are not related to this software.

DirectML Support Information

This software supports GPU acceleration, which relies on Microsoft's standalone component DirectML on Windows. DirectML is not part of this project's open-source components and is not subject to AGPL 3.0. For user convenience, we include an unmodified DirectML.dll file with the installation package. If you don't need GPU acceleration, you can safely delete this DLL file, and the core functionality will still work normally.

Community

User Exchange QQ Groups: MAA Usage & Arknights Exchange QQ Group
Discord Server: Invite Link
User Exchange Telegram Group: Telegram Group
Auto-battle JSON strategy sharing: prts.plus
Bilibili Live: MrEO Live coding streams & MAA-Official Live gaming/chat

Technical Group (non-Arknights, no casual chat): Internal Competition Hell! (QQ Group)
Developer Group: QQ Group

If you find the software helpful, please give us a Star! ~ (the small star at the top right of the webpage), that's the biggest support