Steam 工坊插件指南
本文只介绍 ECHO Steam 创意工坊插件。旧教程中的用户数据 plugins/ 目录、echo.plugin.json 和旧本地插件 API 不能作为 Steam 工坊的安装或打包步骤。
使用别人的插件
Section titled “使用别人的插件”- 从 Steam 启动 ECHO,打开「创意工坊 → 发现」。
- 阅读项目说明、兼容版本和所需权限,订阅并等待 Steam 下载。
- 到「已装」找到项目,点击「使用」,按提示批准必要权限。
- 从插件坞、作者声明的侧栏页面或对应功能入口使用。
- 需要歌词源时,还要在歌词来源设置中选择已启用的提供器;订阅本身不会更换当前来源。
完整状态、停用和更新流程见工坊使用指南。
插件可以提供什么
Section titled “插件可以提供什么”| 类型 | 使用方式与边界 |
|---|---|
| 命令、工具面板、侧栏页面 | 由作品声明入口,按当前宿主能力显示 |
| 音源搜索与直链播放 | 作者实现搜索和解析;ECHO 管理来源确认、队列和播放,服务可用性由作品维护 |
| 歌词、元数据、封面候选 | 用户选择或应用候选;不把候选存在当作已经写入源文件 |
| 曲库、收藏、歌单与队列工具 | 只使用已声明、批准且宿主支持的接口 |
| 可视化与歌词创作 | 使用宿主提供的只读音频信息与播放时钟 |
| 音频插件接入配置 | 描述本机 VST3 身份、预设或路由,不分发厂商插件和许可证 |
工坊插件不是 ECHO 内置的在线曲库。第三方平台功能、账号要求、网络条件和内容权限以作品及相关服务说明为准。
权限与运行方式
Section titled “权限与运行方式”普通网页脚本默认在隔离 iframe 中运行,通过宿主接口取得批准的能力;不直接访问主界面 DOM、原始 IPC 或音频宿主。
部分版本允许作品声明 system:full,并配对独立的 .mjs trustedEntry。这要求订阅者另行批准完整系统访问,运行能力明显高于普通沙箱。只对已核对用途和来源的作品授权,具体能否启用以当前 Steam 构建的校验和提示为准。
权限获批不等于当前功能可用。平台、Pro 权益、网络、Audio Core 与安装版本都可能限制接口;插件应检查可用性,失败时给出明确提示,而不是反复弹出授权。
作者从哪里开始
Section titled “作者从哪里开始”使用工坊 SDK创建 plugin-package,编辑源文件后执行项目的 check 与 dev。SDK 生成 content/community.echo 和外层 content/echo.workshop.json 的文件清单与哈希,不应手改生成的哈希。
本地 mock 通过后,在 Steam 版 ECHO 中导入准备好的内容进行试用。本地导入工坊包仍使用工坊格式和校验,不等于旧社区版插件目录。发布由创作台确认,校验或预览不会自动上传。
| 现象 | 优先检查 |
|---|---|
| 订阅后找不到入口 | 下载状态、是否已点使用、是否要求权限,以及作者声明的入口 |
| 歌词源没有结果 | 提供器已启用且选中、歌曲元数据、作品和服务可用性 |
| 新接口不可用 | 宿主版本、兼容声明、具体权限与运行状态 |
| 更新后要求重新批准 | 新修订可能改变权限,重新核对用途再决定 |
| 插件卡住或持续报错 | 停用该作品,保留作品版本和诊断摘要;不要删除曲库排查插件问题 |