Sandbox plug-in tutorial
This page covers Steam Workshop plugin-package content. See the plug-in guide for activation and permissions. Index → Workshop SDK.
sources:provide / sources:direct expose author-owned HTTP(S) direct links only — not Netease, Spotify, or similar platforms. Legal boundary → Download and plug-in source policy.
Plug-in project layout
Section titled “Plug-in project layout”my-plugin/├── content/│ ├── echo.workshop.json│ └── community.echo # generated by check/sync — do not hand-edit├── src/│ └── plugin.js # main entry└── .echo-sdk/echo-workshop-plugin.d.tsWalkthrough A: hello plug-in
Section titled “Walkthrough A: hello plug-in”node .\bin\echo-workshop-sdk.mjs example hello-plugin .\my-hellothencd .\my-hello- Read
src/plugin.js— one command,playback:readonly. - To call
echo.library.*, firstnpm run add -- --permission library:read - After every edit:
npm run check(syncs intocommunity.echo) npm run dev— undeclaredecho.*calls fail with capability-denied
Users enable via Workshop Use, then open Plugins at the bottom right → Steam Workshop.
Walkthrough B: source catalog
Section titled “Walkthrough B: source catalog”init .\my-catalog --recipe source-catalognpm run add -- --permission network:requestif calling the network- Declare networkHosts (bare domain, no protocol/port) in the outer manifest
- Implement
search/browse/listCollection/resolve—resolvereturns one playable http(s) URL npm run check— mock rejects undeclared hosts and custom ports
Presets
Section titled “Presets”| Preset / recipe | Includes |
|---|---|
basic / hello | One command |
complete / plugin-complete | Commands, panel, agent, providers |
catalog / source-catalog | Direct-link catalog + panel |
lyrics / lyrics-source | Lyrics provider + panel |
Look up permissions:
node .\bin\echo-workshop-sdk.mjs api echo.queue.moveItemnode .\bin\echo-workshop-sdk.mjs api errorsPackage limits
Section titled “Package limits”Current source removes the old file-count and package-byte quotas. Host path, hash, type, permission, and runtime-budget validation still applies. Inner apiVersion must match outer compatibility.pluginApiVersion (2 for new items).
Local testing uses prepared Workshop content, not legacy plugins/ folders. See the Steam plug-in guide.
Advanced: metadata, lyrics, listen-together
Section titled “Advanced: metadata, lyrics, listen-together”- Metadata / cover —
examples/metadata-provider/; user selects candidates only. - Lyrics provider —
lyrics-sourcerecipe +lyrics-providersnippet. - Removed upload permission — current Steam rejects legacy
playback:share; do not use old upload examples.sources:directaccepts authorized external URLs and cannot upload local library files. Application listening rooms are separate.