Metadata-Version: 2.1
Name: miniplayer
Version: 1.2.0
Summary: An mpd client with album art and basic functionality.
Home-page: https://github.com/GuardKenzie/miniplayer
Author: Tristan Ferrua
Author-email: tristanferrua@gmail.com
License: UNKNOWN
Description: # Miniplayer
        
        A curses based mpd client with basic functionality and album art.
        
        ![player-preview](https://github.com/GuardKenzie/miniplayer/blob/main/img/preview.png?raw=true)
        
        After installation, the player can be opened from the terminal with `miniplayer`.
        
        ## Installation
        
        This package can be installed by:
        1. Cloning this repository to your computer and running
        ```
        python setup.py install
        ```
        2. Through PyPi with
        ```
        pip install miniplayer
        ```
        3. By installing the `miniplayer-git` package with your AUR package manager of choice.
        
        ## Configuration
        
        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
        * ***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_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)
        
        * ***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.
        * ***album_art_only*:** Weather or not to only draw the album art and no other track info (`true/false`).
        * ***auto_close*:** Weather or not to automatically close the player once the mpd playlist has concluded (`true/false`).
        
        
        #### mpd
        * ***host*:** The mpd host
        * ***port*:** The mpd port
        * ***pass*:** The mpd password
        
        
        #### keybindings
        This section allows you to change the keybinds for the player. The format for a keybind is `key = action` (for example `p = play_pause`). Available actions are
        * `play_pause`
        * `next_track`
        * `last_track`
        * `volume_down`
        * `volume_up`
        * `toggle_info`
        * `help`
        * `quit`
        
        
        ## Default keybinds
        
        | Key | function      |
        |-----|---------------|
        | h   | Show keybinds |
        | p   | Play/pause    |
        | >   | Next track    |
        | <   | Last track    |
        | q   | Quit          |
        | +   | Volume up     |
        | -   | Volume down   |
        | i   | Toggle info   |
        
        These keybinds can be changed by editing the config file. See the [`config.example`](config.example) file for the format.
        
            
        ## F.A.Q.
        1. **Q:** Album art is not showing up.  
        **A:** Make sure your `music_directory` is not quoted i.e. if your music directory is `~/My Music` then your config should look like `music_directory = ~/My Music`.  
        If this does not work, try changing `image_method` from `pixcat` to `ueberzug` or vice versa.
        
        2. **Q:** Album art is too big/too small.  
        **A:** You need to configure `font_height` and `font_width`. Their values should be the actual pixel height and width of a character in your terminal.
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
