Merge pull request #10 from Windsland52/dev

Dev

.gitignore

@@ -446,3 +446,14 @@ install
 
 # Tools
 tools/ImageCropper/**/*.png
+
+# venv
+.venv/
+myenv/
+
+.github/
+.vscode/
+.nicegui/
+
+assets/config/
+config/

README.md

@@ -1,30 +1,90 @@
+<!-- markdownlint-disable MD033 MD041 -->
+<p align="center">
+  <img alt="LOGO" src="https://raw.githubusercontent.com/Windsland52/MST/refs/heads/dev/assets/resource/base/image/Logo/logo.jpg" width="256" height="256" />
+</p>
+
+<div align="center">
+
 # MST
-基于MaaFramework的灵魂潮汐(SoulTide)日常脚本。
 
-## 功能
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable-next-line MD036 -->
+_✨ 基于MaaFramework的灵魂潮汐(SoulTide)日常脚本 ✨_
+<!-- prettier-ignore-end -->
+
+</div>
+
+<p align="center">
+  <img alt="license" src="https://img.shields.io/github/license/Windsland52/MST">
+  <img alt="platform" src="https://img.shields.io/badge/platform-Windows-blueviolet">
+  <img alt="commit" src="https://img.shields.io/github/commit-activity/m/Windsland52/MST?color=%23ff69b4">
+  <img alt="stars" src="https://img.shields.io/github/stars/Windsland52/MST?style=social">
+</p>
+
+## 简介
+
+基于全新架构的 灵魂潮汐 小助手。图像技术 + 模拟控制，解放双手！
+由 [MaaFramework](https://github.com/MaaXYZ/MaaFramework) 强力驱动！
+
+## 功能一览
+
 - [x] 启动游戏
-- [x] 签到(绑定启动)
-- [x] 领取邮件、教会补给、商店每日补给
-- [x] 家园
-  - [x] 炼金炉
-  - [x] 种菜收菜
-  - [x] 事务派遣
-  - [x] 拜访好友
-- [x] 战斗
-  - [x] 金币本扫荡
-  - [x] 异象(上榜)
-- [x] 巡查
-- [x] 相伴
-  - [x] 摸头
-  - [x] 送礼(和摸头相互绑定)
-- [x] 每日抽卡
+- [x] 每日签到
+- [x] 领取邮件
+- [x] 商店补给
+- [x] 教会补给
+- [ ] 家园
+  - [ ] 炼金炉
+  - [ ] 种菜收菜
+  - [ ] 事务派遣
+  - [ ] 拜访好友
+  - [ ] 钓鱼/捕鱼
+- [ ] 战斗
+  - [ ] 金币本扫荡
+  - [ ] 异象(上榜)
+- [ ] 巡查
+- [ ] 相伴
+  - [ ] 摸头
+  - [ ] 送礼(和摸头相互绑定)
+- [ ] 每日抽卡
 - [x] 任务/通行证
 - [ ] 挖矿
-- [x] 当前活动-木偶剧院自动无限挂机
 - [x] 关闭游戏
 
-## ToDo
-- [ ] 战斗可选 | 主线 `hard` | 深渊 `hard` | 副本 `easy`
-- [ ] 捕鱼 | 钓鱼 `hard` | 渔网 `easy`
-- [ ] 战斗体力不足的识别 `unknown`
-- [ ] 菜单优化 `unknown`
+## 快速开始
+
+1. 下载压缩包
+2. 解压后运行 `MaaPiCli.exe`，根据提示配置后运行即可。
+
+## 注意事项
+
+### 分辨率
+
+模拟器分辨率选择1280*720
+
+### ADB的选择
+
+若在开启模拟器的情况下自动检测失败，则需要手动输入，相关端口请直接到对应模拟器官网查询。
+
+
+## 参与开发
+
+若想参与开发，请参考[MaaFramework快速开始](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)，本项目暂时只通过 纯 Pipeline 开发 。
+
+## 开发日志
+
+[开发日志](https://windsland52.github.io/)，开发可参考。
+
+## 鸣谢
+
+本项目由 **[MaaFramework](https://github.com/MaaXYZ/MaaFramework)** 强力驱动！
+
+感谢以下开发者对本项目作出的贡献:
+
+<a href="https://github.com/Windsland52/MST/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=Windsland52/MST&max=1000" />
+</a>
+
+## Join us
+
+- MST开发/用户交流群 QQ 群：[212220209](http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=zybZ5ST3IHx8_l8pajwFd9OxpNQzXjdy&authKey=C5qMnDOvB4mVKNNC%2By45eKc%2BLnETkm4XFQmmdrmWzu9qemKW4lurHbf4h4h8%2F0bA&noverify=0&group_code=212220209)