Skip to content

Commit

Permalink
Cleaned up the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@GuardKenzie
GuardKenzie committed Mar 29, 2022
1 parent b429e3f commit a20904f
Showing 1 changed file with 78 additions and 48 deletions.
126 changes: 78 additions & 48 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,51 +24,77 @@ 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.

#### player
* ***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.
Wow, that volume step is huge. Why isn't my album art centered?

![font-example](https://github.com/GuardKenzie/miniplayer/blob/main/img/font.png?raw=true)
| Option | Description |
| -------------- | ----------------------------------------------------------------------------------------------------- |
| 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. |
| 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`). |
| 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. |

The `font_width` and `font_height` options are used to center the album art properly.Here is an example of how they should be measured.

![font-example](https://github.com/GuardKenzie/miniplayer/blob/main/img/font.png?raw=true)

* ***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`).
* ***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.

#### 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 (takes precedence over `music_directory`). 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).
* ***http_cover_filenames*:** Space separated list of filenames to use in the call to the webserver to fetch the album art.
* ***image_method*:** The method to use for drawing album art. Available values are `pixcat` and `ueberzug`
If you are not using Kitty, try `ueberzug`.
Why listen to music if you can't look at the pretty album art?

| Option | Description |
| -------------------- | --------------------------------------------------------------------------------------------- |
| 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 (takes precedence over `music_directory`). 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).
| http_cover_filenames | Space separated list of filenames to use in the call to the webserver to fetch the album art. |
| image_method | The method to use for drawing album art. Available values are `pixcat` and `ueberzug`. |

#### mpd
* ***host*:** The mpd host
* ***port*:** The mpd port
* ***pass*:** The mpd password
Tell me your mpd address please!

| Option | Description |
| ------ | ---------------- |
| 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` or `left = last_track`). Available actions are
* `play_pause`
* `next_track`
* `last_track`
* `volume_down`
* `volume_up`
* `toggle_info`
* `help`
* `quit`
* `select_down`
* `select_up`
* `select`
This section allows you to change the keybinds for the player. The format for a keybind is `key = action` (for example `p = play_pause` or `left = last_track`).

To use `shift` as a modifier, capitalize the keybinding (i.e. `shift + p` becomes `P` and `shift + left` becomes `Left`). **This only works for alpha keys and the arrow keys!**

| Available actions |
| ----------------- |
| `play_pause` |
| `next_track` |
| `last_track` |
| `volume_down` |
| `volume_up` |
| `toggle_info` |
| `help` |
| `quit` |
| `select_down` |
| `select_up` |
| `select` |
| `move_up` |
| `move_down` |
| `shuffle` |
| `repeat` |
| `delete` |


#### theme
This section allows you to customise the colors and progress bar
* ***accent_color*:** The color to use for selections in the playlist
* ***bar_color*:** The color for the progress bar
* ***time_color*:** The color for the time stamp
* ***bar_body*:** A single character to use for the body of the progress bar
* ***bar_head*:** A single character to use for the head of the progress bar
Make it yours!

| Option | Description |
| ------------ | ---------------------------------------------------------- |
| accent_color | The color to use for selections in the playlist |
| bar_color | The color for the progress bar |
| time_color | The color for the time stamp |
| bar_body | A single character to use for the body of the progress bar |
| bar_head | A single character to use for the head of the progress bar |

The following terminal colors can be used:
* `black`
Expand All @@ -79,26 +105,30 @@ The following terminal colors can be used:
* `magenta`
* `cyan`
* `white`
* `auto`

If the `auto` color is specified, the player will try to determine the dominant color in the album art and use that.
You can also use the magic colour called `auto`. If you pick it, the player will try to determine the dominant color in the album art and use that instead.


## Default keybinds

| Key | function |
| ----- | ------------------ |
| h | Show keybinds |
| p | Play/pause |
| > | Next track |
| < | Last track |
| q | Quit |
| + | Volume up |
| - | Volume down |
| i | Toggle info |
| Up | Selection up |
| Down | Selection down |
| Enter | Play selected song |
| Key | Function |
| ------------ | ---------------------------------- |
| h | Show keybinds |
| p | Play/pause |
| > | Next track |
| < | Last track |
| q | Quit |
| + | Volume up |
| - | Volume down |
| i | Toggle info |
| Up | Selection up |
| Down | Selection down |
| Enter | Play selected song |
| Delete | Remove selected song from playlist |
| Shift + up | Move selected song up |
| Shift + down | Move selected song down |
| x | Shuffle playlist |
| r | Toggle repeat |

These keybinds can be changed by editing the config file. See the [`config.example`](config.example) file for the format.

Expand Down

0 comments on commit a20904f

Please sign in to comment.