hrfee/waybar-mpris
2
4
Fork 1
Code Issues 5 Pull Requests Projects Releases Wiki Activity

Add flags, executable and improve README.md

Browse Source
This commit is contained in:
Harvey Tindall
2020-08-22 15:40:24 +01:00
parent 5020e1c929
commit 54dcac02e6
6 changed files with 85 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -1,3 +1,17 @@
## waybar-mpris
a custom waybar component for displaying info from MPRIS2 players. Currently WIP.
a custom waybar component for displaying info from MPRIS2 players. It automatically focuses on currently playing music players, and can easily be customized.
## Usage
When running, the program will pipe out json in waybar's format. Make a custom component in your configuration and set `return-type` to `json`, and `exec` to the path to the program.
```
Usage of ./waybar-mpris:
--order string Element order. (default "SYMBOL:ARTIST:ALBUM:TITLE")
--pause string Pause symbol/text to use. (default "")
--play string Play symbol/text to use. (default "▶")
--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, 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.