iamt4nk/smm.nvim
github
23
0
2
2
Spotify Music Manager - Neovim
[!CAUTION]
Currently the Spotify API does not allow free users to make any changes to playback. If you are a free user. Then please note you will still be able to view playback. But you will be unable to make any playback changes directly via the app. Unfortunately, there is nothing I can do about that.
SMM.nvim is a simple, minimal implementation for Spotify that allows users (currently) to view and control their current Spotify playback. This plugin does NOT stream any music itself, but rather it controls the current spotify player (regardless of device).
Spotify Apps that use the Spotify Web API do not allow you to specify a webhook. This pretty much means that the only thing we can do on the plugin is send requests every so often to sync with the servers.
Installation:
Very first step is creating a developer app with Spotify.
- Follow the steps in the Spotify Documentation to create your own App.
- Don't forget to add your account to the list of users in the "User Management" tab.
After this is created, then you can continue with installing the plugin on Neovim.
Configuration
Use the following configurations when installing this plugin:
- LazyVim:
{
'iamt4nk/smm.nvim',
dependencies = {
'nvim-lua/plenary.nvim',
'nvim-telescope/telescope.nvim',
},
config = {
premium = true,
icons = true, -- Whether to use nerdfonts
-- debug = true, -- These can be used in case there are any issues and you need to debug.
-- file = '/tmp/smm_debug.log'
playback = {
timer_update_interval = 250, -- How often the timer itself is updated in ms
timer_sync_interval = 5000, -- How often sync requests are sent to the server in ms
playback_pos = 'BottomRight', -- Options { 'TopLeft', 'TopRight', 'BottomLeft', 'BottomRight' }
playback_width = 40, -- Width of the playback window
progress_bar_width = 35, -- Width of the progress bar
},
spotify = {
api_retry_max = 3, -- The number of times to retry before failing out.
api_retry_backoff = 2000,
auth = { -- These are the only absolutely required configurations.
client_id = '<your client id>',
callback_url = '<your callback URL>',
callback_port = '<your callback port>',
},
},
},
},
(Feel free to add a PR with instructions to install for your package manager.)
Execution
To run this plugin for the first time run the command:
:Spotify
This will initiate an OAuth procedure, which, once completed will store a refresh token in your $HOME/.local/state/nvim/spotify directory, as well as store an api access token in memory.
Afterwards, it will also bring up the playback window with which you can view playback. You can run the same command again to git rid of the playback window.
Commands
There are a few other commands you can currently run if you are a Spotify Premium User:
:Spotify auth: Re-authorizes with the Spotify app in case there are issues:Spotify pause: Pauses current song:Spotify resume: Resumes current song:Spotify play (artist|album|song|playlist) <query>: Searches for the query and then starts playback from the selection.:Spotify change_device: Changes the device spotify is currently playing on.:Spotify next: Skip to the next song (if available):Spotify prev: Go to the previous song (if available)S:Spotify shuffle: Toggle the shuffle state. (This adds a "S" to the playback window title):Spotify repeat [track|off]: Changes the repeat state. No argument after repeat will repeat the entire context (album, artist, playlist, etc.)
[!NOTE] Spotify unfortunately does not allow starting a playback session from a device. Playback must initially start from the Spotify desktop/mobile/web app. When switching to another device, the Spotify app must be open on that device before switching.