kunst/README.md

38 lines
1.2 KiB
Markdown
Raw Normal View History

2019-02-15 08:11:08 +00:00
<p align="center"><img src="extra/kunst_logo.png"><br><sub>✨ Display embedded album art for mpd tracks ✨</sub></p>
2019-02-15 07:07:34 +00:00
2019-02-15 08:12:37 +00:00
```kunst``` is a deamon that extracts the album art from the songs playing in ```mpd``` and displays them in the a little window. It doesn't loop on a timer, instead it waits for ```mpd``` to send a ```player``` event. When it receives a ```player``` event, it wakes up and extracts the album art of the current playing track. This maks ```kunst```really lightweight and makes it idle at ```~0%``` CPU usage.
2019-02-15 05:08:49 +00:00
2019-02-13 17:37:37 +00:00
2019-02-15 08:12:37 +00:00
**Note:** ```kunst``` is meant to be used with files that have embedded album art. But, if a song that is currently playing, does not have an embedded album art, an image of a music note will be shown.
2019-02-13 17:37:37 +00:00
<p align="left">
<img src="extra/demo.gif" width="657.8" height="438.1">
</a>
</p>
2019-02-12 18:52:56 +00:00
## Dependencies
2019-02-13 17:37:37 +00:00
- ```sxiv```
- ```imagemagick```
- ```bash```
2019-02-15 17:59:21 +00:00
- ```ffmpeg```
- ```mpc```
2019-02-14 05:25:04 +00:00
## Installation
2019-02-14 05:47:15 +00:00
Add ```kunst``` to a directory which is in you ```$PATH```
2019-02-14 05:27:02 +00:00
2019-02-17 06:17:28 +00:00
**OR**
[AUR](https://aur.archlinux.org/packages/kunst-git/)
2019-02-14 05:27:02 +00:00
## TODO
- [x] use less CPU
2019-02-15 04:56:05 +00:00
- [ ] add arguments (need to learn how to do this)
2019-02-14 05:45:12 +00:00
- [ ] music directory
- [ ] image size (dimentions)
2019-02-14 08:14:19 +00:00
## License
MIT License
Copyright © 2019 Siddharth Dushantha