e461208bf9
格式化工具部分： 1. pre-commit 引入 python 的格式化工具，包括 black（代码格式化）和 isort（对“包导入顺序”的规范） 2. 允许 prettier 对文档站的 markdown 文件格式化 3. 不允许 prettier 对 markdown 文件中的代码块的代码本身进行格式化 4. 升级了 pre-commit 的各个 hook 的版本 5. 优化了 pre-commit 的日志文本显示 容器总览部分： 1. 由原来的单一轻量环境转为区分空环境、轻量环境和全量环境 2. 空环境是裸 Linux 镜像（Ubuntu），为默认环境 3. 轻量环境适合开发文档站前端 4. 全量环境适合开发 MaaCore 5. 目前，全量环境完整包含了轻量环境，轻量环境完整包含了空环境 6. 在仓库 README.md 中更新了三个环境的描述，并将链接分别设置为对应环境的创建链接 **注意：没有修改文档站中的对应文件** 7. 在各个语言的开发指南的最后，移除了 Codespace 部分的“安装额外依赖”相关描述，且将链接设置为全量环境的创建链接 **注意：没有添加“开发文档站”的指南和对应 codespace 的使用方式** 容器的轻量环境和全量环境共有部分： 1. 安装 black 和 isort 包 2. 调整 VS Code 设置，取消先前（对 markdown 文件单独指定 markdownlint 扩展作为格式化工具）的错误设置，现在 markdown 文件仍然使用默认的 prettier 扩展作为格式化工具 3. 引入 markdown-all-in-one 扩展作为语法提示工具 4. 将 node_modules 和 3rdparty 排除在 VS Code 的文本的搜索路径之外 容器的全量环境部分： 1. 为 tools 下的所有 python 脚本安装依赖 2. 使用 tools/maadeps-download.py 下载 maadeps，且将必要二进制文件软链接到 /usr/local/bin/ 3. 使用 apt 安装 cmake 和 clangd-20，将后者通过 update-alternatives 设置为系统 clangd 的默认版本 4. 使用 cmake tools 扩展，并按照 Linux 编译方法进行配置 5. 使用 clang-format 作为 c/cpp 的格式化工具，clang-format 程序主体来自 maadeps（已经软链接到 /usr/local/bin/） 6. 使用 clangd 作为 c/cpp 的语法提示工具 7. 将 MaaDeps、install 和 build 排除在 VS Code 的文本搜索路径之外 其它手动调整： 1. 更新文档站的 package.json，指定 pnpm 包管理器的版本 2. 手动保证 markdown 文件中的列表前后有空行（注意到 MarkdownLint 官方规则不一定能精准定位所有“列表前后空行”的问题，详见：https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md032---lists-should-be-surrounded-by-blank-lines ） 3. 修改了部分 markdown 文件中的 json 代码块的语法问题 **注意：相同的问题并未全部发现，仅修改了两处** 4. 在 tools 目录中，一处 python 脚本的包名误用（本地包名和某个 pip 包重名），这里修改了相应代码 5. 在 tools 目录中，一处 python 脚本使用了弃用的包 cchardet 的问题，这里更换了推荐使用的功能相近的包并修改了相应代码 自动化脚本提交的修改： 1. 自动格式化了大量 tools 中的 python 脚本 2. 自动格式化了大量 docs 中的 markdown 文件 Commits: * chore: pre-commit引入black和isort规范py文件 * chore: Auto update by pre-commit hooks [skip changelog] * chore: devcontainer添加isort扩展，排序python导入 * chore: pre-commit任务命名及更名 * style: isort fix * chore: Auto update by pre-commit hooks [skip changelog] * chore: 更新pre-commit的hook版本 * fix: 模块名与第三方库重名，大忌 * chore: 容器构建时额外安装isort * docs: md -> markdown * chore: 容器安装python包和maadeps * fix: 修复过时python包 * chore: 指定pnpm版本 * chore: container支持选择轻量环境 * chore: 去掉rust * chore: add plain env * chore: 使用clangd语言服务器 * chore: 无需单独设置markdown的格式化工具 * chore: 更新安装的clangd版本 * docs: 简易文档适配 * docs: 在仓库README中重新编排codespaces相关指引 * chore: Auto update by pre-commit hooks [skip changelog] * style: 调整缩进 * chore: 格式化工具不用特意排除被gitignore忽略的文件 * chore: sh文件在gitattributes中单列一类 * chore: 格式化docs下的markdown文件 * chore: 暂时不修改md文件中的代码块 * style: 人为明确markdown中的部分列表相关格式 * docs: 补上部分markdown的json代码块中缺失的逗号 * chore: Auto update by pre-commit hooks [skip changelog] * chore: Auto update by pre-commit hooks [skip changelog] * fix: 补上tools的服务器排序相关代码中缺失的逗号 Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * chore: 使用maadeps的clangd * build: 更新maadeps工具链版本 * style: prettier fix * revert: 还原maadeps版本 * revert: 取消使用maadeps的clangd依赖，改用系统apt安装 --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
icon, index, dir
| icon | index | dir | ||
|---|---|---|---|---|
| ic:round-home | true |
|
::: center
MAA
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!
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
Main Related Projects
The project team is currently in great need of front-end developers. If you have relevant experience, we welcome you to join us!
- New Framework: MaaFramework
- Copilot Site Frontend: maa-copilot-frontend
- Copilot Site Backend: MaaBackendCenter
- Official Website: Frontend
- Deep Learning: MaaAI
Multilingual Support (i18n)
MAA uses Chinese (Simplified) as its primary language, and all translation entries are based on Chinese (Simplified).
Development Participation
Windows
Please refer to the Development Prerequisites.
Linux | macOS
Please refer to the Linux Build Tutorial.
APIs
- C interface: Integration Example
- Python interface: Integration Example
- Golang interface: Integration Example
- Dart interface
- Java interface: Integration Example
- Java HTTP interface
- Rust interface: HTTP interface
- TypeScript interface
- Woolang interface: Integration Example
- Integration Documentation
- Callback Message Protocol
- Task Workflow Protocol
- Auto-Copilot Protocol
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.
Want to contribute but not familiar with GitHub?
GitHub Pull Request Process Overview
Issue Bot
Please refer to the Issue Bot Usage Guide
Acknowledgements
Open-source Libraries
- Image recognition library: opencv
Text recognition library: chineseocr_lite- Text recognition library: PaddleOCR
- Deep learning deployment library: FastDeploy
- Machine learning accelerator: onnxruntime
Stage drop recognition: Penguin Stats Recognizer- Map tile recognition: Arknights-Tile-Pos
- C++ JSON library: meojson
- C++ operator parser: calculator
C++ base64 encoding/decoding: cpp-base64- C++ compression library: zlib
- C++ Gzip wrapper: gzip-hpp
- Android touch event generator: Minitouch
- Android touch event generator: MaaTouch
- WPF MVVM framework: Stylet
- WPF control library: HandyControl -> HandyControls
- C# logging: Serilog
- C# JSON library: Newtonsoft.Json & System.Text.Json
Downloader: aria2
Data Sources
Recruitment data: Arknights ToolboxOperator and base data: PRTS Wiki- Stage data: Penguin Statistics
- Game data and resources: Arknights Client Resources
- Game data: Arknights Yostar Game Data
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