Krolyxon
Commit ec169d0

rmptuiREADME.md

54 lines · 1.8 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- `q` OR `Ctr+C` to quit
13- `p` to toggle pause
14- `+` to increase volume
15- `-` to decrease volume
16- `D` to get dmenu prompt
17- `j` OR `Down` to scroll down
18- `k` OR `Up` to scroll up
19- `J` to swap highlighted song with next one
20- `K` to swap highlighted song with previous one
21- `l` OR `Right` add song to playlist or go inside the directory
22- `h` OR `Left` to go back to previous directory
23- `Tab` to cycle through tabs
24- `1` to go to queue
25- `2` to go to directory browser
26- `3` to go to playlists view
27- `Enter` OR `l` OR `Right` to add song/playlist to current playlist
28- `a` to append the song to current playing queue
29- `Space`/`BackSpace` to delete the highlighted song from queue
30- `f` to go forwards
31- `b` to go backwards
32- `>` to play next song from queue
33- `<` to play previous song from queue
34- `U` to update the MPD database
35- `r` to toggle repeat
36- `z` to toggle random
37- `/` to search
38- `g` to go to top of list
39- `G` to go to bottom of list
40
41### Prerequisites
42- [MPD](https://wiki.archlinux.org/title/Music_Player_Daemon) installed and configured.
43- [dmenu](https://tools.suckless.org/dmenu/) (optional)
44
45### TODO
46- [x] fix performance issues
47- [x] improvements on queue control
48- [x] add to playlists
49- [x] search for songs
50- [x] Human readable time format
51- [x] metadata based tree view
52- [x] view playlist
53- [x] change playlist name
54- [ ] add lyrics fetcher