Spotube KMP Plugin Generator

Scaffold a Kotlin Multiplatform provider plugin for Spotube. The generated project includes TODO-based adapters for the selected Spotube APIs; implement the provider-specific behavior after generation.

Requirements

• JBang
• Java 21 or newer
• Git

Create a plugin

From a local checkout, run the interactive wizard:

jbang GenerateKmpPlugin.kt

The wizard asks for a service ID, author package group, display name, contact, repository URL, bugs URL, one or more APIs, and the cookie domains used by WebView login. Press Enter at the API prompt to select Metadata and Audio; the bugs URL defaults to <repository>/issues.

You can also supply all values directly:

jbang GenerateKmpPlugin.kt \
  --service lastfm \
  --author org.spotube.lastfm \
  --display-name "Last.fm" \
  --contact "maintainer@example.com" \
  --repository https://github.com/owner/spotube-plugin-lastfm \
  --bugs https://github.com/owner/spotube-plugin-lastfm/issues \
  --capabilities metadata,audio,lyrics,scrobble \
  --cookie-domains last.fm,www.last.fm \
  --output spotube_plugin_lastfm

The contact can be an email address or maintainer label. Repository and bugs URLs must be HTTP or HTTPS. --capabilities accepts a comma-separated, non-empty combination of metadata, audio, lyrics, and scrobble; --bugs may be omitted to use the repository's /issues URL. Existing output directories are not overwritten. The default output is ./spotube_plugin_<service-id>.

--cookie-domains sets cookieDomains in the generated spotubePlugin {} block: the hosts whose WebView cookies the plugin reads (getCookies) or whose pages it runs scripts on (evaluateJavaScript). Spotube (plugin API 0.1.0) refuses both for any host not listed. example.com matches only that host and *.example.com only its subdomains; list both if you need both. Omit the option if the plugin doesn't log in through the WebView; you can edit the list later in the module's build.gradle.kts.

JBang catalog

For a published catalog, run:

jbang create@team-spotube/spotube-plugin-template \
  --service lastfm \
  --author org.spotube.lastfm \
  --display-name "Last.fm" \
  --contact "maintainer@example.com" \
  --repository https://github.com/owner/spotube-plugin-lastfm \
  --bugs https://github.com/owner/spotube-plugin-lastfm/issues \
  --capabilities metadata,audio

From a local checkout, use jbang create@. instead. Use jbang GenerateKmpPlugin.kt --help for all options. Generated projects initialize their own Git repository. Logos and provider-specific endpoints can be customized after generation.