docs: readme

readme.md

@@ -1,6 +1,7 @@
 # 麻将 Copilot / Mahjong Copilot
 
 麻将的 AI 助手，基于 mjai (Mortal模型)实现的机器人。会对游戏对局的每一步进行指导。现支持雀魂四人麻将。
+![](assets/shot3_lower.png)
 
 特性：
 
@@ -58,15 +59,13 @@ pip install -r requirements.txt
 python main.py
 ```
 
-
 ### To Develope
 
 1. Clone the repo
 2. Install Python virtual environment. Python version 3.11 recommended.
 3. Install dependencies from requirements.txt
 4. Main entry: main.py
 
-
 ```batch
 git clone https://github.com/latorc/MahjongCopilot.git
 cd MahjongCopilot
@@ -76,6 +75,29 @@ pip install -r requirements.txt
 python main.py
 ```
 
+### 使用帮助：
+
+1. 软件使用中间人 (MITM) 代理获取游戏客户端和服务器之间传输的信息。推荐使用内置的浏览器进行游戏。首次加载网页客户端，或游戏有更新时，会因为下载游戏素材而导致网页加载时间变长或疑似卡住。
+2. 如果需要使用其他客户端，可以用代理软件 (如 Proxifier) 使客户端流量通过代理 (http://localhost:{mitm端口})。其他客户端暂不支持自动打牌。
+3. 界面和设置项说明：
+
+   1） 网页 HUD 开关: 在网页上覆盖显示信息和 AI 选项。关闭此项可略微提升自动打牌流畅度。
+   2） AI 模型类型：
+
+   - Local: 本地模型，需要准备 mortal.pth 文件放到 models 目录下。
+   - MJAPI: (作者 9ns4esyx) 开发的在线麻将 AI API. 使用 MJAPI 时，可以填写已有的用户名和密钥。或者，将用户名和密钥 (Secret) 留空，软件会自动注册新用户并登录。MJAPI 有不同模型可选择，登陆后会刷新模型选项，并显示 API 用量。
+
+   3）自动打牌设置：
+
+   - 自动打牌：自动化操作的总开关，关闭后将停止所有自动化操作。
+   - 随机化选项：自动打牌时，根据模型推荐的前三选项，按概率（权重）随机选取其中之一。可以在分析牌谱时，降低模型重合率。
+   - 鼠标随机移动次数：在鼠标点击前，随机移动几次，避免被检测为自动化操作。
+   - 基础延迟随机范围：自动打牌前的延时。根据场况和打的牌，会在基础延迟上增加额外延迟（例如：东家第一巡会加几秒钟延迟，让理牌动画完成）。
+   - 自动加入：自动加入下一局游戏，根据选择的级别和游戏模式。自动加入操作需要从主菜单或者游戏中开始。
+4. 状态栏中，主程序和浏览器均会附加显示刷新率作为性能参考。通常数值在 100 以上说明程序运行流畅。进行自动打牌操作时，浏览器刷新率会下降。
+5. 本程序使用 Pyinstaller 编译发布，暂时仅支持 Windows. 在帮助窗口中，可以进行自动更新。Mac 用户需要自助从 Python 源代码运行本程序。
+6. 长时间使用自动打牌可能会导致账户被封禁。请合法使用本程序。使用者需要承担潜在风险和责任。
+
 ## 截图 / Screenshots
 
 界面 / GUI