gomp/README.md

# 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 ( Currently the feature isn't tested very well so use the config branch (once tested well it will be merged ) )
- [x] Image Previews
- [ ] Fuzzy Searching
- [ ] Visual Mode (like vim) for updating playlists
- [ ] Music Visualizer

# Prerequisites

- 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

### For config options see the [config branch](https://github.com/aditya-K2/goMP/tree/config)

# Installing / Building

```bash
git clone https://github.com/aditya-K2/goMP &&
git checkout config &&
cd goMP &&
go build
```

### Tested on following terminals:

- Alacritty
- ST
- URXVT
Initial commit 2021-10-08 08:52:09 -06:00			`# goMP`
UPDATE README & Minor changes to App.go 2021-10-18 01:51:09 -06:00
Update README.md 2021-10-24 02:13:06 -06:00			`![](https://img.shields.io/badge/status-alpha-red)`
UPDATE README & Minor changes to App.go 2021-10-18 01:51:09 -06:00
Initial commit 2021-10-08 08:52:09 -06:00			`MPD client inspired by ncmpcpp written in GO`
Update README.md 2021-10-11 02:42:51 -06:00
minor changes 2021-11-05 02:30:21 -06:00			`https://user-images.githubusercontent.com/51816057/140478368-5b724b2f-2499-4150-9569-c54734b3d4c1.mp4`
Update README 2021-10-18 01:58:53 -06:00
			`# Roadmap`

Minor changes to README 2021-10-18 01:59:23 -06:00			`- [ ] Add Functionality to Sort out most played songs`
minor changes 2021-11-05 02:30:21 -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 ) )`
Update README.md 2021-10-24 02:13:06 -06:00			`- [x] Image Previews`
Update README.md 2021-10-19 07:28:11 -06:00			`- [ ] Fuzzy Searching`
			`- [ ] Visual Mode (like vim) for updating playlists`
Update README.md 2021-10-28 00:15:14 -06:00			`- [ ] Music Visualizer`
Update README 2021-10-18 01:58:53 -06:00
			`# Prerequisites`

			`- Music Player Daemon must be setup`
			`- Go Should Be Installed ( for building )`
UPDATE README and add config parser 2021-11-05 01:36:34 -06:00			- Make a YAML/TOML file in ``$HOME/.config/goMP`` named config.yml / config.toml
			`- Read the sample_config.yml for config options`
Additional Padding for Cover art to fit correctly As specified in #2 the image gets out of the preview box, the previous commit solves the problem but the image placement in the box differs from terminal to terminal it might need some extra padding so user can define some extra padding in the render.go 2021-10-28 22:44:57 -06:00
minor changes 2021-11-05 02:30:21 -06:00			`### For config options see the [config branch](https://github.com/aditya-K2/goMP/tree/config)`

Update README 2021-10-18 01:58:53 -06:00			`# Installing / Building`

			```bash
Information for #1 added to README 2021-10-28 03:02:58 -06:00			`git clone https://github.com/aditya-K2/goMP &&`
UPDATE README and add config parser 2021-11-05 01:36:34 -06:00			`git checkout config &&`
Information for #1 added to README 2021-10-28 03:02:58 -06:00			`cd goMP &&`
			`go build`
Update README 2021-10-18 01:58:53 -06:00			```
UPDATE README 2021-10-28 22:54:29 -06:00
			`### Tested on following terminals:`

			`- Alacritty`
			`- ST`
UPDATE README 2021-10-29 02:32:44 -06:00			`- URXVT`