resource/tasks.json 的使用方法及各字段說明
{
"TaskName" : { // 任務名
"baseTask": "xxx", // 以xxx任務為範本生成任務，詳細見下方特殊任務類型中的Base Task
"algorithm": "MatchTemplate", // 可選項，表示識別演算法的類型
// 不填寫時默認為 MatchTemplate
// - JustReturn: 不進行識別，直接執行 action
// - MatchTemplate: 匹配圖片
// - OcrDetect: 文字識別
// - Hash: 哈希計算
"action": "ClickSelf", // 可選項，表示識別到後的動作
// 不填寫時默認為 DoNothing
// - ClickSelf: 點擊識別到的位置（識別到的目標範圍內隨機點）
// - ClickRand: 點擊整個畫面中隨機位置
// - ClickRect: 點擊指定的區域，對應 specificRect 字段，不建議使用該選項
// - DoNothing: 什麼都不做
// - Stop: 停止當前任務
// - Swipe: 滑動，對應 specificRect 與 rectMove 字段
"sub": [ "SubTaskName1", "SubTaskName2" ],
// 可選項，子任務。會在執行完當前任務後，依次執行每一個子任務
// 可以套娃，子任務再套子任務。但要注意不要寫出了死迴圈
"subErrorIgnored": true, // 可選項，是否忽略子任務的錯誤。
// 不填寫默認 false
// 為 false 時，若某個子任務出錯，則不繼續執行後續任務（相當於本任務出錯了）
// 為 true 時，子任務是否出錯沒有影響
"next": [ "OtherTaskName1", "OtherTaskName2" ],
// 可選項，表示執行完當前任務和 sub 任務後，下一個要執行的任務
// 會從前往後依次去識別，去執行第一個匹配上的
// 不填寫默認執行完當前任務直接停止
// 對於相同任務，第一次識別後第二次就不再識別：
// "next": [ "A", "B", "A", "A" ] -> "next": [ "A", "B" ]
// 不允許 JustReturn 型任務位於非最後一項
"maxTimes": 10, // 可選項，表示該任務最大執行次數
// 不填寫時默認無窮大
// 達到最大次數後，若存在 exceededNext 字段，則執行 exceededNext；否則直接任務停止
"exceededNext": [ "OtherTaskName1", "OtherTaskName2" ],
// 可選項，表示達到了最大執行次數後要執行的任務
// 不填寫時，達到了最大執行次數則停止；填寫後就執行這裏的，而不是 next 裏的
"onErrorNext": [ "OtherTaskName1", "OtherTaskName2" ],
// 可選項，表示執行出錯時，後續要執行的任務
"preDelay": 1000, // 可選項，表示識別到後延遲多久才執行 action，單位毫秒；不填寫時默認 0
"postDelay": 1000, // 可選項，表示 action 執行完後延遲多久才去識別 next, 單位毫秒；不填寫時默認 0
"roi": [ 0, 0, 1280, 720 ], // 可選項，表示識別的範圍，格式為 [ x, y, width, height ]
// 以 1280 * 720 為基準自動縮放；不填寫時默認 [ 0, 0, 1280, 720 ]
// 儘量填寫，減小識別範圍可以減少性能消耗，加快識別速度
"cache": true, // 可選項，表示該任務是否使用緩存，默認為 true;
// 第一次識別到後，以後永遠只在第一次識別到的位置進行識別，開啟可大幅節省性能
// 但僅適用於待識別目標位置完全不會變的任務，若待識別目標位置會變請設為 false
"rectMove": [ 0, 0, 0, 0 ], // 可選項，識別後的目標移動，不建議使用該選項。以 1280 * 720 為基準自動縮放
// 例如識別到了 A ，但實際要點擊的是 A 下方 10 像素 5 * 2 區域的某個位置，
// 則可填寫[ 0, 10, 5, 2 ]，可以的話儘量直接識別要點擊的位置，不建議使用該選項
// 額外的，當 action 為 Swipe 時有效且必選，表示滑動終點。
"reduceOtherTimes": [ "OtherTaskName1", "OtherTaskName2" ],
// 可選項，執行後減少其他任務的執行計數。
// 例如執行了吃理智藥，則說明上一次點擊藍色開始行動按鈕沒生效，所以藍色開始行動要-1
"specificRect": [ 100, 100, 50, 50 ],
// 當 action 為 ClickRect 時有效且必選，表示指定的點擊位置（範圍內隨機一點）。
// 當 action 為 Swipe 時有效且必選，表示滑動起點。
// 以 1280 * 720 為基準自動縮放
"specialParams": [ int, ... ], // 某些特殊識別器需要的參數
// 額外的，當 action 為 Swipe 時可選，[0] 表示 duration，[1] 表示 是否啟用額外滑動
/* 以下字段僅當 algorithm 為 MatchTemplate 時有效 */
"template": "xxx.png", // 可選項，要匹配的圖片檔案名
// 默認 "任務名.png"
"templThreshold": 0.8, // 可選項，圖片範本匹配得分的閾值，超過閾值才認為識別到了。
// 默認 0.8, 可根據日誌查看實際得分是多少
"maskRange": [ 1, 255 ], // 可選項，灰度掩碼範圍。例如將圖片不需要識別的部分塗成黑色（灰度值為 0）
// 然後設置"maskRange"的範圍為 [ 1, 255 ], 匹配的時候即刻忽略塗黑的部分
/* 以下字段僅當 algorithm 為 OcrDetect 時有效 */
"text": [ "接管作戰", "代理指揮" ], // 必選項，要識別的文字內容，只要任一匹配上了即認為識別到了
"ocrReplace": [ // 可選項，針對常見識別錯的文字進行替換（支持正則）
[ "千員", "幹員" ],
[ ".+擊幹員", "狙擊幹員" ]
],
"fullMatch": false, // 可選項，文字識別是否需要全字匹配（不能多字），默認為 false
// false 時只要是子串即可：例如 text: [ "開始" ]，實際識別到了 "開始行動"，也算識別成功；
// true 時則必須識別到了 "開始"，多一個字都不行
"isAscii": false, // 可選項，要識別的文字內容是否為 ASCII 碼字元
// 不填寫默認 false
"withoutDet": false // 可選項，是否不使用檢測模型
// 不填寫默認 false
/* 以下字段僅當 algorithm 為 Hash 時有效 */
// 演算法不成熟，僅部分特例情況中用到了，暫不推薦使用
// Todo
}
}Template task 與 base task 合稱範本任務。
允許把某個任務 "A" 當作範本，然後 "B@A" 表示由 "A" 生成的任務。
-
如果
tasks.json中未顯式定義任務 "B@A"，則在sub,next,onErrorNext,exceededNext,reduceOtherTimes字段中增加B@首碼（如遇任務名開頭為#則增加B首碼），其餘參數與 "A" 任務相同。就是說如果任務 "A" 有以下參數："A": { "template": "A.png", ..., "next": [ "N1", "N2" ] }
就相當於同時定義了
"B@A": { "template": "A.png", ..., "next": [ "B@N1", "B@N2" ] }
-
如果
tasks.json中定義了任務 "B@A"，則：- 如果 "B@A" 與 "A" 的
algorithm字段不同，則派生類參數不繼承（只繼承TaskInfo定義的參數） - 如果是圖像匹配任務，
template若未顯式定義則為[email protected]（而不是繼承"A"的template名），其餘情況任何派生類參數若未顯式定義，直接繼承 "A" 任務的參數 - 對於
TaskInfo基類中定義的參數（任何類型任務都有的參數，例如algorithm,roi,next等），若沒有在 "B@A" 內顯式定義，則除了上面提到的sub等五個字段在繼承時會增加 "B@" 首碼外，其餘參數直接繼承 "A" 任務的參數
- 如果 "B@A" 與 "A" 的
Base task 與 template task 合稱範本任務。
有字段 baseTask 的任務即為 base task。
除了 template 未顯式定義時仍為 "任務名.png"，其餘任何參數若未顯式定義直接使用 baseTask 對應任務的參數。（不加首碼）
- 外服
tasks.json中定義的同名任務直接繼承國服tasks.json的參數，相當於"A": { "baseTask": "國服的A" } - 如果國服
tasks.json中定義了任務 "B@A"，外服tasks.json中也定義了 "B@A"，那麼- 如果外服 "B@A" 有字段
"baseTask": ""，則不繼承國服 "B@A"
- 若有定義任務 "A"，則以 template task 的邏輯處理 "B@A"
- 若未定義任務 "A"，則以普通任務的邏輯處理 "B@A"
- 如果外服 "B@A" 沒有
baseTask，則直接繼承國服 "B@A" 參數
- 如果外服 "B@A" 有字段
Virtual task 也稱 sharp task（# 型任務）。
任務名帶 # 的任務即為 virtual task。 # 後可接 next, back, self, sub, on_error_next, exceeded_next, reduce_other_times。
| 虛任務類型 | 含義 | 簡單示例 |
|---|---|---|
| self | 父任務名 | "A": {"next": "#self"} 中的 "#self" 被解釋為 "A""B": {"next": "A@B@C#self"} 中的 "A@B@C#self" 被解釋為 "B"。1 |
| back | # 前面的任務名 | "A@B#back" 被解釋為 "A@B""#back" 直接出現則會被跳過 |
| next, sub 等 | # 前任務名對應字段 | 以 next 為例："A#next" 被解釋為 Task.get("A")->next"#next" 直接出現則會被跳過 |
Note1: "XXX#self" 與 "#self" 含義相同。
{
"A": { "next": [ "N1", "N2" ] },
"C": { "next": [ "B@A#next" ] },
"Loading": {
"next": [ "#self", "#next", "#back" ]
},
"B": {
"next": [ "Other", "B@Loading" ]
}
}可以得到：
Task.get("C")->next = { "B@N1", "B@N2" };
Task.get("B@Loading")->next = { "B@Loading", "Other", "B" };
Task.get("Loading")->next = { "Loading" };
Task.get_raw("B@Loading")->next = { "B#self", "B#next", "B#back" };- 當幾個任務有
"next": [ "#back" ]時，"Task1@Task2@Task3"代表依次執行Task3,Task2,Task1。
{
"A": { "next": [ "N0" ] },
"B": { "next": [ "A#next" ] },
"C@A": { "next": [ "N1" ] }
}以上這種情況， "C@B" -> next（即 C@A#next）為 [ "N1" ] 而不是 [ "C@N0" ].
本項目為 tasks.json 配置了 json schema 檢驗，schema 檔為docs/maa_tasks_schema.json。
在 MaaCore.vcxporj 中已對其進行配置，開箱即用。提示效果較為晦澀，且有部分資訊缺失。
在 .vscode/settings.json 中已對其進行配置，用 vscode 打開該專案檔夾即可使用。提示效果較好。