gomp/README.md

50 lines
1.2 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-10-24 02:13:06 -06:00
https://user-images.githubusercontent.com/51816057/138585868-92aff5bd-dd7e-46af-bf06-28b83115120b.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
- [ ] Add a config parser ( preferably ***YAML*** )
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 )
- Set the Path to your mpd DATABASE in [progressbar.go](https://github.com/aditya-K2/goMP/blob/master/progressBar.go)
2021-10-24 02:00:50 -06:00
```go
2021-10-28 03:02:58 -06:00
var DBDIR string = "PATH TO YOUR MPD DATABASE HERE"
```
- In [imageUtils.go](https://github.com/aditya-K2/goMP/blob/master/imageUtils.go) set the path for your default Image
2021-10-28 03:02:58 -06:00
```go
var path string = "YOUR DEFAULT IMAGE PATH HERE"
2021-10-24 02:00:50 -06:00
```
2021-10-18 01:58:53 -06:00
- Change the default additional Image padding according to your terminal in [render.go](https://github.com/aditya-K2/goMP/blob/master/render.go)
```go
// Change according to your needs
var ADDITIONAL_PADDING_X int = 16
var ADDITIONAL_PADDING_Y int = 24
```
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 &&
cd goMP &&
go build
2021-10-18 01:58:53 -06:00
```