Skip to main content

An mpd client with album art and basic functionality.

Project description

Miniplayer

A curses based mpd client with basic functionality and album art.

player-preview

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
  1. Through PyPi with
pip install miniplayer
  1. 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, 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

  • 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

  • host: The mpd host
  • port: The mpd port

Keybinds

Key function
h Show keybinds
p Play/pause
> Next track
< Last track
q Quit
+ Volume +5
- Volume -5

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

miniplayer-1.1.2.tar.gz (7.2 kB view hashes)

Uploaded Source

Built Distribution

miniplayer-1.1.2-py3-none-any.whl (7.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page