gomp/README.md
2021-11-13 00:37:37 +05:30

91 lines
2.3 KiB
Markdown

# goMP
![](https://img.shields.io/badge/status-alpha-red)
MPD client inspired by ncmpcpp written in GO
https://user-images.githubusercontent.com/51816057/140478368-5b724b2f-2499-4150-9569-c54734b3d4c1.mp4
# Roadmap
- [ ] Add Functionality to Sort out most played songs
- [x] Add a config parser
- [x] Image Previews
- [x] User Key Mappings
- [ ] Fuzzy Searching
- [ ] Visual Mode (like vim) for updating playlists
# Setting Up
- Music Player Daemon must be setup
- Go Should Be Installed ( for building )
- Make a YAML/TOML file in ``$HOME/.config/goMP`` named config.yml / config.toml
- Read the sample_config.yml for config options
# Installing / Building
```bash
git clone https://github.com/aditya-K2/goMP &&
cd goMP &&
go build
```
# Configuration
## Key Mappings
Following Keys can be used for Mappings
| Keys | Using them in Config |
|-----------------|-----------------------|
| a-z | a-z |
| A-Z | A-z |
| {,},(,),[,],<,> | {,},(,),[,],<,> |
| Enter(Return) | ENTER/RETURN |
| Tab | TAB |
| Space | SPACE |
See config/kMap.go for more information
For mapping a key to some function use the following format:
```yml
Function: [ firstMapping, secondMapping, thirdMapping]
```
for.eg
```yml
togglePlayBack : [ "p", "TAB", "[" ] # using the quotes is neccessary.
```
Following functions are provided :
| Functions |
|------------------------------------|
| showChildrenContent |
| togglePlayBack |
| showParentContent |
| nextSong |
| clearPlaylist |
| previousSong |
| addToPlaylist |
| toggleRandom |
| toggleRepeat |
| decreaseVolume |
| increaseVolume |
| navigateToFiles |
| navigateToPlaylist |
| navigateToMostPlayed |
| quit |
| stop |
| updateDB |
| deleteSongFromPlaylist |
### Tested on following terminals:
- Alacritty
- ST
- URXVT