gomp/README.md

63 lines
1.8 KiB
Markdown
Raw Normal View History

2021-10-08 14:52:09 +00:00
# goMP
2021-10-24 08:13:06 +00:00
![](https://img.shields.io/badge/status-alpha-red)
2021-10-08 14:52:09 +00:00
MPD client inspired by ncmpcpp written in GO
2021-10-11 08:42:51 +00:00
2021-10-24 08:13:06 +00:00
https://user-images.githubusercontent.com/51816057/138585868-92aff5bd-dd7e-46af-bf06-28b83115120b.mp4
2021-10-18 07:58:53 +00:00
# Roadmap
2021-10-18 07:59:23 +00:00
- [ ] Add Functionality to Sort out most played songs
- [ ] Add a config parser ( preferably ***YAML*** )
2021-10-24 08:13:06 +00:00
- [x] Image Previews
2021-10-28 09:02:58 +00:00
- The Image Previews are working but the placement is very hacky and needs some work
2021-10-19 13:28:11 +00:00
- [ ] Fuzzy Searching
- [ ] Visual Mode (like vim) for updating playlists
2021-10-28 06:15:14 +00:00
- [ ] Music Visualizer
2021-10-18 07:58:53 +00:00
# Prerequisites
- Music Player Daemon must be setup
- Go Should Be Installed ( for building )
2021-10-24 08:00:50 +00:00
- Set the Path to your mpd DATABASE in progressbar.go
```go
2021-10-28 09:02:58 +00:00
var DBDIR string = "PATH TO YOUR MPD DATABASE HERE"
```
- In imageUtils.go set the path for your default Image
```go
var path string = "YOUR DEFAULT IMAGE PATH HERE"
2021-10-24 08:00:50 +00:00
```
2021-10-18 07:58:53 +00:00
# Installing / Building
```bash
2021-10-28 09:02:58 +00:00
git clone https://github.com/aditya-K2/goMP &&
cd goMP &&
go build
2021-10-18 07:58:53 +00:00
```
2021-10-28 09:12:13 +00:00
## Image Placement
The image is rendered by calculating pixels by multiplying the rows and columns with the font-width which is calculated by dividing the terminal width and height ( Please let me know if there is a better way to do this ) this let's to uneven placement so it is better that you disable the borders for the imagePreview holder.
in [App.go](https://github.com/aditya-K2/goMP/blob/master/App.go)
```go
imagePreviewer.SetBorder(false)
```
2021-10-28 09:20:16 +00:00
#### With Borders ( Sometimes \[Mostly Maximized Terminals\] )
![Oct28(Thu)02:4134PM](https://user-images.githubusercontent.com/51816057/139225915-b3e30742-65a8-4482-ad38-753646b5082f.png)
#### Without Borders
![Oct28(Thu)02:4513PM](https://user-images.githubusercontent.com/51816057/139226138-b68ebc22-204c-40f7-a7f2-0dd92b88f72b.png)
Note: Your terminal window padding also affects the tui.