mpdart/README.md

62 lines
1.4 KiB
Markdown
Raw Normal View History

2021-01-28 15:45:01 +01:00
mpdart
======
2021-01-28 18:22:45 +01:00
![preview gif](preview.gif)
2021-01-28 18:19:49 +01:00
mpdart is a simple X application that displays the album art of the currently playing mpd song and lets you toggle play pause. It spends almost all of it's time idle and only uses `0.1%` of my RAM and `0.0%` of my CPU according to top.
2021-01-28 15:45:01 +01:00
Depends
2021-01-28 15:45:01 +01:00
-------
2021-01-28 16:13:45 +01:00
C compiler
make
libX11
libmpdclient
libim2
pkg-config # optional build time dependency
2021-01-28 15:45:01 +01:00
Building
2021-01-28 15:45:01 +01:00
--------
./configure.sh
make
make install # supports PREFIX and DESTDIR
Usage
2021-01-28 15:45:01 +01:00
-----
2021-01-28 16:13:45 +01:00
There are four flags:
2021-01-28 15:45:01 +01:00
mpdart -d musicdir -h host -p port -t timeout # timeout is milliseconds
2021-01-28 15:45:01 +01:00
2021-01-28 16:13:45 +01:00
Though all but -d have default values:
2021-01-28 15:45:01 +01:00
mpdart -d ~/music
These options can also be configured in the enviorment variables `MPDART_DIR`, `MPDART_HOST`, `MPDART_PORT`, and `MPDART_TIMEOUT`.
2021-01-28 17:30:30 +01:00
To make these changes persistent, export them in your `~/.profile`.
Once mpdart is running you can left click the window to toggle mpd's pause/play or right click it to close it.
2021-01-28 15:45:01 +01:00
Contributing
2021-01-28 15:45:01 +01:00
------------
2021-01-28 18:32:30 +01:00
### Pull requests
2021-01-28 15:45:01 +01:00
If you like github you can contribute by sending in a pull request at
https://github.com/depsterr/mpdart
2021-01-28 18:32:30 +01:00
### Patches
2021-01-28 15:45:01 +01:00
If you don't like github you can contribute by emailing me at
depsterr at protonmail dot com with the output of
git format-patch
after you've commited your changes to your local tree.
Credits
2021-01-28 15:45:01 +01:00
-------
Big thanks to my friend wooosh for helping me debug and develop this :)