Skip to content

zX3no/gonk

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Gonk

A terminal music player.

⚠️ Warning

  • Gonk is under heavy development. Expect breaking changes.

✨ Features

  • Vim-style key bindings
  • Easy to use
  • Fuzzy search
  • Mouse support
  • Cross-platform
  • Plays FLAC, MP3, OGG, M4A and WAV

📦 Installation

MacOS has not been testing.

I recommend using a font with ligatures for the best experience.

Dependencies

Debian:

sudo apt install libasound2-dev pkg-config build-essential

Alpine:

apk add pkgconf alsa-lib-dev alpine-sdk

Arch:

pacman -S pkgconf alsa-lib base-devel

crates.io

cargo install gonk

Add your music:

gonk add D:/Music

⌨️ Key Bindings

Windows: %appdata%/gonk/gonk.toml

Linux: ~/.config/gonk/gonk.toml

Command Key
Move Up K / UP
Move Down J / Down
Move Left H / Left
Move Right L / Right
Volume Up W
Volume Up S
Play/Pause Space
Previous A
Next D
Seek -10s Q
Seek 10s E
Delete Song X
Clear Queue C
Clear Except Playing Shift + C
Randomize Queue R
Change Mode Tab
Search /
Update Database U
Quit Ctrl + C
Move Song 1 / Shift + 1
Move Album 2 / Shift + 2
Move Artist 3 / Shift + 3

⚒️ Troubleshooting

  • Gonk doesn't start after an update.

    Run gonk reset to reset your config file and database.

  • If your music player has broken lines, increase your zoom level or font size.

❤️ Contributing

Feel free to open an issue or submit a pull request!