An open API service indexing awesome lists of open source software.

https://github.com/kamillobinski/thock

THOCK your mac keyboard with over 25 built-in modes or your own soudpacks.
https://github.com/kamillobinski/thock

desktop keyboard keyboard-sounds macos sounds swift thock

Last synced: 2 months ago
JSON representation

THOCK your mac keyboard with over 25 built-in modes or your own soudpacks.

Awesome Lists containing this project

README

          




Logo

Thock



A macOS utility that adds sound effects to your keyboard.

Lightweight, native and runs in the menu bar.




Release Version


GitHub Downloads


Ask DeepWiki


Table of Contents



  1. About The Project



  2. Getting Started

  3. Usage

  4. License

  5. Contributing

  6. Acknowledgments

## About The Project

![banner](banner.png)

Thock is a native macOS utility that adds sound effects to your keyboard.

I built this project for fun, aiming to create a satisfying typing experience - like a mechanical keyboard, but entirely in software. Similar apps exist, but those written in other languages often lack proper macOS support or fall short in quality and functionality. There’s also Klack, a $5 paid alternative on the App Store, but I believe an open source community can do better lol.

Key features:
* Β ο£Ώ Native macOS application
* ⚑ Minimal CPU & memory usage
* πŸ“Ž Menu bar utility
* πŸ”Š Over 25 unique sound modes
* πŸ•ΉοΈ Adjustable volume slider
* πŸͺ„ [Raycast extension](https://www.raycast.com/shail_antani/thock)
* πŸ™‰ [Custom soundpacks](https://github.com/kamillobinski/thock/blob/main/docs/CUSTOM-SOUNDS.md)
* πŸ’… [Soundpack Converters](https://github.com/kamillobinski/thock/blob/main/docs/SOUNDPACK-CONVERTERS.md)
* βš™οΈ Settings (auto-mute, launch at login, etc)

(back to top)

### Built With

![Swift][Swift-url]

(back to top)

## Getting Started

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

> [!IMPORTANT]
> Thock requires macOS 13.5 Ventura or later.

### β†’ Option 1. Hombrew Installation (recommended)

1. Tap the repository
```sh
brew tap kamillobinski/thock
```

2. Install Thock
```sh
brew install thock
```

3. (Optional) Move it to your Applications folder
```sh
thock --install
```

### Option 2. Release Download

1. Go to the [latest release](https://github.com/kamillobinski/thock/releases/latest)
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

### Option 3. Build From Source

1. Clone the repository
```sh
git clone https://github.com/kamillobinski/thock.git
cd thock
```

2. Open in Xcode
```sh
open Thock.xcodeproj
```

3. Build and run the application

(back to top)

## Usage

![usage](usage.gif)

(back to top)

## License

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

(back to top)

## Contributing

Got an idea or want to improve something? Awesome!

Check out the [contributing guide](./docs/CONTRIBUTING.md) for everything you need to know.

(back to top)

## Acknowledgments

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

**Community Contribution**

- [@SouhailBlmn](https://github.com/SouhailBlmn) - Volume persistence across output devices, global shortcut to toggle the app
- [@shailantani](https://github.com/shailantani) - Raycast extension ([source code](https://github.com/raycast/extensions/tree/main/extensions/thock))
- [@qalonbudker](https://github.com/qalonbudker) - Pitch variation for key sounds
- [@zenangst](https://github.com/zenangst) - Event handling, mode saving, perf improvements
- [@iamsoum](https://github.com/iamsoum) - Updated the sound pack conversion instructions for improved clarity and step-by-step guidance

(back to top)

[Swift-url]: https://img.shields.io/badge/swift-%23FA7343.svg?style=for-the-badge&logo=swift&logoColor=white