/tmux-spotify

:notes: TPM plugin around spotify (OSX only)

Primary LanguageShell

Tmux Spotify Plugin

Tmux plugin that shows the current music status for Spotify, Apple Music, or iTunes in your statusline.

Introduces the following new status variables:

  • #{music_status}
  • #{artist}
  • #{album}
  • #{track}

Usage

The following interpolations are made available for your statusline:

  • #{music_status} - Spotify status icons
  • #{artist} - Current artist
  • #{album} - Current album
  • #{track} - Current track

Here's the example in .tmux.conf:

set -g status-right "♫ #{music_status} #{artist}: #{track} | %a %h-%d %H:%M "

Customize the icons with:

set -g @spotify_playing_icon ">"
set -g @spotify_paused_icon "="

# optional: defaults to `paused_icon`
set -g @spotify_stopped_icon "X"

By default, Spotify is used as the media source. iTunes or Apple Music can be used by setting MUSIC_APP in your bashrc:

# set tmux-spotify to use Apple Music instead of Spotify
export MUSIC_APP="Music"

Set MUSIC_APP to iTunes instead on macOS Catalina.

If the status-right overflows when the music title is too long, you can increase the status-right-length by using the following line in .tmux.conf:

set -g status-right-length 70

Screenshots

status

Installation with Tmux Plugin Manager (recommended)

Add the plugin to the list of TPM plugins in .tmux.conf:

set -g @plugin 'robhurring/tmux-spotify'

Hit prefix + I to fetch the plugin and source it.

Manual Installation

Clone the repo:

$ git clone https://github.com/robhurring/tmux-spotify ~/clone/path

Add this line to the bottom of .tmux.conf:

run-shell ~/clone/path/music.tmux

Reload the TMUX environment:

# type this in the terminal
$ tmux source-file ~/.tmux.conf