Krolyxon
Commit be5b0cb

rmptuiREADME.md

56 lines · 3.2 KB · Markdown

1## rmptui - A MPD client in Rust
2![LOC](https://tokei.rs/b1/github/krolyxon/rmptui?category=code)
3![Release](https://img.shields.io/github/v/release/krolyxon/rmptui?color=%23c694ff)
4[![GitHub Downloads](https://img.shields.io/github/downloads/krolyxon/rmptui/total.svg?label=GitHub%20downloads)](https://github.com/krolyxon/rmptui/releases)
5
6rmptui is a minimal tui mpd client made with rust.
7
8## rmptui in action
9![](https://raw.githubusercontent.com/krolyxon/rmptui/master/assets/ss.png)
10
11### Keys
12| Key | Action |
13| --- | --- |
14| `q`/`Ctr+C` | Quit |
15| `p` | Toggle pause |
16| `+`/`=` | Increase volume |
17| `-` | Decrease volume |
18| `D` | Get dmenu prompt |
19| `j`/`Down` | Scroll down |
20| `k`/`Up` | Scroll up |
21| `J` | Swap highlighted song with next one |
22| `K` | Swap highlighted song with previous one |
23| `l`/`Right` | Add song to playlist or go inside the directory |
24| `h`/`Left` | Go back to previous directory |
25| `Tab` | Cycle through tabs |
26| `1` | Go to queue |
27| `2` | Go to directory browser |
28| `3` | Go to playlists view |
29| `Enter`/`l`/`Right` | Add song/playlist to current playlist |
30| `a` | Append the song to current playing queue |
31| `Space` | Delete the highlighted song from queue |
32| `f` | Go forwards |
33| `b` | Go backwards |
34| `>` | Play next song from queue |
35| `<` | Play previous song from queue |
36| `U` | Update the MPD database |
37| `r` | Toggle repeat |
38| `z` | Toggle random |
39| `/` | Search |
40| `g` | Go to top of list |
41| `G` | Go to bottom of list |
42
43### Prerequisites
44- [MPD](https://wiki.archlinux.org/title/Music_Player_Daemon) installed and configured.
45- [dmenu](https://tools.suckless.org/dmenu/) (optional)
46
47### TODO
48- [x] fix performance issues
49- [x] improvements on queue control
50- [x] add to playlists
51- [x] search for songs
52- [x] Human readable time format
53- [x] metadata based tree view
54- [x] view playlist
55- [x] change playlist name
56- [ ] add lyrics fetcher