Files
MaaAssistantArknights/README.md
2022-06-18 22:02:15 +08:00

169 lines
7.6 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<div align="center">
<img alt="LOGO" src="https://user-images.githubusercontent.com/18511905/148931479-23aef436-2fc1-4c1e-84c9-bae17be710a5.png" width=360 height=270/>
# MaaAssistantArknights
<br>
<div>
<img alt="C++" src="https://img.shields.io/badge/c++-17-%2300599C?logo=cplusplus">
</div>
<div>
<img alt="platform" src="https://img.shields.io/badge/platform-Windows%20%7C%20Linux%20%7C%20macOS-blueviolet">
</div>
<div>
<img alt="license" src="https://img.shields.io/github/license/MaaAssistantArknights/MaaAssistantArknights">
<img alt="commit" src="https://img.shields.io/github/commit-activity/m/MaaAssistantArknights/MaaAssistantArknights?color=%23ff69b4">
<img alt="stars" src="https://img.shields.io/github/stars/MaaAssistantArknights/MaaAssistantArknights?style=social">
</div>
<br>
[README in English](README-en.md)
MAA 的意思是 MAA Assistant Arknights
一款明日方舟游戏小助手
基于图像识别技术,一键完成全部日常任务!
绝赞更新中 ✿✿ヽ(°▽°)ノ✿
</div>
## 亮点功能
- 刷理智,掉落识别及上传 [企鹅物流](https://penguin-stats.cn/)
- 智能基建换班,自动计算干员效率,单设施内最优解
- 自动公招,可选使用加急许可,一次全部刷完
- 访问好友、收取信用及购物、领取日常奖励等。一键全日常自动长草!
- 肉鸽全自动刷源石锭和蜡烛,自动识别干员及练度
- **新功能!导入作业 JSON 文件,自动抄作业!** [视频演示](https://www.bilibili.com/video/BV14u411673q/)
话不多说,看图!
![image](https://user-images.githubusercontent.com/99072975/172044929-3aae01a1-6c6d-4a9a-a7a8-ae753679b9ce.png)
![image](https://user-images.githubusercontent.com/99072975/172045492-698ab7fd-0413-4b08-aad7-0176f9480c05.png)
![image](https://user-images.githubusercontent.com/99072975/172045163-e9ead337-eb62-4f9f-a354-9e302f767a52.png)
## 下载地址
[稳定版](https://github.com/MaaAssistantArknights/MaaAssistantArknights/releases/latest)
[测试版](https://github.com/MaaAssistantArknights/MaaAssistantArknights/releases)
下载太慢?尝试使用 fastgit 镜像
[fastgit 镜像稳定版](https://hub.fastgit.xyz/MaaAssistantArknights/MaaAssistantArknights/releases/latest)
[fastgit 镜像测试版](https://hub.fastgit.xyz/MaaAssistantArknights/MaaAssistantArknights/releases)
## 使用说明
### 基本说明
1. 请根据 [模拟器支持情况](docs/模拟器支持.md),进行对应的操作。
2. 解压压缩包,到 **没有中文或特殊符号** 的文件夹路径。
3. 开始运行后,除 `自动关机` 外,所有设置均不可再修改。
目前仅对 `16:9` 分辨率支持较好,最低支持 `1280 * 720`,更高不限。非 `16:9` 分辨率可能会有奇奇怪怪的问题,~~正在进一步适配中~~ 咕了_(:з」∠)_
更多使用说明请参考 [详细介绍](docs/详细介绍.md)
## 常见问题
- 软件一打开就闪退
- 连接错误、不知道 adb 路径怎么填写
- 识别错误/任务开始后一直不动、没有反应
- 如何连接自定义端口
请参考 [常见问题](docs/常见问题.md)
## 外服支持
- 国际服(美服)
支持基本的刷理智、公招识别功能,请参考 [说明](resource/global/YoStarEN/readme.md)
- 其他服
计划适配中……
## 主要关联项目
- 全新 GUI: [MaaAsstElectronUI](https://github.com/MaaAssistantArknights/MaaAsstElectronUI) (正在开发中,欢迎加入!)
- 更新服务器: [MaaDownloadServer](https://github.com/MaaAssistantArknights/MaaDownloadServer) (正在开发中,欢迎加入!)
- 自动战斗作业服务器: [MaaCopilotServer](https://github.com/MaaAssistantArknights/MaaCopilotServer) (正在开发中,欢迎加入!)
- [MAA 官网!](https://www.maa.plus): [maa-website](https://github.com/MaaAssistantArknights/maa-website) (正在开发中,欢迎加入!)
## 致谢
### 开源库
- 图像识别库:[opencv](https://github.com/opencv/opencv.git)
- ~~文字识别库:[chineseocr_lite](https://github.com/DayBreak-u/chineseocr_lite.git)~~
- 文字识别库:[PaddleOCR](https://github.com/PaddlePaddle/PaddleOCR)
- ~~关卡掉落识别:[企鹅物流识别](https://github.com/penguin-statistics/recognizer)~~
- 地图格子识别:[Arknights-Tile-Pos](https://github.com/yuanyan3060/Arknights-Tile-Pos)
- C++ JSON库[meojson](https://github.com/MistEO/meojson.git)
- C++ 运算符解析器:[calculator](https://github.com/kimwalisch/calculator)
- ~~C++ base64编解码[cpp-base64](https://github.com/ReneNyffenegger/cpp-base64)~~
- C++ 解压压缩库:[zlib](https://github.com/madler/zlib)
- C++ Gzip封装[gzip-hpp](https://github.com/mapbox/gzip-hpp)
- WPF MVVW框架[Stylet](https://github.com/canton7/Stylet)
- WPF控件库[HandyControl](https://github.com/HandyOrg/HandyControl)
- C# JSON库: [Newtonsoft.Json](https://github.com/JamesNK/Newtonsoft.Json)
- 下载器:[aria2](https://github.com/aria2/aria2)
### 数据源
- ~~公开招募数据:[明日方舟工具箱](https://www.bigfun.cn/tools/aktools/hr)~~
- 干员及基建数据:[PRTS明日方舟中文WIKI](http://prts.wiki/)
- 关卡数据:[企鹅物流数据统计](https://penguin-stats.cn/)
- 材料数据:[明日方舟bot常用素材](https://github.com/yuanyan3060/Arknights-Bot-Resource)
### 贡献/参与者
感谢所有参与到开发/测试中的朋友们,是大家的帮助让 MAA 越来越好! (*´▽`)
[![Contributors](https://contributors-img.web.app/image?repo=MaaAssistantArknights/MaaAssistantArknights)](https://github.com/MaaAssistantArknights/MaaAssistantArknights/graphs/contributors)
## 开发相关
### Windows
直接使用 Visual Studio 2019 ~~或更高版本~~ 打开 `MeoAssistantArknights.sln` 即可,所有环境都是配置好的
### Linux | macOS
请参考 [Linux 编译教程](docs/Linux编译教程.md)
### API
- [C 接口](include/AsstCaller.h)[集成示例](tools/TestCaller/main.cpp)
- [Python 接口](src/Python/asst.py)[集成示例](src/Python/sample.py)
- [Golang 接口](src/Golang/maa/)[集成示例](src/Golang/cli.go)(已停止维护 orz
- [Dart 接口](src/dart/)
- [Java 接口](src/Java/Maaj/src/main/java/com/iguigui/maaj/easySample/MeoAssistant.java)[集成示例](src/Java/Maaj/src/main/java/com/iguigui/maaj/easySample/MaaJavaSample.java)
- [HTTP接口](src/Java/Maaj/Readme.md)
- [集成文档](docs/集成文档.md)
- [回调消息协议](docs/回调消息协议.md)
- [任务流程协议](docs/任务流程协议.md)
- [自动抄作业协议](docs/战斗流程协议.md)
### Github PR 流程简述
[写给萌新的发电全流程](docs/写给萌新的发电全流程.md)
## 声明
- 本软件 logo 并非使用 AGPL 3.0 协议开源,画师 [耗毛](https://weibo.com/u/3251357314) 及软件全体开发者保留所有权利。不得以 AGPL 3.0 协议已授权为由在未经授权的情况下使用本软件 logo, 不得在未经授权的情况下将本软件 logo 用于任何商业用途。
- 本软件开源、免费,仅供学习交流使用。若您遇到商家使用本软件进行代练并收费,可能是设备与时间等费用,产生的问题及后果与本软件无关。
## 广告
[B 站直播间](https://live.bilibili.com/2808861):每晚直播敲代码,近期很长一段时间应该都是在写本软件~
[技术交流 & 吹水群](https://jq.qq.com/?_wv=1027&k=ypbzXcA2):内卷地狱!(明日方舟弱相关)
[自动战斗 JSON 作业分享群](https://jq.qq.com/?_wv=1027&k=1giyMpPb)
[开发者群](https://jq.qq.com/?_wv=1027&k=JM9oCk3C)
如果觉得软件对你有帮助,帮忙点个 Star 吧!~(网页最上方右上角的小星星),这就是对我们最大的支持了!