Wayvibes is a Wayland-native CLI made in C++ that plays mechanical keyboard sounds (or custom sounds) globally on keypresses. It utilizes libevdev to capture keypress events and miniaudio to play sounds.

curl -fsSl https://raw.githubusercontent.com/sahaj-b/wayvibes/main/install.sh | bash

Install wayvibes-git from AUR (maintained by @justanoobcoder).

#using yay
yay -S wayvibes-git

Add wayvibes url to your inputs:

inputs = {
  nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";

  wayvibes = {
    url = "github:sahaj-b/wayvibes";
    inputs.nixpkgs.follows = "nixpkgs";
  };
};

Install wayvibes and enable service using home-manager:

# home.nix
{inputs, ...}: {
  imports = [
    inputs.wayvibes.nixosModules.default
  ];

  services = {
    wayvibes = {
      enable = true;
      soundpack = "/home/youruser/wayvibes/soundpacks/cherrymx-red-abs";
      volume = 5;
    };
  };
}

Ensure the following dependencies are installed:

Ubuntu/debian-based distros:

• libevdev-dev
• nlohmann-json*-dev

Install them with: sudo apt install libevdev-dev nlohmann-json*-dev

Arch-based distros:

• libevdev
• nlohmann-json

Install them with: sudo pacman -S libevdev nlohmann-json

To install wayvibes, use the following commands:

git clone https://github.com/sahaj-b/wayvibes
cd wayvibes
make
sudo make install

cd ~/wayvibes
sudo make uninstall

1. Add user to the input group by the following command:

sudo usermod -a -G input <your_username>

2. Reboot or Logout and Login for the changes to take effect.

3. Run the application:

Usage: wayvibes [options] [soundpack_path]
Options:
  --device              Select input device
  --device-name <name>  Use input device by name
  -v <volume>           Set volume (0.0-10.0) (default: 1.0)
  --background, -bg     Run in background (detached from terminal)
  --help, -h            Show this help message;

Note: default soundpack path is `./`(current directory)

wayvibes <soundpack_path> -v <volume(0.0-10.0)>

Example:

wayvibes ~/wayvibes/soundpacks/akko_lavender_purples/ -v 3
wayvibes ~/wayvibes/soundpacks/nk-cream/ -v 5 --background

• Default Soundpack Path: ./
• Default Volume: 1

Upon the first run, Wayvibes will prompt you to select your keyboard device if there are multiple available. This selection will be stored in:

$XDG_CONFIG_HOME/wayvibes/input_device

Typically, the input device will be something like AT Translated Set 2 keyboard or USB Keyboard. If you use a key remapper like keyd, select its virtual device (e.g., keyd virtual keyboard).

To reset and prompt for input device selection again, use:

wayvibes --device

If you use NixOS, you have to restart the service after changing the device.

systemctl --user restart wayvibes.service

Wayvibes is compatible with the Mechvibes soundpack format. So, You can find soundpacks from the following sources:

• Mechvibes Soundpacks
• Discord Community (got akko_lavender_purples soundpack from here)

Some soundpacks with single audio file configuration won't work, use this tool to convert them into a compatible format

Ready-to-use soundpacks (already converted to wav format) are available in the soundpacks/ directory of this repository. Just clone the repo and point wayvibes to the pack:

wayvibes ~/wayvibes/soundpacks/nk-cream/ -v 3

Available packs:

• akko_lavender_purples
• apex pro
• banana split lubed / stock
• boxjade
• cherrymx-black-abs / cherrymx-black-pbt
• cherrymx-blue-abs / cherrymx-blue-pbt
• cherrymx-brown-pbt
• cherrymx-red-abs / cherrymx-red-pbt
• Creams
• eg-crystal-purple
• eg-oreo
• kalih-box-white
• mx-speed-silver
• nk-cream
• Razer Green (Blackwidow Elite) - Akira
• topre-purple-hybrid-pbt

Wayvibes uses miniaudio to play sounds, which doesn't support all ogg files by default. So, you need to convert ogg files to wav/mp3 files using ffmpeg or sox, and change the extensions in the config.json file. Use this command for this:

Converting ogg files to wav using ffmpeg and change extensions in config.json:

cd <soundpack_path>
for f in *.ogg; do ffmpeg -i "$f" "${f%.ogg}.wav"; done && sed -i 's/\.ogg/\.wav/g' config.json
rm *.ogg # remove ogg files

Unlike mechvibes and rustyvibes, which encounter issues on Wayland, Wayvibes aims to provide a seamless integration with wayland.