Thock

<a name="readme-top"></a>

<!-- PROJECT LOGO --> <br /> <div align="center"> <img src="docs/readme/icon.png" alt="Logo" width="80" height="80"> <h3 align="center">Thock</h3> <p align="center"> A native macOS utility that adds sound effects to your keyboard. <br />Blazing fast, lightweight and runs in the menu bar. <br /><br /> <a href="https://github.com/kamillobinski/thock/releases/latest" target="_blank" rel="noopener noreferrer"> <img src="https://img.shields.io/github/v/release/kamillobinski/thock?style=rounded&color=white&labelColor=000000&label=release" alt="Release Version" /> </a> <a href="#" target="_blank" rel="noopener noreferrer"> <img alt="GitHub Downloads" src="https://img.shields.io/github/downloads/kamillobinski/thock/total?style=rounded&color=white&labelColor=000000"> </a> <a href="https://discord.gg/sGVaUxgfJx" target="_blank" rel="noopener noreferrer"> <img alt="Discord" src="https://img.shields.io/discord/1453196153771397286?style=rounded&color=white&labelColor=000000&label=discord"> </a> <a href="https://deepwiki.com/kamillobinski/thock" target="_blank" rel="noopener noreferrer"> <img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki"/> </a> </p> </div> <!-- TABLE OF CONTENTS --> <details> <summary>Table of Contents</summary> <ol> <li><a href="#about-the-project">About The Project</a></li> <li> <a href="#features">Features</a> <ul> <li><a href="#custom-engine">Custom Engine</a></li> <li><a href="#sound-library">Sound Library</a></li> <li><a href="#smart-integration">Smart Integration</a></li> <li><a href="#advanced-control">Advanced Control</a></li> <li><a href="#translation">Translation</a></li> </ul> </li> <li><a href="#getting-started">Getting Started</a></li> <li><a href="#license">License</a></li> <li><a href="#contributing">Contributing</a></li> <li><a href="#acknowledgments">Acknowledgments</a></li> </ol> </details> <!-- ABOUT THE PROJECT -->

About The Project

Thock is a high-performance utility designed to bring the tactile satisfaction of mechanical switches to your macOS workspace. Built natively in Swift, it bridges the gap between hardware feel and software execution with zero compromises on speed or privacy.

Started this project to challenge the status quo. While paid alternatives exist, Thock is built on the belief that the best tools should be open-source and community-driven. By focusing on a custom low-latency engine and deep system integration, Thock offers a professional-grade typing experience that stays out of your way and keeps your flow state intact.

🍺 Homebrew: <code>brew install --cask kamillobinski/thock/thock</code><br/>

<p align="right">(<a href="#readme-top">back to top</a>)</p> <!-- FEATURES -->

Features

<details> <summary>Quick Overview (if you don't feel like scrolling today)</summary> <br/> <table> <thead> <tr> <th width="300px">Feature</th> <th width="700px">Description</th> </tr> </thead> <tbody> <tr> <td><b>Custom Engine</b></td> <td>Native AudioQueue APIs achieving ultra-low latency for perfectly synced feedback.</td> </tr> <tr> <td><b>Sound Library</b></td> <td>Extensible JSON-based architecture to import or create custom switch profiles.</td> </tr> <tr> <td><b>Smart Integration</b></td> <td>Music awareness that automatically mutes audio during playback.</td> </tr> <tr> <td><b>Advanced Control</b></td> <td>Hands-on-keys management via Raycast extension and dedicated CLI.</td> </tr> <tr> <td><b>Translation</b></td> <td>Fully localized interface for English, Español, Français, 日本語, 中文, Deutsch, Italiano and Vietnamese users.</td> </tr> </tbody> </table> </details>

Custom Engine

Features a custom audio engine built on native macOS AudioQueue APIs, achieving ultra-low latency that feels instantaneous. By bypassing standard high-level processing layers, we have eliminated perceptual lag to provide perfectly synced auditory feedback.

Whether you are a high-speed programmer or a creative writer, Thock ensures every keystroke is met with organic, realtime sound that keeps pace with your fastest workflow.

<p align="right">(<a href="#readme-top">back to top</a>)</p>

Sound Library

Built to be an open platform. While the app comes pre-loaded with high-quality recordings, you aren't limited to the defaults.

With support for custom sound packs, you can easily import new switch profiles or create your own using a simple JSON structure. Whether you want the heavy 'thock' of a vintage board or a completely unique experimental soundscape, you can expand your library to suit your specific taste. Drop your folder into the directory and switch profiles instantly.

<p align="right">(<a href="#readme-top">back to top</a>)</p>

Smart Integration

With music awareness, Thock intelligently manages your soundscape so you never have to manually toggle settings. By detecting active playback from apps like Spotify or Apple Music, it automatically mutes its typing sounds to let your music take priority.

As soon as the music stops, the app instantly resumes your mechanical feedback. It's a seamless, 'set-and-forget' feature designed for deep work sessions where your focus shifts between rhythm of your keys and the rhythm of your playlist.

Supported: Apple Music, Spotify, VLC

<p align="right">(<a href="#readme-top">back to top</a>)</p>

Advanced Control

Built for power users, Thock extends beyond the menu bar with its own Raycast Extension and a dedicated CLI. This integration allows you to toggle the audio engine and switch sound packs entirely via the command bar.

By exposing every core function to the system, Thock fits seamlessly into your automation workflows and productivity scripts. Whether you're using Raycast, Alfred, or the terminal, you have total control over your typing environment without ever lifting your hands.

<p align="right">(<a href="#readme-top">back to top</a>)</p>

Translation

With localization, Thock bridges the gap between powerful functionality and effortless usability. The interface is fully translated into multiple languages, allowing users to navigate the ecosystem without language barriers.

Select your preferred language in the general settings to enjoy a workspace tailored to your needs.

Supported: 🇺🇸 English, 🇪🇸 Spanish, 🇫🇷 French, 🇨🇳 Chinese, 🇯🇵 Japanese, 🇩🇪 German, 🇮🇹 Italian, 🇻🇳 Vietnamese.

<p align="right">(<a href="#readme-top">back to top</a>)</p> <!-- GETTING STARTED -->

Getting Started

It's quick and easy. You can either download a prebuilt release or build it yourself if you prefer.

[!WARNING]
Thock requires macOS 13.5 Ventura or later.

A Homebrew Cask Installation (recommended)

brew tap kamillobinski/thock
brew install --cask thock

or one command:

brew install --cask kamillobinski/thock/thock

<details> <summary><b>B</b>: Release Download</summary>

1. Go to the latest release
2. Download Thock-x.y.z.zip
3. Unpack the ZIP file
4. Move the app to your Applications folder for easy access
5. Open Thock

</details> <details> <summary><b>C</b>: Build From Source</summary>

1. Clone the repository

   git clone https://github.com/kamillobinski/thock.git
   cd thock
   

2. Open in Xcode

   open Thock.xcodeproj
   

3. Build and run the application

</details> <p align="right">(<a href="#readme-top">back to top</a>)</p> <!-- LICENSE -->

License

Distributed under the MIT License. See LICENSE for more information.

<p align="right">(<a href="#readme-top">back to top</a>)</p> <!-- CONTRIBUTING -->

Contributing

Got an idea or want to improve something? Awesome!

Check out the contributing guide for everything you need to know.

<p align="right">(<a href="#readme-top">back to top</a>)</p> <!-- ACKNOWLEDGMENTS -->

Acknowledgments

Thanks to the folks that helped make this project a reality!

| Contributor | Contribution | | - | - | | sasagar | VLC auto-launch prevention. | | nthnbch | French translations. | | Bcharlit | German translations. | | Crocchetto | Italian translations. | | Kaedeeeeeeeeee | Dynamic localization (Japanese + Chinese), auto-enable on headphones, trackpad sound support. | | distantorigin | Menu bar accessibility and VoiceOver responsiveness. | | SouhailBlmn | Volume persistence across output devices, global shortcut to toggle the app. | | shailantani | Raycast extension (source code). | | qalonbudker | Pitch variation for key sounds. | | zenangst | Event handling, mode saving, performance improvements. | | iamsoum | Clearer step-by-step sound pack conversion instructions. | | cattybeo | Vietnamese translations. |

<p align="right">(<a href="#readme-top">back to top</a>)</p> <!-- MARKDOWN LINKS & IMAGES -->