MPRIS2 waybar component
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Harvey Tindall 16465c44a2
add license.
9 months ago
dist update readme, mention AUR package 10 months ago
images update readme, mention AUR package 10 months ago
.drone.yml url 10 months ago
.gitignore add players as detected, switch to currently playing player on state 1 year ago
.goreleaser.yml add drone/buildrone 10 months ago
LICENSE add license. 9 months ago add message on issues 10 months ago
go.mod Use fixes for spotify 10 months ago
go.sum Use fixes for spotify 10 months ago
main.go use external mpris2client lib 10 months ago
waybar-mpris Use fixes for spotify 10 months ago


bar gif

a waybar component/utility for displaying and controlling MPRIS2 compliant media players individually, inspired by waybar-media.

MPRIS2 is widely supported, so this component should work with:

  • Chrome/Chromium
  • Firefox (Limited support with media.hardwaremediakeys.enabled = true in about:config)
  • Other browsers (using KDE Plasma Integration)
  • VLC
  • Spotify
  • Noson
  • mpd (with mpDris2)
  • Most other music/media players


Available on the AUR as waybar-mpris-git (Thanks @nichobi!)

go get will compile from source and install.

You can also download a precompiled binaries from here.


Stick them on mpris2client or the og repository (both on github) if you can't make an account here.


When running, the program will pipe out json in waybar's format. Add something like this to your waybar config.json:

"custom/waybar-mpris": {
    "return-type": "json",
    "exec": "waybar-mpris --position --autofocus",
    "on-click": "waybar-mpris --send toggle",
    // This option will switch between players on right click.
        "on-click-right": "waybar-mpris --send player-next",
    // The options below will switch the selected player on scroll
        // "on-scroll-up": "waybar-mpris --send player-next",
        // "on-scroll-down": "waybar-mpris --send player-prev",
    // The options below will go to next/previous track on scroll
        // "on-scroll-up": "waybar-mpris --send next",
        // "on-scroll-down": "waybar-mpris --send prev",
    "escape": true,
Usage of waybar-mpris:
      --autofocus          Auto switch to currently playing music players.
      --interpolate        Interpolate track position (helpful for players that don't update regularly, e.g mpDris2)
      --order string       Element order. (default "SYMBOL:ARTIST:ALBUM:TITLE:POSITION")
      --pause string       Pause symbol/text to use. (default "\uf8e3")
      --play string        Play symbol/text to use. (default "▶")
      --position           Show current position between brackets, e.g (04:50/05:00)
      --replace            Replace any running instances
      --send string        send command to already runnning waybar-mpris instance. (options: player-next/player-prev/next/prev/toggle)
      --separator string   Separator string to use between artist, album, and title. (default " - ")
  • Modify the order of components with --order. SYMBOL is the play/paused icon or text, POSITION is the track position (if enabled), other options are self explanatory.
  • --play/--pause specify the symbols or text to display when music is paused/playing respectively.
  • --separator specifies a string to separate the artist, album and title text.
  • --autofocus makes waybar-mpris automatically focus on currently playing music players.
  • --position enables the display of the track position.
  • --interpolate increments the track position every second. This is useful for players (e.g mpDris2) that don't regularly update the position.
  • --replace: By default, new instances will attach to the existing one so that the output is identical. This lets this instance replace any others running. It isn't recommended.
  • --send sends commands to an already running waybar-mpris instance via a unix socket. Commands:
    • player-next: Switch to displaying and controlling next available player.
    • player-prev: Same as player-next, but for the previous player.
    • next/prev: Next/previous track on the selected player.
    • toggle: Play/pause.
    • You can also bind these commands to Media keys in your WM config.