diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 60 |
1 files changed, 48 insertions, 12 deletions
@@ -1,6 +1,10 @@ mpd-notification ================ +[](https://github.com/eworm-de/mpd-notification/stargazers) +[](https://github.com/eworm-de/mpd-notification/network) +[](https://github.com/eworm-de/mpd-notification/watchers) + **Notify about tracks played by mpd** This runs in background and produces notifications whenever mpd produces @@ -15,23 +19,27 @@ This now even supports album artwork: Read below for the details. +*Use at your own risk*, pay attention to +[license and warranty](#license-and-warranty), and +[disclaimer on external links](#disclaimer-on-external-links)! + Requirements ------------ To compile and run `mpd-notification` you need: -* [systemd](https://www.github.com/systemd/systemd) -* [file](https://www.darwinsys.com/file/) for `libmagic` -* [iniparser](https://github.com/ndevilla/iniparser) -* [libav](https://libav.org/) or [ffmpeg](https://www.ffmpeg.org/) -* [libnotify](https://developer.gnome.org/notification-spec/) -* [libmpdclient](https://www.musicpd.org/libs/libmpdclient/) -* [markdown](https://daringfireball.net/projects/markdown/) (HTML documentation) +* [systemd ↗️](https://www.github.com/systemd/systemd) +* [file ↗️](https://www.darwinsys.com/file/) for `libmagic` +* [iniparser ↗️](https://github.com/ndevilla/iniparser) +* [libav ↗️](https://libav.org/) or [ffmpeg ↗️](https://www.ffmpeg.org/) +* [libnotify ↗️](https://developer.gnome.org/notification-spec/) +* [libmpdclient ↗️](https://www.musicpd.org/libs/libmpdclient/) +* [markdown ↗️](https://daringfireball.net/projects/markdown/) (HTML documentation) * `gnome-icon-theme` or `adwaita-icon-theme` (or anything else that includes an icon named `audio-x-generic`) To use `mpd-notification` you probably want `mpd`, the -[music player daemon](http://www.musicpd.org/) itself. ;) +[music player daemon ↗️](https://www.musicpd.org/) itself. ;) Some systems may require additional development packages for the libraries. Look for `libnotify-devel`, `libmpdclient-devel` or similar. @@ -41,11 +49,11 @@ Build and install Building and installing is very easy. Just run: -> make + make followed by: -> make install + make install This will place an executable at `/usr/bin/mpd-notification`, documentation can be found in `/usr/share/doc/mpd-notification/`. @@ -65,7 +73,6 @@ or `systemctl --user enable mpd-notification`. * *-m MUSIC-DIR*: use *MUSIC-DIR* for artwork lookup * *--notification-file-workaround*: write artwork to file for notification daemons that do required it -* *-o*: Notification text is one line (no line breaks) * *-p PORT*: connect to *PORT* * *-s PIXELS*: scale image to a maximum size *PIXELS* x *PIXELS* pixels, keeping ratio @@ -84,12 +91,23 @@ look like this: host = localhost port = 6600 music-dir = /srv/media/music/ - oneline = true scale = 200 + text-topic = MPD Notification + text-play = Playing <b>%t</b>\nby <i>%a</i>\nfrom <i>%A</i> + text-pause = Paused <b>%t</b>\nby <i>%a</i>\nfrom <i>%A</i> + text-stop = Stopped playback timeout = 20 Unused options can be commented or removed completely. +The options `text-play` and `text-pause` support custom formatting with +these specifiers: + +* *%t*: title +* *%a*: artist +* *%A*: album +* *%d*: duration + Artwork ------- @@ -115,6 +133,21 @@ but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the [GNU General Public License](COPYING.md) for more details. +Disclaimer on external links +---------------------------- + +Our website contains links to the websites of third parties ("external +links"). As the content of these websites is not under our control, we +cannot assume any liability for such external content. In all cases, the +provider of information of the linked websites is liable for the content +and accuracy of the information provided. At the point in time when the +links were placed, no infringements of the law were recognisable to us. +As soon as an infringement of the law becomes known to us, we will +immediately remove the link in question. + +> 💡️ **Hint**: All external links are marked with an arrow pointing +> diagonally in an up-right (or north-east) direction (↗️). + ### Upstream URL: @@ -123,3 +156,6 @@ URL: Mirror: [eworm.de](https://git.eworm.de/cgit.cgi/mpd-notification/) [GitLab.com](https://gitlab.com/eworm-de/mpd-notification#mpd-notification) + +--- +[⬆️ Go back to top](#top) |