Official examples and snippets
SDK examples/ includes complete projects and copy-paste fragments. Index → Workshop SDK.
List and copy
Section titled “List and copy”node .\bin\echo-workshop-sdk.mjs example listnode .\bin\echo-workshop-sdk.mjs example hello-plugin .\my-helloinit / example require an empty directory.
Complete projects
Section titled “Complete projects”| Example | Kind | Notes |
|---|---|---|
hello-plugin | Plug-in | Plug-in tutorial |
minimal-theme | Theme | Theme tutorial |
stylesheet-theme | Theme | ECHO 26.8.20+ |
retro-modern-ui-runtime | Theme | Runtime UI |
lyrics-cinema-scene | Lyrics | Cinema stage |
visualizer-radial | Visualizer | Radial spectrum |
dsp-vocal | DSP | Vocal EQ |
locale-wenyan | Locale | Literary Chinese |
Plug-in fragments
Section titled “Plug-in fragments”Copy from examples/<name>/plugin.js and declare matching contributes + permissions:
| Folder | Purpose |
|---|---|
lyrics-source | Lyrics candidates |
metadata-provider | Metadata/cover candidates |
network-source | Catalog + direct resolve |
listen-together | API 2 share upload |
author-agent | Custom agent handler |
complete-ui-theme | Importable theme preset fragment (not a Workshop theme pack) |
Snippets
Section titled “Snippets”node .\bin\echo-workshop-sdk.mjs snippet listType echo- in VS Code to expand .vscode/echo-workshop.code-snippets.
Mock limits
Section titled “Mock limits”test / dev enforce permissions and reject undeclared hosts but do not hit the real network or prove Steam client behavior.
Advanced plug-in topics → plug-in tutorial · advanced.