vbx

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.

Report Bug • Request Feature

✨ Features

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 ~/.vbx.json changes (daemon mode)

📋 Dependencies

build-essential
pkg-config
libjson-c-dev
libpulse-dev
libsndfile1-dev
libinput-dev
libevdev-dev
libudev-d

🚀 Installation

Arch Linux

paru -S vbx-git

🛠️ Build From Source

git clone https://github.com/S4NKALP/vbx.git
cd vbx
make
sudo make install

💡 Usage

Usage: vbx [OPTIONS]

Options:
  -S, --sound SOUND_NAME        Select sound pack (default: eg-oreo)
  -V, --volume VOLUME           Set volume [0-100] (default: 50)
  -d --daemon                   Run as a background daemon
  -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 ~/.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/vbx/soundpacks/

User packs go under: ~/.local/share/vbx/soundpacks/<device-name>/<pack-name>/

Required files inside each <pack-name>/ directory:

config.json (format matches bundled packs)
Audio files referenced by config.json

🤝 Contributing

PRs welcome. Please keep code modular and readable, and prefer small, focused changes.

📄 License

MIT — see LICENSE.

🙏 Credits

MechVibes for sound packs
showmethekey for code

3.4 KiB Raw Blame History Unescape Escape

vbx