Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/sdushantha/kunst

Download and display album art or display embedded album art
https://github.com/sdushantha/kunst

album-art album-cover bash commandline linux mpc mpd music suckless

Last synced: 2 months ago
JSON representation

Download and display album art or display embedded album art

Host: GitHub
URL: https://github.com/sdushantha/kunst
Owner: sdushantha
License: mit
Created: 2019-02-12T18:50:25.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2024-01-06T08:24:11.000Z (6 months ago)
Last Synced: 2024-01-21T23:54:17.532Z (5 months ago)
Topics: album-art, album-cover, bash, commandline, linux, mpc, mpd, music, suckless
Language: Shell
Homepage:
Size: 34.6 MB
Stars: 302
Watchers: 5
Forks: 30
Open Issues: 14
Metadata Files:
- Readme: README.md
- License: LICENSE

Lists

awesome - sdushantha/kunst - Download and display album art or display embedded album art (Shell)

README

_{✨ Download and display album art or display embedded album art ✨}

```kunst``` is a daemon 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.

## Dependencies
- ```sxiv```
- ```bash```
- ```ffmpeg```
- ```mpc```
- ```jq```
- ```mpd```

## Installation
### Install using ```make```
```bash
# Clone the repo
$ git clone https://github.com/sdushantha/kunst

# Change your current directory to kunst
$ cd kunst

# Install it
$ sudo make install
```
### Install it locally

```bash
# Download the kunst source code, save as kunst, make it executeable
# and then move it to ~/.local/bin
$ curl -L git.io/raw-kunst > kunst && chmod +x kunst && mv kunst ~/.local/bin
```

## Usage

```bash
$ kunst --help
usage: kunst [-h] [--size px] [--music_dir path/to/dir] [--silent] [--version]

┬┌─┬ ┬┌┐┌┌─┐┌┬┐
├┴┐│ ││││└─┐ │
┴ ┴└─┘┘└┘└─┘ ┴
Download and display album art or display embedded album art

optional arguments:
-h, --help show this help message and exit
--size what size to display the album art in
--position the position where the album art should be displayed
--music_dir the music directory which MPD plays from
--silent dont show the output
--version show the version of kunst you are using
```

## 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"

# Where your music is located
export KUNST_MUSIC_DIR="/home/username/Music/"
```

## License
MIT License