diff --git a/README.md b/README.md index e047a1d..2b15978 100644 --- a/README.md +++ b/README.md @@ -1,129 +1,127 @@ - -

- LOGO -

-
-# MaaPracticeBoilerplate - -
- -本仓库为 [MaaFramework](https://github.com/MaaXYZ/MaaFramework) 所提供的项目模板,开发者可基于此模板直接创建自己的 MaaXXX 项目。 +LOGO -> **MaaFramework** 是基于图像识别技术、运用 [MAA](https://github.com/MaaAssistantArknights/MaaAssistantArknights) 开发经验去芜存菁、完全重写的新一代自动化黑盒测试框架。 -> 低代码的同时仍拥有高扩展性,旨在打造一款丰富、领先、且实用的开源库,助力开发者轻松编写出更好的黑盒测试程序,并推广普及。 +# MaaMihoyoBBS -## 即刻开始 +![MaaFramework](https://img.shields.io/badge/MaaFramework-v1.8.9-blue) +![Pipeline](https://img.shields.io/badge/Pipeline-%23454545?logo=codecademy&logoColor=%23FFFFFF&color=%23454545) -- [⭐ 开发思路](https://github.com/MaaXYZ/MaaFramework/blob/main/docs/zh_cn/0.1-%E5%BC%80%E5%8F%91%E6%80%9D%E8%B7%AF.md) -- [📄 资源准备](https://github.com/MaaXYZ/MaaFramework/blob/main/docs/zh_cn/1.1-%E5%BF%AB%E9%80%9F%E5%BC%80%E5%A7%8B.md) -- [🎞️ 视频教程](https://www.bilibili.com/video/BV1yr421E7MW) +MMB 是指 MaaMihoyoBBS -## 如何开发 +基于MAA全新架构的 米游社 小助手 -0. 使用右上角 `Use this template` - `Create a new repository` 来基于本模板创建您自己的项目。 +图像技术 + 模拟控制,解放双手! -1. 完整克隆本项目及子项目(地址请修改为您基于本模板创建的新项目地址)。 +由 [MaaFramework](https://github.com/MaaXYZ/MaaFramework) 强力驱动! - ```bash - git clone --recursive https://github.com/MaaXYZ/MaaPracticeBoilerplate.git - ``` + - **请注意,一定要完整克隆子项目,不要漏了 `--recursive`,也不要下载 zip 包!** 这步未正确操作会导致所有 OCR(文字识别)失败! +## 适配情况 -2. 下载 MaaFramework 的 [Release 包](https://github.com/MaaXYZ/MaaFramework/releases),解压到 `deps` 文件夹中。 +目前仅适配了 `1280x720 320dpi` 和 `1920x1080 480dpi` 分辨率,其他分辨率尚待测试 -3. 配置资源文件。 +## How to use - ```bash - python ./configure.py - ``` +> 1. [下载](https://github.com/MaaXYZ/MaaAssistantSkland/releases) 对应平台的压缩包 +> 2. 将压缩包解压到没有中文的目录下 -4. 按需求修改 `assets` 中的资源文件,请参考 MaaFramework 相关文档。 +### 基本说明 - - 可使用 [MaaDebugger](https://github.com/MaaXYZ/MaaDebugger) 进行调试; - - 也可以在本地安装后测试: +1. 请根据 [模拟器支持情况](https://maa.plus/docs/1.3-模拟器支持.html),进行对应的操作。 +2. 按照 [适配情况](#适配情况) 修改模拟器分辨率,一般在模拟器`设置`-`显示`中进行修改。 - 1. 执行安装脚本 +### 直接使用 - ```bash - python ./install.py - ``` +> 以 Windows 用户为主,其他系统请照葫芦画瓢。 - 2. 运行 `install/MaaPiCli.exe` +1. 使用前,前往[米游社官网](https://www.miyoushe.com/)下载米游社APP +2. 在模拟器上安装并登录米游社APP +3. 首次使用,打开模拟器,双击打开 `MaaPiCli.exe` 或 通过 CMD 执行 `MaaPiCli.exe` +4. 选择ADB(本教程以 `Auto detect` 为例) +4. 等待扫描设备(设备越多等待时间越长) +5. 选择需要连接的设备 +6. 开始使用吧! -5. 完成开发工作后,上传您的代码并发布版本。 +> 添加 `-d` 参数可跳过交互直接运行任务,如 `./MaaPiCli.exe -d` - ```bash - # 配置 git 信息(仅第一次需要,后续不用再配置) - git config user.name "您的 GitHub 昵称" - git config user.email "您的 GitHub 邮箱" - - # 提交修改 - git add . - git commit -m "XX 新功能" - git push origin HEAD -u - ``` +### 作为MAA结束后脚本使用 -6. 发布您的版本 +> 以 Windows 用户为主,其他系统请照葫芦画瓢。 - 需要先修改仓库设置 `Settings` - `Actions` - `General` - `Read and write permissions` - `Save` +1. 先按照 [直接使用](#直接使用) 进行操作 +2. 在MAA目录下新建一个文本文件,在其中填入以下内容 - ```bash - # CI 检测到 tag 会自动进行发版 - git tag v1.0.0 - git push origin v1.0.0 + ```bat + @echo off + cd D:/Software/MMB + MaaPiCli.exe -d ``` -## 生态共建 - -MAA 正计划建设为一类项目,而非舟的单一软件。 - -若您的项目依赖于 MaaFramework,我们欢迎您将它命名为 MaaXXX, MXA, MAX 等等。当然,这是许可而不是限制,您也可以自由选择其他与 MAA 无关的名字,完全取决于您自己的想法! - -同时,我们也非常欢迎您提出 PR,在 [最佳实践列表](https://github.com/MaaXYZ/MaaFramework#%E6%9C%80%E4%BD%B3%E5%AE%9E%E8%B7%B5) 中添加上您的项目! - -## FAQ + > 注意:`D:/Software/MMB` 请替换成你自己的 MMB 目录 + + 如果一天只希望执行一次,可以修改成 + + ```bat + @echo off + cd D:/Software/MMB + set "date_file=last_run_date.txt" + if not exist "%date_file%" ( + MaaPiCli.exe -d + echo %date% > "%date_file%" + exit + ) + + set /p last_run_date=<"%date_file%" + set "last_run_date=%last_run_date: =%" + + set current_date=%date% + set "current_date=%current_date: =%" + + if %current_date% neq %last_run_date% ( + MaaPiCli.exe -d + echo %current_date% > "%date_file%" + ) + exit + ``` -### 1. 我是第一次使用 Python,在命令行输入 `python ./configure.py` 或 `python -m pip install MaaFW` 之后没有反应?没有报错,也没有提示成功,什么都没有 + > 注意:`D:/Software/MMB` 请替换成你自己的 MMB 目录 -Win10 或者 Win11 系统自带了一份 "Python",但它其实只是一个安装器,是没法用的。 -你需要做的是关闭它或者删除它的环境变量,然后自己去 Python 官网下载并安装一份 Python。 -[参考方法](https://www.bilibili.com/read/cv24692025/) +3. 将文本文件重命名为 `finish.bat` -### 2. 我输入 `python ./configure.py` 后报错:`Please clone this repository completely, don’t miss "--recursive", and don’t download the zip package!` + > 如果重命名后没有弹出修改扩展名的二次确认对话框,且文件图标没有变化,请自行搜索“Windows如何显示文件扩展名”。 -![项目不完整1](https://github.com/user-attachments/assets/e1f697c0-e5b6-4853-8664-a358df7327a8) +4. 在MAA `设置`-`连接设置`-`结束后脚本` 中填入 `finish.bat` +5. 开始使用吧! -**请仔细阅读文档!!!** -就是你现在正在看的本篇文档,就在上面,“如何开发”里的第一条,都已经用粗体标出来了,再问我要骂人了! -### 3. 使用 MaaDebugger 或 MaaPicli 时弹窗报错,应用程序错误:应用程序无法正常启动 +## How to build -![缺少运行库](https://github.com/user-attachments/assets/942df84b-f47d-4bb5-98b5-ab5d44bc7c2a) +**如果你要编译源码才看这节,否则直接 [下载](https://github.com/MaaXYZ/MaaAssistantSkland/releases) 即可** -一般是电脑缺少某些运行库,请安装一下 [vc_redist](https://aka.ms/vs/17/release/vc_redist.x64.exe) 。 +_欢迎大佬们来带带~_ -### 4. 我在这个仓库里提了 Issue 很久没人回复 +0. 完整克隆本项目及子项目 -这里是《项目模板》仓库,它仅仅是一个模板,一般很少会修改,开发者也较少关注。 -在此仓库请仅提问模板相关问题,其他问题最好前往对应的仓库提出,如果有 log,最好也带上它(`debug/maa.log` 文件) + ```bash + git clone --recursive https://github.com/MaaXYZ/MaaAssistantSkland.git + ``` -- MaaFW 本身及 MaaPiCli 的问题:[MaaFramework/issues](https://github.com/MaaXYZ/MaaFramework/issues) -- MaaDebugger 的问题:[MaaDebugger/issues](https://github.com/MaaXYZ/MaaDebugger/issues) -- 不知道算是哪里的、其他疑问等:[讨论区](https://github.com/orgs/MaaXYZ/discussions) +1. 下载 MaaFramework 的 [Release 包](https://github.com/MaaXYZ/MaaFramework/releases),解压到 `deps` 文件夹中 +2. 安装 -### 5. OCR 文字识别一直没有识别结果,报错 "Failed to load det or rec", "ocrer_ is null" + ```bash + python install.py + ``` -你不但没有仔细阅读文档,还无视了前面步骤的报错。我不想解释了,请再把本文档仔细阅读一遍! + 安装的二进制及相关资源文件在 `install` 目录下 -## 鸣谢 +## 开发相关 -本项目由 **[MaaFramework](https://github.com/MaaXYZ/MaaFramework)** 强力驱动! +- `deps/tools/ImageCropper` 可以用来裁剪图片和获取 ROI +- Pipeline 协议请参考 [MaaFramework 的文档](https://github.com/MaaXYZ/MaaFramework/blob/main/docs/zh_cn/3.1-%E4%BB%BB%E5%8A%A1%E6%B5%81%E6%B0%B4%E7%BA%BF%E5%8D%8F%E8%AE%AE.md) -感谢以下开发者对本项目作出的贡献(下面链接改成你自己的项目地址): +## Join us - - - +用户交流 QQ 群:[MAA 使用 & 粥游交流 QQ 群](https://ota.maa.plus/MaaAssistantArknights/api/qqgroup/index.html)
+技术(舟无关):[内卷地狱!(QQ 群)](https://jq.qq.com/?_wv=1027&k=ypbzXcA2)