Steam Workshop Plug-in Guide
This guide covers ECHO Steam Workshop plug-ins. The legacy user-data plugins/ directory, echo.plugin.json, and older local plug-in APIs are not Steam Workshop installation or packaging instructions.
Use a plug-in
Section titled “Use a plug-in”- Launch ECHO from Steam and open Workshop → Discover.
- Review compatibility and required permissions, subscribe, and wait for Steam to download the item.
- Select Use in Installed and approve necessary permissions.
- Open the declared command, dock panel, sidebar page, or feature entry.
- For a lyrics provider, select it in lyrics-source settings; subscribing alone does not replace the current source.
See the Workshop user guide for states, disabling, and updates.
What plug-ins can provide
Section titled “What plug-ins can provide”| Type | Scope |
|---|---|
| Commands, tools, panels, sidebar pages | Entries declared by the item and supported by the host |
| Source search and direct playback | Author-owned search/resolution; ECHO owns source confirmation, queue, and playback |
| Lyrics, metadata, artwork candidates | User selection/application; finding a result does not establish a source-file write |
| Library, favorites, playlists, queue tools | Declared, approved, currently supported actions |
| Visualizers and lyrics-authoring tools | Host-provided read-only audio information and playback timing |
| Audio-plugin profiles | Local VST3 identity, presets, or routing; no vendor binaries or licenses |
Workshop items are not a built-in ECHO online catalog. Service availability, accounts, network conditions, and content rights depend on the item and provider.
Permissions and execution
Section titled “Permissions and execution”Ordinary scripts run in an isolated iframe and use approved host APIs. They do not directly access the parent UI DOM, raw IPC, or audio host.
Some builds allow system:full with a separate .mjs trustedEntry. This requires separate subscriber approval for full system access, with substantially broader capabilities than the ordinary sandbox. Review purpose and source before granting it; the installed Steam build’s validation and prompts determine availability.
Approval alone does not make an action usable. Platform, Pro ownership, networking, Audio Core, and host version still apply. Plug-ins should check availability and explain failures without repeating permission prompts.
Authoring
Section titled “Authoring”Use the Workshop SDK to create a plugin-package, edit sources, then run the project’s check and dev commands. The SDK generates content/community.echo and outer content/echo.workshop.json file inventories and hashes; do not edit generated hashes manually.
After mock validation, import prepared content into Steam ECHO for local trial. Local Workshop import uses the Workshop format and validator; it is not the legacy Community plug-in directory. Publishing requires confirmation in the Authoring Studio; checking and previewing do not upload.
- Developer guide: creation, compatibility, host interfaces.
- Sandbox plug-ins: commands, panels, providers.
- Local workflow and publishing.
Troubleshooting
Section titled “Troubleshooting”| Symptom | Check |
|---|---|
| No entry after subscribing | Download, Use, permission approval, declared entry |
| Empty lyrics results | Enabled/selected provider, metadata, item/service availability |
| New action unavailable | Host version, compatibility, permission, runtime state |
| Approval requested after update | Review the new revision and permission changes |
| Repeated errors or stalled item | Disable the item and retain its version and diagnostic summary; keep library data intact |