gonk 0.1.2

A terminal music player
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84

<h1 align="center" style="font-size: 55px">Gonk</h1>

<h3 align="center">A terminal music player.</h3>

<div align="center" style="display:inline">
      <img src="media/gonk.gif">
</div>

## ⚠️ 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](https://github.com/zX3no/gonk/releases/latest) 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 reset` to reset your database.

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

  ![](media/broken.png)

## ❤️ Contributing


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