gonk
| Crates.io | gonk |
| lib.rs | gonk |
| version | 0.1.2 |
| source | src |
| created_at | 2022-04-24 03:36:41.062334 |
| updated_at | 2022-08-13 01:33:48.090861 |
| description | A terminal music player |
| homepage | |
| repository | https://github.com/zX3no/gonk |
| max_upload_size | |
| id | 572933 |
| size | 125,417 |
Bay (zX3no)
documentation
README
Gonk
A terminal music player.
⚠️ Warning
- Gonk is under heavy development. Expect breaking changes.
✨ Features
- Easy to use
- Windows and Linux support (WASAPI, ALSA, Jack)
- Plays FLAC, MP3, OGG, M4A and WAV
- Fuzzy search
- Vim-style key bindings
- Mouse support
📦 Installation
I recommend a font with ligatures for the best experience.
Download the latest release and add some music.
gonk add ~/Music
From Source
Debian: sudo apt install libasound2-dev pkg-config build-essential libjack-jackd2-dev
Windows: Nothing required
git clone https://github.com/zX3no/gonk
cd gonk
cargo install --path gonk
gonk
⌨️ Key Bindings
| 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 | X |
| Delete without confirmation | Shift + X |
| Clear queue | C |
| Clear except playing | Shift + C |
| Change Mode | Tab |
| Settings | , |
| Playlists | . |
| Search | / |
| Add to playlist | Shift + Enter |
| 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 resetto reset your 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!