Home

Awesome

Gomu (Go Music Player)

Go Report Card Build Status <a href="https://www.buymeacoffee.com/raziman" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="41" width="174"></a>

Gomu is intuitive, powerful CLI music player. It has embedded scripting language and event hook to enable user to customize their config extensively.

gomu

Features

Dependencies

If you are using ubuntu, you need to install alsa and required dependencies

$ sudo apt install libasound2-dev go

Optional dependencies can be installed by this command

$ sudo apt install youtube-dl

Installation

$ go get -u github.com/issadarkthing/gomu

For arch users, you can install from the AUR

using yay:

$ yay -S gomu

using aura:

$ 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
tabchange panel
spacetoggle play/pause
escclose popup
nskip
qquit
+volume up
-volume down
f/Fforward 10/60 seconds
b/Brewind 10/60 seconds
?toggle help
mopen repl
Tswitch lyrics
cshow colors
Key (Playlist)Description
jdown
kup
hclose node in playlist
acreate playlist
l (lowercase L)add song to queue
Ladd playlist to queue
ddelete file from filesystemd
Ddelete playlist from filesystem
Ydownload audio
rrefresh
Rrename
y/pyank/paste file
/find in playlist
ssearch audio from youtube
tedit mp3 tags
1/2find lyric if available
Key (Queue)Description
jdown
kup
l (lowercase L)play selected song
dremove from queue
Ddelete playlist
ztoggle loop
sshuffle
/find in queue
tlyric delay increase 0.5 second
rlyric delay decrease 0.5 second

Scripting

Gomu uses anko as its scripting language. You can read more about scripting at our wiki


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). Gomu might not be stable as it in constant development. For now, it can fulfill basic music player functions such as:

Similar Projects

Album Photo

For songs downloaded by Gomu, the thumbnail will be embeded as Album cover. If you're not satisfied with the cover, you can edit it with kid3 and attach an image as album cover. Jpeg is tested, but other formats should work as well.

Donation

Hi! If you guys think the project is cool, you can buy me a coffee ;)

<a href="https://www.buymeacoffee.com/raziman" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="50" width="180"></a>

Seeking and more advanced stuff has not yet been implemented; feel free to contribute.