Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/uriel1998/vindauga
Download and display album art or display embedded (or folder-based) album art using a bash script; a largely rewritten fork of kunst
https://github.com/uriel1998/vindauga
album-art bash commandline conky linux mpc mpd music-player-daemon suckless
Last synced: 5 days ago
JSON representation
Download and display album art or display embedded (or folder-based) album art using a bash script; a largely rewritten fork of kunst
- Host: GitHub
- URL: https://github.com/uriel1998/vindauga
- Owner: uriel1998
- License: mit
- Created: 2019-06-28T02:48:21.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-11-14T09:58:25.000Z (12 months ago)
- Last Synced: 2023-11-15T07:33:28.647Z (12 months ago)
- Topics: album-art, bash, commandline, conky, linux, mpc, mpd, music-player-daemon, suckless
- Language: Shell
- Homepage: https://uriel1998.github.io/vindauga
- Size: 710 KB
- Stars: 10
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# vindauga
Display album art or display embedded (or folder-based) album art using a bash script. Massively simplified.
## Contents
1. [About](#1-about)
2. [License](#2-license)
3. [Prerequisites](#3-prerequisites)
4. [How to use](#4-how-to-use)
***
## 1. About
`vindauga` is a program that finds the album art for the currently playing song
in `audacious` or `mpd`, and then displays it in a little window or as part of
a `conky` display.
`vindauga` now loops on a timer.
it looks at the currently playing track from `audacious` first (because that's always local)
and if that's not running, then `mpd`. It then looks in the music directory to find
either `folder.jpg` or `cover.jpg`, and puts that in a cache directory for reading
by conky or what have you.
If *that* doesn't exist, then it decodes a built in default album image to
the cache directory.
At that point `conky` or any other program can display the image, which is located at
`${XDG_CACHE_HOME}/vindauga/nowplaying.album.png` (and if you already had [yadshow](https://ideatrash.net/2023/10/get-a-quick-popup-of-your-current-cover-art-from-the-music-player-daemon-mpd.html) installed to
pop up music covers, it will create a symlink between `${XDG_CACHE_HOME}/vindauga` and `${XDG_CACHE_HOME}/yadshow`.)
`vindauga` means "window".
All the album-art *finding* and *synchronizing* functionality has been moved and is
found with `f_fixer_covers`, as outlined in [this blog post](https://ideatrash.net/2023/10/finding-fixing-and-synchronizing-all-your-mp3-music-album-art-mostly-automatically-bash-script.html).
## 2. License
This project is licensed under the MIT license. For the full license, see `LICENSE`.
## 3. Prerequisites
* `imagemagick` command-line tool for parsing string data. `imagemagick` can be found on major Linux distributions.
* `mpc` command-line tool for controlling mpd. `mpc` can be found on major Linux distributions.
* `audtool` command-line tool for audacity.
## 4. How to use
Run `vindauga.sh` from the command line (or crontab, or even conky itself) at an
interval. The current album art is output at `${XDG_CACHE_HOME}/vindauga/nowplaying.album.png`
and the current song information is in a text file at `${XDG_CACHE_HOME}/vindauga/songinfo`.
There is an example `conkyrc` included. Throughout, replace `/home/USER` with your
home directory.
* `${execi 3 /path/to/vindauga.sh}` -- conky executes the program every 3 seconds, no need for cron.
* `${exec head /home/USER/.cache/vindauga/songinfo | sed 's/ - /\n/g'}` -- this parses it into three lines
* `${if_match "${audacious_status}" == "Playing"}${audacious_bar 7,253}${endif}${if_mpd_playing}${mpd_bar 7,253}${endif}` -- status bar depending on whether audacious is running or not.
### MPD Hosts
It assumes your music directory is in `${HOME}/Music`, that your album art is
named either `cover.jpg` or `folder.jpg` and that `mpc` is already
set up correctly.
It will attempt to use the environment variable `MPD_HOST`, and
if it is not found, will examine `${HOME}/.bashrc` to see if it is set there (if a
non-login shell) and set it for the program. If you have a password set for MPD,
you *must* use `MPD_HOST=Password@host` for it to work.
It will put the current cover in `${XDG_CACHE_HOME}/vindauga/nowplaying.album.png`
after making the corners of the cover rounded. If you are also using [yadshow](https://ideatrash.net/2023/10/get-a-quick-popup-of-your-current-cover-art-from-the-music-player-daemon-mpd.html),
it will symlink it so the two directories point to the same location to avoid duplicated effort.
### With Conky
I have enclosed a basic configuration for `conky` (as seen in the video above)
that has the information and layout that I want. Editing `conky`
configurations is well past the scope of this document.
See the file `vindauga_conkyrc` for the example.
