Krolyxon
Commit 529e5bd

rmptuiREADME.md

59 lines · 3.4 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| `m` | Toggle Mute |
19| `D` | Get dmenu prompt |
20| `j`/`Down` | Scroll down |
21| `k`/`Up` | Scroll up |
22| `J` | Swap highlighted song with next one |
23| `K` | Swap highlighted song with previous one |
24| `l`/`Right` | Add song to playlist or go inside the directory |
25| `h`/`Left` | Go back to previous directory |
26| `Tab` | Cycle through tabs |
27| `1` | Go to queue |
28| `2` | Go to directory browser |
29| `3` | Go to playlists view |
30| `Enter`/`l`/`Right` | Add song/playlist to current playlist |
31| `a` | Append the song to current playing queue |
32| `Space` | Delete the highlighted song from queue |
33| `f` | Go forwards |
34| `b` | Go backwards |
35| `>` | Play next song from queue |
36| `<` | Play previous song from queue |
37| `U` | Update the MPD database |
38| `r` | Toggle repeat |
39| `z` | Toggle random |
40| `/` | Search |
41| `R` | Rename Playlist |
42| `g` | Go to top of list |
43| `G` | Go to bottom of list |
44
45### Prerequisites
46- [MPD](https://wiki.archlinux.org/title/Music_Player_Daemon) installed and configured.
47- [dmenu](https://tools.suckless.org/dmenu/) (optional)
48
49### TODO
50- [x] fix performance issues
51- [x] improvements on queue control
52- [x] add to playlists
53- [x] search for songs
54- [x] Human readable time format
55- [x] metadata based tree view
56- [x] view playlist
57- [x] change playlist name
58- [x] add to new playlist
59- [ ] add lyrics fetcher