Files
MaaAssistantArknights/docs/zh-tw/develop/vsc-ext-tutorial.md
Natsuu 51ee0fea1c docs: add instruction of log view in vsc-ext (#14696)
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2025-12-11 18:37:54 +08:00

130 lines
4.5 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
---
order: 8
icon: iconoir:code-brackets
---
# 專用 VSCode 插件教學
該插件針對 MaaAssistantArknights/MaaFramework 提供了一系列方便開發的能力,包括但不限於以下功能:
- tasks.json 支持,包含 `template 預覽``next 跳轉``任務引用` 等等
- 截取/裁剪圖片
具體內容可以前往 [插件商店](https://marketplace.visualstudio.com/items?itemName=nekosu.maa-support) 或是 [倉庫](https://github.com/neko-para/maa-support-extension) 查看
## 安裝
推薦直接在 VSCode 的插件列表中搜索 `Maa` 來安裝
::: tip
首次使用時, 插件會自動下載預設版本的資源
搜索命令 `Maa: 選擇下載源`, 可切換下載源 (npm / cnpm)
:::
## 功能
### 控制面板
左側添加了專用控制面板, 圖示 ![MaaSupport ControlPanel](/images/maa-support-panel.svg)
插件的絕大部分功能均基於 `interface.json` 配置. 在控制面板最頂部可以選擇生效的 `interface.json`.
插件有 `Maa` 相容模式. 當在打開文件夾下檢測到存在 `src/MaaCore` 文件夾時, 會自動啟用.
### 語義化資源分析
通過切換控制面板中的 `資源` 下拉框, 選擇預期的資源. 插件會根據對應路徑來進行索引和診斷.
如果發現想要編輯的 json 文件沒有插件提示, 請檢查是否啟用的資源並沒有包含該文件.
> 所謂 `任務的定義`, 指任務對象的鍵
>
> 所謂 `任務的引用`, 指其它任務中可以填入任務名稱的值 (例如 `next` 中)
#### 查詢任務定義/引用
插件支持跳轉到定義, 跳轉到引用, 查看任務定義.
開啟 `Maa` 相容模式時, 可以解析 `模板任務`, 支持同步基類查詢任務定義和引用; 懸停任務定義, 可以查看同名圖片。
使用 `Ctrl+T` 快捷鍵,可以快速查詢並跳轉任務定義。
#### 查詢/打開圖片
插件支持打開圖片.
開啟 `Maa` 相容模式時, 允許圖片路徑進行遞迴搜索.
#### 補全任務
插件支持根據所有已知任務進行自動補全.
開啟 `Maa` 相容模式時, 輸入 `@` 將會觸發補全.
#### 補全圖像路徑
插件支持根據所有已知圖片路徑進行自動補全.
開啟 `Maa` 相容模式時, 允許圖片路徑進行遞迴搜索.
#### 校驗任務/圖像路徑
插件支持定時掃描並分析所有任務.
- 檢查是否有重名任務定義
- 檢查是否有未知任務引用
- 檢查是否有未知圖片引用
- 檢查單個任務中是否有重複的任務引用
#### 多路徑資源支持
插件支持資源包含多個路徑, 會按照指定順序進行邏輯覆蓋, 即後載入的可以引用到前載入的內容.
### 計算任務 / 任務列表表達式 (僅 Maa)
通過控制面板, 可以計算任務實際展開的內容, 以及每一項的來源; 可以計算任務列表表達式展開的結果
### MaaPiCli 功能 (僅 MaaFramework 項目)
通過控制面板, 可以掃描並選擇控制器, 選擇資源, 添加並管理任務, 以及執行任務.
### 截圖裁剪功能
在 VSCode 的命令面板中搜索執行 `Maa: 打開截圖工具`, 可打開 `截圖 / 裁剪` 面板.
> 使用 `Ctrl+Shift+P` (MacOS 上則是 `Command+Shift+P`) 呼出命令面板
- 選擇並連接控制器後, 可使用 `截圖` 按鈕直接獲取截圖
- 可使用 `上傳` 按鈕手動上傳
- 按住 `Ctrl` 鍵, 框選需要裁剪的區域
- 使用滾輪可進行縮放
- 裁剪完成後, 使用 `下載` 按鈕, 可自動將裁剪結果保存到啟用資源的最頂層的圖片目錄
- 使用 `複製` 按鈕,可將 ROI 以陣列的形式複製到剪貼簿
- 按下 `工具` 按鈕,將開啟識別工具面板,可以直接對目前圖片進行識別測試
::: warning
如果 OCR 的識別結果為空,請檢查 [OCR 模型](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#%E6%96%87%E5%AD%97%E8%AF%86%E5%88%AB%E6%A8%A1%E5%9E%8B%E6%96%87%E4%BB%B6) 是否已正確配置。
:::
### 日誌查看功能
#### MaaFramework 日誌
在 VSCode 的命令面板中搜索執行 `Maa: 打開maa日誌`, 可查看調試期間產生的 `maa.log` 日誌.
#### Maa Pipeline Support 擴充日誌
在 VSCode 的命令面板中搜索執行 `Maa: 打開插件日誌`, 可查看調試期間產生的 `mse.log` 日誌.
### 底部狀態欄
#### MaaSupport <插件版本>
點擊可聚焦控制面板
#### MaaFramework <MaaFw版本>
點擊可切換插件使用的 `MaaFramework` 版本。其中,可選擇的版本被限制為當前插件所支持的版本,如果列表中沒有你需要的版本,請考慮更換插件版本。