allen/miniplayer
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated README and project files

Browse Source
This commit is contained in:
Bart Kleijngeld
2021-08-09 15:47:16 +02:00
parent 8793e28fe0
commit e9e377f2ee
2 changed files with 8 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -24,19 +24,23 @@ pip install miniplayer
The config file is located at `~/.config/miniplayer/config`. The example configuration file, [`config.example`](config.example), has all the default values. You will need to create the file yourself. The config file is located at `~/.config/miniplayer/config`. The example configuration file, [`config.example`](config.example), has all the default values. You will need to create the file yourself.
#### player #### player
* ***music_directory*:** The path to your music directory for extracting album art.
* ***font_width*:** The width of your font in pixels in the actual terminal. * ***font_width*:** The width of your font in pixels in the actual terminal.
* ***font_height*:** The height of your font in pixels in the actual terminal. * ***font_height*:** The height of your font in pixels in the actual terminal.
![font-example](https://github.com/GuardKenzie/miniplayer/blob/main/img/font.png?raw=true) ![font-example](https://github.com/GuardKenzie/miniplayer/blob/main/img/font.png?raw=true)
* ***image_method*:** The method to use for drawing album art. Available values are `pixcat` and `ueberzug`
If you are not using Kitty, try `ueberzug`.
* ***volume_step*:** The ammount (in percents) the volume will be adjusted on pressing the volume up and volume down keys. * ***volume_step*:** The ammount (in percents) the volume will be adjusted on pressing the volume up and volume down keys.
* ***album_art_only*:** Whether or not to only draw the album art and no other track info (`true/false`). * ***album_art_only*:** Whether or not to only draw the album art and no other track info (`true/false`).
* ***auto_close*:** Whether or not to automatically close the player once the mpd playlist has concluded (`true/false`). * ***auto_close*:** Whether or not to automatically close the player once the mpd playlist has concluded (`true/false`).
* ***show_playlist*:** Whether or not to show the playlist view. * ***show_playlist*:** Whether or not to show the playlist view.
### art
* ***music_directory*:** The path to your music directory for extracting album art from the files.
* ***http_base_url*:** Base URL of webserver which serves the album art for your albums. Useful for users of Android MPD clients _MAFA_ or _MPDroid_.
For more information see [the MPDroid wiki](https://github.com/abarisain/dmix/wiki/Album-Art-on-your-LAN).
* ***image_method*:** The method to use for drawing album art. Available values are `pixcat` and `ueberzug`
If you are not using Kitty, try `ueberzug`.
#### mpd #### mpd
* ***host*:** The mpd host * ***host*:** The mpd host

2
setup.cfg
View File

@ -1,6 +1,6 @@
[metadata] [metadata]
name = miniplayer name = miniplayer
version = 1.3.2 version = 1.4.0
description = An mpd client with album art and basic functionality. description = An mpd client with album art and basic functionality.
long_description = file: README.md long_description = file: README.md
long_description_content_type = text/markdown long_description_content_type = text/markdown