The Workshop is officially open: create infinite possibilities

Salt Player PC (Salt Player for Windows) v1.19 Workshop is now officially live. Mod management, developer docs, and publishing tooling are available together at saltplayer.com/workshop. Both Windows and Linux desktop builds are supported; Steam users can subscribe to and download mods directly from the in-client Workshop.

This system has evolved continuously since experimental plugin support began last June. Mods run inside SPW’s JVM runtime and can tap into the full Java ecosystem: networking, file I/O, system APIs, and arbitrary third-party libraries. Player state and playback progress, line-by-line and word-by-word lyrics, library metadata and artwork, plus in-app and global hotkeys — these player capabilities are all exposed as public APIs. On top of that, UI hooks let mods intercept methods and reshape the UI itself.

Within just over a day of launch, several mods are already live on the Steam Workshop. The community’s published mods speak louder about what this API can do than our own documentation ever could.

To start developing, use Kotlin or Java inside a standard Gradle project. Pull in [c]spw-workshop-api[/c], extend [c]SpwPlugin[/c] for your main class, implement extension points with [c]@Extension[/c], then run the [c]plugin[/c] task to produce a [c].spmod[/c] file you can import straight into the player for testing.

No review is required to publish. Steam users can append [c]--workshop-publisher[/c] to the launch options; a Workshop Creator Hub​ entry will then appear inside the player, letting you upload [c].spmod[/c] files and cover art to publish or update directly. Alternatively, ship your [c].spmod[/c] via GitHub Releases and tag the repo with the [c]salt-player-plugins[/c] topic so others can discover it. We encourage open-source mods — already-published open-source mods make the best reference projects.

Status

The Workshop API is currently experimental. Interfaces will keep expanding and breaking changes may occur.

Resources

• Workshop docs: https://saltplayer.com/workshop

• API source & example project: https://github.com/Moriafly/spw-workshop-api

• Steam Workshop: browse, subscribe and manage from the Workshop​ tab on the store page

• Microsoft Store channel subscriptions: GitHub Topics recommended

• API issue reporting: GitHub Issues