Skip to content

Display MPRIS metadata in Tmux (Spotify, Clementine, VLC, etc)

License

Notifications You must be signed in to change notification settings

richin13/tmux-plugin-playerctl

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

tmux-plugin-playerctl

A tmux plugin for using playerctl to display MPRIS meta-data about the music currently playing.

Pre-requisites

Make sure you have playerctl & bash installed.

# If you're in Arch
sudo pacman -S playerctl

See playerctl's instructions to get more details about installing it in other OS.

Installation

Installation with Tmux Plugin Manager (recommended)

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

set -g @plugin 'richin13/tmux-plugin-playerctl'

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

If format strings are added to status-right, they should now be visible.

Manual installation

Clone the repository

git clone https://github.com/richin13/tmux-plugin-playerctl ~/path/to/local/repo

Add the following line to your .tmux.conf:

run-shell ~/path/to/local/repo/playerctl.tmux

Usage

The currently available options are:

  • #{playerctl_artist}: Display the song's artist information
  • #{playerctl_title}: Display the song's title information
  • #{playerctl_album}: Display the song's album information
  • #{playerctl_full}: Display the song info in the format [Artist] - [Title]
  • #{playerctl_short}: Display the song info in the format [Artist] - [Title] but trimmed to a max number of characters (default: 30)

Just add the desired option to your .tmux.conf like this:

set -g status-right   "#{playerctl_full}"

Settings

Available settings for playerctl_short (shown values are the defaults):

#: Number of characters to show
set -g @short_length "30"

#: Character(s) to append at the end of the trimmed song name
set -g @short_append_chars "..."

License

See LICENSE

About

Display MPRIS metadata in Tmux (Spotify, Clementine, VLC, etc)

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages