pww

command module
v0.0.8 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 2, 2024 License: MIT Imports: 8 Imported by: 0

README

PWW = Playerctl Waybar Wrapper

This is a simple program that emits a json with metadata info you can use in f.e. Waybar. Additionally you can let it auto-pause media players you provide, f.e. starting a video in your browser will pause spotify.

Install

Download binary

Simply download a pre-built binary from the release page

With Go

Regular GOBIN folder (make sure it's in your PATH): go install github.com/abenz1267/pww@latest

Install to custom location: GOBIN=<custom location> go install github.com/abenz1267/pww@latest

f.e. sudo GOBIN=/usr/bin/ go install github.com/abenz1267/pww@latest

Usage

command description example
pww -a <players> will launch a daemon monitoring given players in order to auto-pause/resume them pww -a spotify,firefox
pww -w <player>:<metadata info> will watch for changes and print them to stdout pww -w spotify:title will emit f.e. {"class": "Playing", "text": "Some Title"}
pww -t <player> will play/pause given player, launch it if it's not running at all pww -t spotify

Additionally a -p flag can be provided to specify a placeholder for empty text. F.e. when the player isn't running.

You can also provide -f flag to specify the format of the text output. F.e. pww -w spotify -f '{{title}} - {{artist}}' will emit {"class": "Playing", "text": "Song Title - Artist Name"}. You can find more information about supported formats here.

Waybar Example

This is how you'd use it as a custom module in Waybar.

//config
"custom/spotifytitle": {
    "format": "{}",
    "max-length": 40,
    "return-type": "json",
    "exec": "pww -w spotify:title -p None 2> /dev/null",
    "on-click": "playerctl --player=spotify play-pause 2> /dev/null",
    "on-scroll-up": "playerctl --player=spotify next 2> /dev/null",
    "on-scroll-down": "playerctl --player=spotify previous 2> /dev/null"
}

//style
#custom-spotifytitle {
  background: #98bb6c;
  color: #1f1f28;
  padding: 0 10px;
  margin-right: 10px;
  opacity: 1;
  transition-property: opacity;
  transition-duration: 0.25s;
}

#custom-spotifytitle.Paused,
#custom-spotifytitle.Inactive {
  opacity: 0.5;
}

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL