mpd_info_screen/README.md

62 lines
2.2 KiB
Markdown
Raw Normal View History

2021-09-16 07:06:26 +00:00
# mpd info screen
2021-09-17 05:54:25 +00:00
![mpd info screen preview image](https://git.seodisparate.com/stephenseo/mpd_info_screen/raw/branch/images/images/mpd_info_screen_preview_image.jpg)
2021-09-17 03:35:14 +00:00
2021-09-16 07:06:26 +00:00
A Rust program that displays info about the currently running MPD server.
2021-09-17 11:09:39 +00:00
The window shows albumart (may be embedded in the audio file, or is a "cover.jpg" in the same directory as the song file), a "time-remaining"
2021-09-16 07:06:26 +00:00
counter, and the filename currently being played
2021-09-16 07:08:29 +00:00
# Usage
mpd_info_screen 0.2.10
2021-09-16 07:08:29 +00:00
USAGE:
2021-09-17 11:00:01 +00:00
mpd_info_screen [FLAGS] [OPTIONS] <host> [port]
2021-09-16 07:08:29 +00:00
FLAGS:
--disable-show-artist disable artist display
--disable-show-filename disable filename display
--disable-show-title disable title display
--no-scale-fill don't scale-fill the album art to the window
--pprompt input password via prompt
2021-09-17 11:00:01 +00:00
-h, --help Prints help information
-V, --version Prints version information
2021-09-16 07:08:29 +00:00
OPTIONS:
2021-12-23 13:19:47 +00:00
-l, --log-level <log-level> [default: ERROR] [possible values: ERROR, WARNING, DEBUG, VERBOSE]
-p <password>
2021-09-16 07:08:29 +00:00
ARGS:
<host>
2021-09-16 07:08:29 +00:00
<port> [default: 6600]
Note that presing the Escape key when the window is focused closes the program.
2021-09-17 11:52:07 +00:00
2021-12-16 08:28:16 +00:00
Also note that pressing the H key while displaying text will hide the text.
2021-09-16 07:06:26 +00:00
# Issues / TODO
2021-12-15 10:46:53 +00:00
- [ ] UTF-8 Non-ascii font support
- [x] Support for album art not embedded but in the same directory
2021-09-16 07:06:26 +00:00
2021-12-27 02:25:56 +00:00
## MPD Version
To get album art from the image embedded with the audio file, the "readpicture"
protocol command is queried from MPD, which was added in version 0.22 of MPD.
It is uncertain when the "albumart" protocol command was added (this command
fetches album art that resides in cover.jpg/cover.png in the same directory as
the audio file). This means that older versions of MPD may not return album art
to display.
2021-09-16 07:06:26 +00:00
# Legal stuff
2021-12-15 10:46:53 +00:00
Uses dependency [ggez](https://github.com/ggez/ggez) which is licensed under the
MIT license.
2021-09-16 07:06:26 +00:00
Uses dependency [image](https://crates.io/crates/image) which is licensed under
MIT license.
Uses dependency [structopt](https://crates.io/crates/structopt) which is
licensed under Apache-2.0 or MIT licenses.