gomp/README.md

41 lines
1.0 KiB
Markdown
Raw Normal View History

2021-10-08 08:52:09 -06:00
# goMP
2021-10-24 02:13:06 -06:00
![](https://img.shields.io/badge/status-alpha-red)
2021-10-08 08:52:09 -06:00
MPD client inspired by ncmpcpp written in GO
2021-10-11 02:42:51 -06:00
2021-11-05 02:08:38 -06:00
https://user-images.githubusercontent.com/51816057/140478368-5b724b2f-2499-4150-9569-c54734b3d4c1.mp4
2021-10-18 01:58:53 -06:00
# Roadmap
2021-10-18 01:59:23 -06:00
- [ ] Add Functionality to Sort out most played songs
2021-11-05 02:08:38 -06:00
- [x] Add a config parser ( Currently the feature isn't tested very well so use the config branch (once tested well it will be merged ) )
2021-10-24 02:13:06 -06:00
- [x] Image Previews
2021-10-19 07:28:11 -06:00
- [ ] Fuzzy Searching
- [ ] Visual Mode (like vim) for updating playlists
2021-10-28 00:15:14 -06:00
- [ ] Music Visualizer
2021-10-18 01:58:53 -06:00
# Prerequisites
- Music Player Daemon must be setup
- Go Should Be Installed ( for building )
2021-11-05 02:28:25 -06:00
- Make a YAML/TOML file in ``$HOME/.config/goMP`` named config.yml / config.toml
- Read the sample_config.yml for config options
2021-10-28 03:02:58 -06:00
2021-11-05 01:43:01 -06:00
### For config options see the [config branch](https://github.com/aditya-K2/goMP/tree/config)
2021-10-18 01:58:53 -06:00
# Installing / Building
```bash
2021-10-28 03:02:58 -06:00
git clone https://github.com/aditya-K2/goMP &&
2021-11-05 02:28:25 -06:00
git checkout config &&
2021-10-28 03:02:58 -06:00
cd goMP &&
go build
2021-10-18 01:58:53 -06:00
```
2021-10-28 22:54:29 -06:00
### Tested on following terminals:
- Alacritty
- ST
2021-10-29 02:32:44 -06:00
- URXVT