docs: update README to reflect mouse support and config changes
This commit is contained in:
1 file changed
+16
-14
@@ -1,12 +1,12 @@
|
||||
<div align="center">
|
||||
<img src="assets/logo.png" alt="Project Logo", height="200">
|
||||
|
||||
> A CLI tool that brings realistic mechanical keyboard sounds to every keystroke.
|
||||
# vbx
|
||||
|
||||
vbx listens to your keyboard events and plays high‑quality switch sounds with low latency. It ships with multiple sound packs and supports your own custom packs. Run it interactively or as a background daemon with live reload of your preferences.
|
||||
> A CLI tool that brings realistic mechanical keyboard and mouse sounds to every keystroke.
|
||||
|
||||
vbx listens to your keyboard and mouse events and plays high‑quality switch sounds with low latency. It ships with multiple sound packs for both devices and supports your own custom packs. Run it interactively or as a background daemon with live reload of your references.
|
||||
|
||||
</div>
|
||||
|
||||
<div align="center">
|
||||
|
||||
[](https://github.com/S4NKALP/vbx/graphs/contributors)
|
||||
@@ -24,11 +24,12 @@ vbx listens to your keyboard events and plays high‑quality switch sounds with
|
||||
|
||||
## ✨ Features
|
||||
|
||||
- Real-time key press/release sound playback
|
||||
- Multiple bundled sound packs
|
||||
- User sound packs under `~/.local/share/keyvibe/audio/`
|
||||
- Real-time keyboard key press/release sound playback
|
||||
- Real-time mouse click sound playback
|
||||
- Multiple bundled sound packs for both keyboard and mouse
|
||||
- User sound packs under `~/.local/share/vbx/audio/`
|
||||
- Background daemon mode with PID file and safe shutdown
|
||||
- Live config reload on `~/.keyvibe.json` changes (daemon mode)
|
||||
- Live config reload on `~/.vbx.json` changes (daemon mode)
|
||||
|
||||
## 📋 Dependencies
|
||||
|
||||
@@ -46,7 +47,7 @@ vbx listens to your keyboard events and plays high‑quality switch sounds with
|
||||
### Arch Linux
|
||||
|
||||
```bash
|
||||
paru -S keyvibe
|
||||
paru -S vbx-git
|
||||
```
|
||||
|
||||
### 🛠️ Build From Source
|
||||
@@ -60,7 +61,7 @@ sudo make install
|
||||
|
||||
## 💡 Usage
|
||||
|
||||
Usage: keyvibe [OPTIONS]
|
||||
Usage: vbx [OPTIONS]
|
||||
|
||||
Options:
|
||||
-S, --sound SOUND_NAME Select sound pack (default: eg-oreo)
|
||||
@@ -69,20 +70,21 @@ sudo make install
|
||||
-s --stop Stop the background daemon
|
||||
-m --mute Mute sound
|
||||
-u --unmute Unmute sound
|
||||
-- enbale/disable DEVICE_NAME Enable/disable a device
|
||||
-l, --list List available sound packs
|
||||
-h, --help Show this help message
|
||||
-v, --verbose Enable verbose output
|
||||
|
||||
Notes:
|
||||
|
||||
- First run creates `~/.keyvibe.json`. Subsequent runs use it unless `-c` is supplied.
|
||||
- In daemon mode, editing `~/.keyvibe.json` will automatically reload.
|
||||
- First run creates `~/.vbx.json`. Subsequent runs use it unless `-c` is supplied.
|
||||
- In daemon mode, editing `~/.vbx.json` will automatically reload.
|
||||
|
||||
## 🎵 Sound Packs
|
||||
|
||||
System packs are installed under: `/usr/share/keyvibe/audio/`
|
||||
System packs are installed under: `/usr/share/vbx/soundpacks/`
|
||||
|
||||
User packs go under: `~/.local/share/keyvibe/audio/<pack-name>/`
|
||||
User packs go under: `~/.local/share/vbx/soundpacks/<device-name>/<pack-name>/`
|
||||
|
||||
Required files inside each `<pack-name>/` directory:
|
||||
|
||||
|
||||
Reference in new issue
Block a user