Skip to content
⌂ Home

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.

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.ts
  1. node .\bin\echo-workshop-sdk.mjs example hello-plugin .\my-hello then cd .\my-hello
  2. Read src/plugin.js — one command, playback:read only.
  3. To call echo.library.*, first npm run add -- --permission library:read
  4. After every edit: npm run check (syncs into community.echo)
  5. npm run dev — undeclared echo.* calls fail with capability-denied

Users enable via Workshop Use, then open Plugins at the bottom right → Steam Workshop.

  1. init .\my-catalog --recipe source-catalog
  2. npm run add -- --permission network:request if calling the network
  3. Declare networkHosts (bare domain, no protocol/port) in the outer manifest
  4. Implement search / browse / listCollection / resolve — resolve returns one playable http(s) URL
  5. npm run check — mock rejects undeclared hosts and custom ports
Preset / recipeIncludes
basic / helloOne command
complete / plugin-completeCommands, panel, agent, providers
catalog / source-catalogDirect-link catalog + panel
lyrics / lyrics-sourceLyrics provider + panel

Look up permissions:

Terminal window
node .\bin\echo-workshop-sdk.mjs api echo.queue.moveItem
node .\bin\echo-workshop-sdk.mjs api errors

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”

See examples and snippets.

  • Metadata / cover — examples/metadata-provider/; user selects candidates only.
  • Lyrics provider — lyrics-source recipe + lyrics-provider snippet.
  • Removed upload permission — current Steam rejects legacy playback:share; do not use old upload examples. sources:direct accepts authorized external URLs and cannot upload local library files. Application listening rooms are separate.