mpd_info_screen/README.md

55 lines
1.8 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.1.0
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
--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:
-p <password>
ARGS:
<host>
<port> [default: 6600]
2021-09-16 07:42:19 +00:00
Note that Escape key and Q key pressed when the window is focused closes the
program.
2021-09-17 11:52:07 +00:00
Also, the "H" key hides the drawn text while it is pressed.
2021-09-16 07:06:26 +00:00
# Issues / TODO
2021-09-16 07:11:40 +00:00
- [ ] UTF-8 Non-ascii font support
2021-09-16 07:06:26 +00:00
([macroquad](https://crates.io/crates/macroquad) is being used to display a
window, text, and album art, but doesn't seem to have support for ".ttc" fonts
2021-09-16 07:10:45 +00:00
that could render CJK text)
- [x] Support for album art not embedded but in the same directory
2021-09-16 07:06:26 +00:00
# Legal stuff
Uses dependency [macroquad](https://crates.io/crates/macroquad) which is
licensed under either MIT or Apache-2.0 licenses.
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.