mirror of
https://github.com/issadarkthing/gomu.git
synced 2025-05-02 22:17:09 +08:00
137 lines
4.9 KiB
Markdown
137 lines
4.9 KiB
Markdown
|
|
## Gomu (Go Music Player)
|
|
[](https://goreportcard.com/report/github.com/issadarkthing/gomu) [](https://travis-ci.com/issadarkthing/gomu)
|
|
|
|
Gomu is intuitive, powerful CLI music player. It has embedded scripting language
|
|
and event hook to enable user to customize their config extensively.
|
|
|
|
|
|
|
|
### Features
|
|
- lightweight
|
|
- simple
|
|
- fast
|
|
- show audio files as tree
|
|
- queue cache
|
|
- [vim](https://github.com/vim/vim) keybindings
|
|
- [youtube-dl](https://github.com/ytdl-org/youtube-dl) integration
|
|
- audio file management
|
|
- customizable
|
|
- find music from youtube
|
|
- scriptable config
|
|
- download lyric
|
|
- id3v2 tag editor
|
|
|
|
### Dependencies
|
|
If you are using ubuntu, you need to install alsa and required dependencies
|
|
```sh
|
|
$ sudo apt install libasound2-dev go
|
|
```
|
|
Optional dependencies can be installed by this command
|
|
```sh
|
|
$ sudo apt install youtube-dl
|
|
```
|
|
|
|
### Installation
|
|
|
|
```sh
|
|
$ go get -u github.com/issadarkthing/gomu
|
|
```
|
|
|
|
For arch users, you can install from the AUR
|
|
|
|
using [yay](https://github.com/Jguer/yay):
|
|
```sh
|
|
$ yay -S gomu
|
|
```
|
|
using [aura](https://github.com/fosskers/aura):
|
|
```sh
|
|
$ sudo aura -A gomu
|
|
```
|
|
|
|
|
|
### 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`.
|
|
|
|
|
|
### Keybindings
|
|
Each panel has it's own additional keybinding. To view the available keybinding for the specific panel use `?`
|
|
|
|
| Key (General) | Description |
|
|
|:----------------|--------------------------------:|
|
|
| tab | change panel |
|
|
| space | toggle play/pause |
|
|
| esc | close popup |
|
|
| n | skip |
|
|
| q | quit |
|
|
| + | volume up |
|
|
| - | volume down |
|
|
| f/F | forward 10/60 seconds |
|
|
| b/B | rewind 10/60 seconds |
|
|
| ? | toggle help |
|
|
| m | open repl |
|
|
| T | switch lyrics |
|
|
| c | show colors |
|
|
|
|
|
|
| Key (Playlist) | Description |
|
|
|:----------------|--------------------------------:|
|
|
| j | down |
|
|
| k | up |
|
|
| h | close node in playlist |
|
|
| a | create playlist |
|
|
| l (lowercase L) | add song to queue |
|
|
| L | add playlist to queue |
|
|
| d | delete file from filesystemd |
|
|
| D | delete playlist from filesystem |
|
|
| Y | download audio |
|
|
| r | refresh |
|
|
| R | rename |
|
|
| y/p | yank/paste file |
|
|
| / | find in playlist |
|
|
| s | search audio from youtube |
|
|
| t | edit mp3 tags |
|
|
| 1/2 | find lyric if available |
|
|
|
|
| Key (Queue) | Description |
|
|
|:----------------|--------------------------------:|
|
|
| j | down |
|
|
| k | up |
|
|
| l (lowercase L) | play selected song |
|
|
| d | remove from queue |
|
|
| D | delete playlist |
|
|
| z | toggle loop |
|
|
| s | shuffle |
|
|
| / | find in queue |
|
|
| t | lyric delay increase 0.5 second |
|
|
| r | lyric delay decrease 0.5 second |
|
|
|
|
### Scripting
|
|
|
|
Gomu uses [anko](https://github.com/mattn/anko) as its scripting language. You can read
|
|
more about scripting at our [wiki](https://github.com/issadarkthing/gomu/wiki)
|
|
|
|
``` go
|
|
|
|
Keybinds.def_g("ctrl_x", func() {
|
|
out, err = shell(`echo "hello world"`)
|
|
if err != nil {
|
|
debug_popup("an error occured")
|
|
}
|
|
info_popup(out)
|
|
})
|
|
|
|
```
|
|
|
|
### Project Background
|
|
I just wanted to implement my own music player with a programming language i'm currently learning ([Go](https://golang.org/)). Gomu might not be stable as it in constant development. For now, it can fulfill basic music player functions such as:
|
|
- add and delete songs from queue
|
|
- create playlists
|
|
- skip
|
|
- play
|
|
- pause
|
|
- forward and rewind
|
|
|
|
Seeking and more advanced stuff has not yet been implemented; feel free to contribute :)
|