From b7f2063c0f0a19571bc02353684df0f49b433ba7 Mon Sep 17 00:00:00 2001
From: overflow <err.overflow@gmail.com>
Date: Tue, 2 Jul 2024 14:47:59 +0800
Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0README?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 195 +++++++++++++++++++++++++++++++++++++++++++-----------
 1 file changed, 155 insertions(+), 40 deletions(-)

diff --git a/README.md b/README.md
index fdb792c..b26d4e8 100644
--- a/README.md
+++ b/README.md
@@ -1,59 +1,174 @@
-# MaaPracticeBoilerplate
+<div align="center">
 
-MaaFramework 实践模板。
+# MAA_Punish
 
-## 如何开发
+基于全新架构的 战双帕弥什 小助手。图像技术 + 模拟控制，解放双手！  
+由 [MaaFramework](https://github.com/MaaXYZ/MaaFramework) 强力驱动！
 
-0. 使用右上角 `Use this template` - `Create a new repository` 来基于本模板创建您自己的项目。
 
-1. 完整克隆本项目及子项目（地址请修改为您基于本模板创建的新项目地址）。
+</div>
 
-    ```bash
-    git clone --recursive https://github.com/overflow65537/MAA_Punish.git
-    ```
+## 主要功能
 
-    **请注意，一定要完整克隆子项目，不要漏了 `--recursive`**
+- 启动/关闭游戏
+- 指挥局抽签
+- 宿舍委托
+- 维系者行动
+- 领取邮件
+- 商店自动购买逆元碎片
+- 领取体力
+- 自动刷拟战场域
+- 领取凭证和任务奖励
 
-2. 下载 MaaFramework 的 [Release 包](https://github.com/MaaXYZ/MaaFramework/releases)，解压到 `deps` 文件夹中。
+## 使用说明
 
-3. 配置资源文件。
+下载地址：<https://github.com/overflow65537/MAA_Punish/releases>
 
-    ```bash
-    python ./configure.py
-    ```
+### Windows
+
+- 对于绝大部分用户，请下载 `MPA-win-x86_64-vXXX.zip`
+- 若确定自己的电脑是 arm 架构，请下载 `MPA-win-aarch64-vXXX.zip`
+- 解压后以***管理员权限***运行 `MaaPiCli.exe` 即可
+
+### macOS
+
+- 若使用 Intel 处理器，请下载 `MPA-macos-x86_64-vXXX.zip`
+- 若使用 M1, M2 等 arm 处理器，请下载 `MPA-macos-aarch64-vXXX.zip`
+- 使用方式：
+
+  ```bash
+  chmod a+x MaaPiCli
+  ./MaaPiCli
+  ```
+
+### Linux
+
+~~用 Linux 的大佬应该不需要我教~~
+## MaaPiCli使用说明
+### A
+- 启动后会出现:
+```
+Welcome to use Maa Project Interface CLI!
+
+Version: v0.0.1
+
+### Select ADB ###
+
+        1. Auto detect
+        2. Manual input
+
+Please input [1-2]:
+```
+- 如无必要，请选择1.Auto detect
+
+```
+### Select ADB ###
+
+        1. Auto detect
+        2. Manual input
+
+Please input [1-2]: 1
+
+Finding device...
+
+## Select Device ##
 
-4. 按需求修改 `assets` 中的资源文件，请参考 MaaFramework 相关文档。
+        1. MuMuPlayer12
+                H:/Program Files/Netease/MuMuPlayer-12.0/shell/adb.exe
+                127.0.0.1:16672
 
-    - 可使用 [MaaDebugger](https://github.com/MaaXYZ/MaaDebugger) 进行调试；
-    - 也可以在本地安装后测试：
+Please input [1-1]: 1
+```
+- 选择 1 后会像上面这样，列出若干个模拟器实例，之后选择你需要进行操控的即可。
+- 如果没有出现选项，请检查模拟器是否正常启动。以及管理员权限启动MaaPiCli。
+### B
+- 选择完模拟器后就会进入到选择资源界面
+```
+### Select resource ###
 
-        1. 执行安装脚本
-           
-      ```bash
-      python ./install.py
-      ```
-      
-        2. 运行 `install/MaaPiCli.exe`
+        1. 官服
+        2. B 服
 
-5. 完成开发工作后，上传您的代码并发布版本。
+Please input [1-2]:
+```
+- 请按照自己的服务器类型选择
+### C
+- 在初次启动后，会让你输入启动的任务：
+```
+### Add task ###
+
+        1. 进入游戏
+        2. 指挥局
+        3. 领取体力
+        4. 领取邮件
+        5. 购买碎片
+        6. 宿舍委托
+        7. 拟战场域
+        8. 守护者行动
+        9. 领取任务
+        10. 战令
+        11. 结束游戏
+
+Please input [1-11]:
+```
+- 选择你要执行的任务即可。
+
+### D
+
+- 之后会反复出现：
+```
+Tasks:
+
+<这里会列出你已经增加，等待执行的任务>
+
+### Select action ###
+
+        1. Switch controller
+        2. Switch resource
+        3. Add task
+        4. Move task
+        5. Delete task
+        6. Run tasks
+        7. Exit
+```
+- 其中分别代表：
+1. 调整控制器（也就是adb地址等）
+2. 调整资源（切换官服或者b服）
+3. 新增任务，像**C**中那样
+4. 移动任务
+5. 删除任务
+6. 开始执行任务，在这之后就会自动开始操控。
+7. 退出程序
+
+## 其他说明
+
+- 添加 `-d` 参数可跳过交互直接运行任务，如 `./MaaPiCli.exe -d`，配合Windows计划任务可以实现自动开启任务
+- 反馈问题请附上日志文件 `debug/maa.log`，谢谢！
+
+## How to build
+
+**如果你要编译源码才看这节，否则直接 [下载](https://github.com/overflow65537/MAA_Punish/releases) 即可**
+
+0. 完整克隆本项目及子项目
 
     ```bash
-    # 配置 git 信息（仅第一次需要，后续不用再配置）
-    git config user.name "您的 GitHub 昵称"
-    git config user.email "您的 GitHub 邮箱"
-    
-    # 提交修改
-    git add .
-    git commit -m "XX 新功能"
-    git push origin HEAD -u
+    git clone --recursive https://github.com/overflow65537/MAA_Punish.git
     ```
 
-6. 发版您的版本
+1. 下载 MaaFramework 的 [Release 包](https://github.com/MaaXYZ/MaaFramework/releases)，解压到 `deps` 文件夹中
+2. 安装
 
-    需要先修改仓库设置 `Settings` - `Actions` - `General` - `Read and write permissions` - `Save`
-    
-    ```bash
-    # CI 检测到 tag 会自动进行发版
-    git tag v1.0.0
-    git push origin v1.0.0
+    ```python
+    python ./install.py
     ```
+
+生成的二进制及相关资源文件在 `install` 目录下
+
+## 开发相关
+
+- [MaaFramework 快速开始](https://github.com/MaaAssistantArknights/MaaFramework/blob/main/docs/zh_cn/1.1-%E5%BF%AB%E9%80%9F%E5%BC%80%E5%A7%8B.md)
+
+## 鸣谢
+
+本项目由 **[MaaFramework](https://github.com/MaaXYZ/MaaFramework)** 强力驱动！
+