2020-06-23 19:27:59 +08:00
2020-06-23 20:17:09 +08:00
# Gomu (Go Music Player) [](https://goreportcard.com/report/github.com/issadarkthing/gomu)
2020-06-23 19:27:59 +08:00
Gomu is a Terminal User Interface **TUI** that plays your mp3 files in your local directory.
2020-06-27 11:41:08 +08:00
2020-06-23 19:27:59 +08:00
## Features
- lightweight
2020-06-28 13:50:59 +08:00
- simple
- fast
2020-06-23 19:27:59 +08:00
- show audio files as tree
2020-06-23 20:12:40 +08:00
- vim keybindings
2020-06-28 13:50:59 +08:00
- youtube-dl integration
- audio file management
2020-06-23 19:27:59 +08:00
2020-06-24 13:00:31 +08:00
## Installation
```sh
go get -u github.com/issadarkthing/gomu
```
2020-06-28 13:50:59 +08:00
## Configuration
By default, gomu will look for audio files in `~/music` directory. If you wish to change to your desired location, edit `~/.config/gomu/config` file
and change `music_dir: path/to/your/musicDir` . Example of the config file will look like:
```
confirm_on_exit: true
music_dir: ~/music
confirm_bulk_add: true
popup_timeout: 5
```
2020-07-03 12:31:38 +08:00
## Keybindings
| Key | Description |
|--------|------------------------|
| j | down |
| k | up |
| tab | change panel |
| space | toggle play/pause |
| esc | close popup |
| n | skip |
| q | quit |
| l | add song to queue |
| L | add playlist to queue |
| h | close node in playlist |
| d | remove from queue |
| D | delete playlist |
| + | volume up |
| - | volume down |
| ? | toggle help |
| Y | download audio |
| a | create playlist |
2020-06-23 19:27:59 +08:00
## Project Background
2020-06-24 13:00:31 +08:00
I just want to implement my own music player with a programming language im currently learning [Go ](https://golang.org/ ). Gomu might not be stable as it in constant development. For now, it can do basic music player can do like adding, deleting songs from queue, skip, play, pause but not seeking or more advanced stuff; feel free to contribute :)
