kunst/README.md

90 lines
2.5 KiB
Markdown
Raw Normal View History

2019-02-19 15:28:32 +00:00
<p align="center"><img src="extra/kunst_logo.png"><br><sub>✨ Download and display album art or display embedded album art ✨</sub></p>
2019-02-15 07:07:34 +00:00
2019-02-20 09:34:53 +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 makes ```kunst```really lightweight and makes it idle at ```~0%``` CPU usage. If there no embbeded album art, it will try to fetch the album art from the internet.
2019-02-13 17:37:37 +00:00
<p align="left">
2020-01-29 11:19:17 +00:00
<img src="extra/demo.gif">
2019-02-13 17:37:37 +00:00
</a>
</p>
2019-02-12 18:52:56 +00:00
## Dependencies
- ```sxiv``` or ```imv```
2019-02-13 17:37:37 +00:00
- ```imagemagick```
- ```bash```
2019-02-15 17:59:21 +00:00
- ```ffmpeg```
- ```mpc```
2019-02-23 15:37:14 +00:00
- ```jq```
2019-12-27 12:02:42 +00:00
- ```mpd```
2019-02-14 05:25:04 +00:00
## Installation
2019-03-05 16:51:23 +00:00
### Install using ```make```
2019-02-19 17:28:30 +00:00
```bash
2019-03-05 17:41:21 +00:00
# Clone the repo
$ git clone https://github.com/sdushantha/kunst
# Change your current directory to kunst
$ cd kunst
# Install it
$ sudo make install
2019-02-19 17:28:30 +00:00
```
2019-03-05 16:51:23 +00:00
### Install it locally
```bash
# Download the kunst source code, save as kunst
# and make it executeable
2019-03-05 18:18:03 +00:00
$ curl -L git.io/raw-kunst > kunst && chmod +x kunst
2019-03-05 16:57:12 +00:00
2019-03-05 16:59:10 +00:00
# Then move kunst to somewhere in your $PATH
2019-03-05 16:57:12 +00:00
# Here is an example
$ mv kunst ~/script/
2019-03-05 16:51:23 +00:00
```
2019-02-19 17:01:45 +00:00
## Usage
```bash
$ kunst --help
2019-03-06 05:03:52 +00:00
usage: kunst [-h] [--size px] [--music_dir path/to/dir] [--silent] [--version]
2019-02-19 17:01:45 +00:00
┬┌─┬ ┬┌┐┌┌─┐┌┬┐
├┴┐│ ││││└─┐ │
┴ ┴└─┘┘└┘└─┘ ┴
2019-02-19 17:01:45 +00:00
Download and display album art or display embedded album art
2019-02-19 17:01:45 +00:00
optional arguments:
-h, --help show this help message and exit
--size what size to display the album art in
2020-01-29 14:02:24 +00:00
--position the position where the album art should be displayed
2019-02-19 17:01:45 +00:00
--music_dir the music directory which MPD plays from
2019-03-05 18:53:36 +00:00
--silent dont show the output
2019-02-20 16:35:44 +00:00
--version show the version of kunst you are using
2019-02-19 17:01:45 +00:00
```
2019-02-14 08:14:19 +00:00
2019-08-01 07:58:54 +01:00
## Configure
You can configure `kunst` through environment variables.
```bash
# The size of the album art to be displayed
export KUNST_SIZE="250x250"
# The position where the album art should be displayed
export KUNST_POSITION="+0+0"
2019-08-01 07:58:54 +01:00
# Where your music is located
export KUNST_MUSIC_DIR="/home/username/Music/"
```
2019-12-26 08:44:18 +00:00
<p align="center">
<a href="https://www.reddit.com/user/SpicyBroseph">
<img src="https://user-images.githubusercontent.com/27065646/53107999-89ec9480-3536-11e9-98a2-9ff416bf4589.png">
</a>
</p>
2019-02-14 08:14:19 +00:00
## License
MIT License
Copyright © 2019 Siddharth Dushantha