mirror of
https://github.com/MaaAssistantArknights/MaaAssistantArknights.git
synced 2026-07-16 01:40:46 +08:00
e461208bf9
格式化工具部分： 1. pre-commit 引入 python 的格式化工具，包括 black（代码格式化）和 isort（对“包导入顺序”的规范） 2. 允许 prettier 对文档站的 markdown 文件格式化 3. 不允许 prettier 对 markdown 文件中的代码块的代码本身进行格式化 4. 升级了 pre-commit 的各个 hook 的版本 5. 优化了 pre-commit 的日志文本显示 容器总览部分： 1. 由原来的单一轻量环境转为区分空环境、轻量环境和全量环境 2. 空环境是裸 Linux 镜像（Ubuntu），为默认环境 3. 轻量环境适合开发文档站前端 4. 全量环境适合开发 MaaCore 5. 目前，全量环境完整包含了轻量环境，轻量环境完整包含了空环境 6. 在仓库 README.md 中更新了三个环境的描述，并将链接分别设置为对应环境的创建链接 **注意：没有修改文档站中的对应文件** 7. 在各个语言的开发指南的最后，移除了 Codespace 部分的“安装额外依赖”相关描述，且将链接设置为全量环境的创建链接 **注意：没有添加“开发文档站”的指南和对应 codespace 的使用方式** 容器的轻量环境和全量环境共有部分： 1. 安装 black 和 isort 包 2. 调整 VS Code 设置，取消先前（对 markdown 文件单独指定 markdownlint 扩展作为格式化工具）的错误设置，现在 markdown 文件仍然使用默认的 prettier 扩展作为格式化工具 3. 引入 markdown-all-in-one 扩展作为语法提示工具 4. 将 node_modules 和 3rdparty 排除在 VS Code 的文本的搜索路径之外 容器的全量环境部分： 1. 为 tools 下的所有 python 脚本安装依赖 2. 使用 tools/maadeps-download.py 下载 maadeps，且将必要二进制文件软链接到 /usr/local/bin/ 3. 使用 apt 安装 cmake 和 clangd-20，将后者通过 update-alternatives 设置为系统 clangd 的默认版本 4. 使用 cmake tools 扩展，并按照 Linux 编译方法进行配置 5. 使用 clang-format 作为 c/cpp 的格式化工具，clang-format 程序主体来自 maadeps（已经软链接到 /usr/local/bin/） 6. 使用 clangd 作为 c/cpp 的语法提示工具 7. 将 MaaDeps、install 和 build 排除在 VS Code 的文本搜索路径之外 其它手动调整： 1. 更新文档站的 package.json，指定 pnpm 包管理器的版本 2. 手动保证 markdown 文件中的列表前后有空行（注意到 MarkdownLint 官方规则不一定能精准定位所有“列表前后空行”的问题，详见：https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md032---lists-should-be-surrounded-by-blank-lines ） 3. 修改了部分 markdown 文件中的 json 代码块的语法问题 **注意：相同的问题并未全部发现，仅修改了两处** 4. 在 tools 目录中，一处 python 脚本的包名误用（本地包名和某个 pip 包重名），这里修改了相应代码 5. 在 tools 目录中，一处 python 脚本使用了弃用的包 cchardet 的问题，这里更换了推荐使用的功能相近的包并修改了相应代码 自动化脚本提交的修改： 1. 自动格式化了大量 tools 中的 python 脚本 2. 自动格式化了大量 docs 中的 markdown 文件 Commits: * chore: pre-commit引入black和isort规范py文件 * chore: Auto update by pre-commit hooks [skip changelog] * chore: devcontainer添加isort扩展，排序python导入 * chore: pre-commit任务命名及更名 * style: isort fix * chore: Auto update by pre-commit hooks [skip changelog] * chore: 更新pre-commit的hook版本 * fix: 模块名与第三方库重名，大忌 * chore: 容器构建时额外安装isort * docs: md -> markdown * chore: 容器安装python包和maadeps * fix: 修复过时python包 * chore: 指定pnpm版本 * chore: container支持选择轻量环境 * chore: 去掉rust * chore: add plain env * chore: 使用clangd语言服务器 * chore: 无需单独设置markdown的格式化工具 * chore: 更新安装的clangd版本 * docs: 简易文档适配 * docs: 在仓库README中重新编排codespaces相关指引 * chore: Auto update by pre-commit hooks [skip changelog] * style: 调整缩进 * chore: 格式化工具不用特意排除被gitignore忽略的文件 * chore: sh文件在gitattributes中单列一类 * chore: 格式化docs下的markdown文件 * chore: 暂时不修改md文件中的代码块 * style: 人为明确markdown中的部分列表相关格式 * docs: 补上部分markdown的json代码块中缺失的逗号 * chore: Auto update by pre-commit hooks [skip changelog] * chore: Auto update by pre-commit hooks [skip changelog] * fix: 补上tools的服务器排序相关代码中缺失的逗号 Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * chore: 使用maadeps的clangd * build: 更新maadeps工具链版本 * style: prettier fix * revert: 还原maadeps版本 * revert: 取消使用maadeps的clangd依赖，改用系统apt安装 --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
105 lines
3.3 KiB
Markdown
105 lines
3.3 KiB
Markdown
---
|
|
order: 8
|
|
icon: iconoir:code-brackets
|
|
---
|
|
|
|
# 专用 VSCode 插件教程
|
|
|
|
- [插件商店](https://marketplace.visualstudio.com/items?itemName=nekosu.maa-support)
|
|
- [仓库](https://github.com/neko-para/maa-support-extension)
|
|
|
|
## 安装
|
|
|
|
推荐直接在 VSCode 的插件列表中搜索 `Maa` 来安装.
|
|
|
|
## 功能
|
|
|
|
### 控制面板
|
|
|
|
左侧添加了专用控制面板, 图标 
|
|
|
|
插件的绝大部分功能均基于 `interface.json` 配置. 在控制面板最顶部可以选择生效的 `interface.json`.
|
|
|
|
插件有 `Maa` 兼容模式. 当在打开文件夹下检测到存在 `src/MaaCore` 文件夹时, 会自动启用.
|
|
|
|
### 语义化资源分析
|
|
|
|
通过切换控制面板中的 `资源` 下拉框, 选择预期的资源. 插件会根据对应路径来进行索引和诊断.
|
|
|
|
如果发现想要编辑的 json 文件没有插件提示, 请检查是否激活的资源并没有包含该文件.
|
|
|
|
> 所谓 `任务的定义`, 指任务对象的键
|
|
>
|
|
> 所谓 `任务的引用`, 指其它任务中可以填入任务名称的值 (例如 `next` 中)
|
|
|
|
#### 查询任务定义/引用
|
|
|
|
插件支持跳转到定义, 跳转到引用, 查看任务定义.
|
|
|
|
开启 `Maa` 兼容模式时, 可以解析 `模板任务`, 支持联动基类查询任务定义和引用; 悬停任务定义, 可以查看同名图片.
|
|
|
|
#### 查询/打开图片
|
|
|
|
插件支持打开图片.
|
|
|
|
开启 `Maa` 兼容模式时, 允许图片路径进行递归搜索.
|
|
|
|
#### 补全任务
|
|
|
|
插件支持根据所有已知任务进行自动补全.
|
|
|
|
开启 `Maa` 兼容模式时, 输入 `@` 将会触发补全.
|
|
|
|
#### 补全图像路径
|
|
|
|
插件支持根据所有已知图片路径进行自动补全.
|
|
|
|
开启 `Maa` 兼容模式时, 允许图片路径进行递归搜索.
|
|
|
|
#### 校验任务/图像路径
|
|
|
|
插件支持定时扫描并分析所有任务.
|
|
|
|
- 检查是否有重名任务定义
|
|
- 检查是否有未知任务引用
|
|
- 检查是否有未知图片引用
|
|
- 检查单个任务中是否有重复的任务引用
|
|
|
|
#### 多路径资源支持
|
|
|
|
插件支持资源包含多个路径, 会按照指定顺序进行逻辑覆盖, 即后加载的可以引用到前加载的内容.
|
|
|
|
### 计算任务 / 任务列表表达式 (仅 Maa)
|
|
|
|
通过控制面板, 可以计算任务实际展开的内容, 以及每一项的来源; 可以计算任务列表表达式展开的结果
|
|
|
|
### MaaPiCli 功能 (仅 MaaFramework 项目)
|
|
|
|
通过控制面板, 可以扫描并选择控制器, 选择资源, 添加并管理任务, 以及执行任务.
|
|
|
|
### 截图裁剪功能
|
|
|
|
在 VSCode 的命令面板中搜索执行 `Maa: 打开截图工具`, 可打开 `截图 / 裁剪` 面板.
|
|
|
|
> 使用 `Ctrl+Shift+P` (MacOS 上则是 `Command+Shift+P`) 呼出命令面板
|
|
|
|
- 选择并连接控制器后, 可使用 `截图` 按钮直接获取截图
|
|
- 可使用 `上传` 按钮手动上传
|
|
- 按住 `Ctrl` 键, 框选需要裁剪的区域
|
|
- 使用滚轮可进行缩放
|
|
- 裁剪完成后, 使用 `下载` 按钮, 可自动将裁剪结果保存到激活资源的最顶层的图片目录
|
|
|
|
### 底部状态栏
|
|
|
|
#### MaaSupport \[插件版本\]
|
|
|
|
点击可聚焦控制面板
|
|
|
|
#### MaaFramework \[MaaFw版本\]
|
|
|
|
点击可切换插件使用的 `MaaFramework` 版本
|
|
|
|
> 首次使用时, 插件会自动下载预设版本.
|
|
>
|
|
> 搜索命令 `Maa: 选择下载源`, 可切换下载源 (npm / cnpm)
|