taptap 🦀

An ultra-lightweight, high-performance mechanical keyboard sound simulator CLI written in Rust.

View on GitHub

Features

Installation

To install taptap globally on macOS, Linux, or Windows (Git Bash), run the following command in your terminal:

curl -fsSL https://raw.githubusercontent.com/ankushchk/taptap/master/install.sh | sh

Quick Start & Usage

Run the program from any directory:

taptap

CLI Commands & Flags

Adding Custom Soundpacks

You can add custom soundpacks by dropping their folders into either the local soundpacks/ directory or the global ~/.taptap/soundpacks/ directory. Each folder must contain:

  1. config.json: The mapping of scan codes to sound clips (Mechvibes standard).
  2. sound.ogg: The combined audio sprite file containing all sound clips.

Uninstallation

To completely remove taptap and all its downloaded soundpacks from your system, run the following commands in your terminal:

sudo rm /usr/local/bin/taptap
rm -rf ~/.taptap