chore: 完善提示

Author: Night-stars-1

README.md

@@ -2,28 +2,28 @@
  * @Author: Night-stars-1 nujj1042633805@gmail.com
  * @Date: 2024-09-06 17:06:15
  * @LastEditors: Night-stars-1 nujj1042633805@gmail.com
- * @LastEditTime: 2024-09-10 12:23:18
+ * @LastEditTime: 2024-12-02 15:25:12
 -->
 # maa-gui
 
-An Electron application with Vue
+基于MAA流水线协议的GUI
 
-## Recommended IDE Setup
+## 截图
+![截图](./resources/image.png)
 
-- [VSCode](https://code.visualstudio.com/) + [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) + [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar)
+## 项目安装
 
-## Project Setup
-
-### Install
+### 安装
 
 ```bash
 git clone --recursive https://github.com/Night-stars-1/maa-gui.git
 $ pnpm install
 ```
 
-### Development
+### 开发
 
 - 根据`.env`的提示更改`.env`
+- 根据`dev-app-update.yml`和`electron-builder.yml`的提示更改文件
 ```bash
 $ pnpm dev
 ```
@@ -41,5 +41,40 @@ $ pnpm build:mac
 $ pnpm build:linux
 ```
 
+## MAA行为扩展
+> 在`src\main\customMaa`中注册自定义行为，以达到更灵活的控制
+**最简示例：**
+```json
+{
+    "识别并点击确认图标": {
+        "next": [
+            "我的自定义任务"
+        ]
+    },
+    "我的自定义任务": {
+        "recognition": "Custom",
+        "custom_recognition": "MyReco",
+        "action": "Custom",
+        "custom_action": "MyAct"
+    }
+}
+```
+```ts
+import * as maa from '@nekosu/maa-node'
+const MyReco: maa.CustomRecognizerCallback = async (self) => {
+  const data = await self.context.run_recognition('OCR', self.image, {
+    OCR: { recognition: 'OCR', expected: '', roi: [593, 113, 516, 46] }
+  })
+  if (!data) {
+    console.log('未识别到内容')
+    return null
+  }
+  return null
+}
+
+function registerCustom(res: maa.Resource) {
+  res.register_custom_recognizer('MyReco', MyReco)
+}
+```
 ### Thanks
 - [2048-AI](https://github.com/aj-r/2048-AI)

dev-app-update.yml

@@ -1,5 +1,6 @@
 provider: generic
-url: https://goda.srap.link/auto-updates
+# 这里的更新url需要更改成你自己的
+url: https://example.com/auto-updates
 updaterCacheDirName: mma-gui-updater
 # provider: github
 # owner: Night-stars-1

electron-builder.yml

@@ -49,5 +49,6 @@ appImage:
 npmRebuild: false
 publish:
   provider: generic
-  url: https://goda.srap.link/auto-updates
+  # 这里的更新url需要更改成你自己的
+  url: https://example.com/auto-updates
   updaterCacheDirName: m5a-gui-updater

resources/image.png

@@ -2,21 +2,27 @@
  * @Author: Night-stars-1 nujj1042633805@gmail.com
  * @Date: 2024-09-08 15:07:30
  * @LastEditors: Night-stars-1 nujj1042633805@gmail.com
- * @LastEditTime: 2024-09-18 18:58:39
+ * @LastEditTime: 2024-12-02 15:37:33
  */
 import * as maa from '@nekosu/maa-node'
-import eventSelect from './eventSelect'
-import challenge2048 from './challenge2048'
 
 /**
  * 自定义的Param参数
  * 用于将任务重定向到自定义代码上
+ * 一般情况下不建议这么做，除非你不想同时更改流水线文件
  */
 const customParam = {}
 
 function registerCustom(res: maa.Resource) {
-  Object.assign(customParam, eventSelect(res))
-  Object.assign(customParam, challenge2048(res))
+  // Object.assign(customParam, (res) => {
+  //   return {
+  //     识别并点击确认图标: {
+  //       next: ['我的自定义任务']
+  //     }
+  //   }
+  // })
+  console.log('注册自定义行为')
+  // res.register_custom_recognizer('MyReco', MyReco)
 }
 
 export { registerCustom, customParam }