Small, self-contained Lua plugins that demonstrate the spotatui plugin API. Copy one into your
config directory and restart spotatui to try it. See docs/scripting.md
for the full API reference. These examples are first-party and auditable; plugins run with full app
privileges, so read anything you install from elsewhere (see
Trust and safety).
| Plugin | What it shows |
|---|---|
track-notifier.lua |
Events, notify, set_playbar |
track-info-popup.lua |
register_command, reads, popup |
accent-cycler.lua |
register_command, set_theme |
now-playing-webhook.lua |
http_post, json_encode |
session-stats/ |
A directory plugin with a require-d helper module |
Single-file plugins go straight into plugins/:
cp track-notifier.lua ~/.config/spotatui/plugins/Directory plugins (a folder with a main.lua entry point) are copied as a whole:
cp -r session-stats ~/.config/spotatui/plugins/Restart spotatui after installing. Plugins that register commands need a key binding; add one to
~/.config/spotatui/config.yml under plugin_commands (each plugin documents a suggested key in
its header comment).
To install a plugin published as a git repository, use the built-in installer instead:
spotatui plugin add owner/repo