Skip to content

Commit 3c37f46

Browse files
add readme to global-keybinds plugin
1 parent 2e17757 commit 3c37f46

File tree

1 file changed

+50
-0
lines changed

1 file changed

+50
-0
lines changed
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Global Keybinds Plugin
2+
3+
This plugin enables system-wide **global keyboard shortcuts** for the music player. It allows you to control media playback, volume, and track ratings (like/dislike) from anywhere in your operating system, even when the application is minimized or not in focus.
4+
5+
## 🚀 Features
6+
7+
* **Global Control:** Control your music while working in other applications.
8+
* **Customizable:** Remap any action to your preferred key combination via the plugin settings.
9+
* **Smart Double-Tap:** A unique feature that allows you to toggle the player window's visibility by double-pressing the Play/Pause shortcut.
10+
11+
## 🎹 Default Shortcuts
12+
13+
By default, the plugin is configured with the following key combinations (using `Shift` + `Ctrl` to avoid conflicts with common system shortcuts):
14+
15+
| Action | Default Shortcut |
16+
| :--- | :--- |
17+
| **Play / Pause** | `Shift` + `Ctrl` + `Space` |
18+
| **Next Track** | `Shift` + `Ctrl` + `Right Arrow` |
19+
| **Previous Track** | `Shift` + `Ctrl` + `Left Arrow` |
20+
| **Volume Up** | `Shift` + `Ctrl` + `Up Arrow` |
21+
| **Volume Down** | `Shift` + `Ctrl` + `Down Arrow` |
22+
| **Like Track** | `Shift` + `Ctrl` + `=` |
23+
| **Dislike Track** | `Shift` + `Ctrl` + `-` |
24+
25+
## ⚙️ Configuration & Options
26+
27+
You can customize the behavior and key assignments through the plugin menu.
28+
29+
### Remapping Keys
30+
Click on the **"Keybinds Management"** option in the plugin menu. A prompt will appear allowing you to press the new key combination you wish to assign to each action.
31+
32+
### Window Visibility Toggle (Double Tap)
33+
* **Option:** `Double Tap to Toggle Window Visibility`
34+
* **Default:** `Enabled`
35+
* **How it works:**
36+
* **Single Press** on the Play/Pause shortcut: Toggles media playback.
37+
* **Double Press** (quickly): Shows or Hides the application window.
38+
39+
> **Note:** If you disable this option, the Play/Pause shortcut will only control playback, regardless of how fast you press it.
40+
41+
## 👨‍💻 Author
42+
43+
**Gabriel Pastori**
44+
* 🇧🇷 Brazilian Developer
45+
* GitHub: [gabrielpastori1](https://github.com/gabrielpastori1)
46+
47+
48+
## 🤝 Credits
49+
50+
This plugin was developed using the **precise-volume** plugin as a base and reference.

0 commit comments

Comments
 (0)