# Thock | Documentation

Thock is a macOS app that plays mechanical keyboard and mouse sounds as you type.
This file is an official documentation for Thock. Thock is not distributed on the App Store and is not affiliated with any app that has taken this name. Thock will always be free and open source.

## Useful resources

- [GitHub Repository](https://github.com/kamillobinski/thock): Source code, issues, and releases for the Thock app
- [Soundpack Registry](https://github.com/kamillobinski/thock-soundpacks): Community soundpacks available for install through the in-app registry
- [Homebrew Cask Repository](https://github.com/kamillobinski/homebrew-thock): Homebrew tap used to install Thock via `brew install --cask`
- [Website](https://thockapp.com): Official website with documentation and download links
- [Author](https://github.com/kamillobinski): Kamil Lobinski, creator and maintainer of Thock

## Getting Started

- [Introduction](https://thockapp.com/docs/1.23.0/raw/getting-started/introduction.md): Welcome to the Thock documentation! This **Getting Started** section will help you start your thocky journey!
- [Installation](https://thockapp.com/docs/1.23.0/raw/getting-started/installation.md): Get Thock up and running on your Mac in a few steps.

## Features

- [Engine](https://thockapp.com/docs/1.23.0/raw/features/engine.md): Thock is built on a custom audio engine using native macOS AudioQueue APIs, delivering ultra-low latency that feels instantaneous.
- [Soundpack Registry](https://thockapp.com/docs/1.23.0/raw/features/soundpack-registry.md): Browse and install community soundpacks directly from Thock settings. No manual file downloads or folder management required.
- [Custom Soundpacks](https://thockapp.com/docs/1.23.0/raw/features/custom-soundpacks.md): Drop in your own audio files and a `config.json` and Thock will pick them up automatically.
- [Smart Integration](https://thockapp.com/docs/1.23.0/raw/features/smart-integration.md): Thock automatically mutes typing sounds when music is playing and resumes them as soon as it stops. Enable it once in settings and forget about it.
- [Advanced Control](https://thockapp.com/docs/1.23.0/raw/features/advanced-control.md): Thock goes beyond the menu bar with a dedicated CLI and a Raycast extension, giving power users full control from the command bar or terminal.
- [Keyboard Cleaning](https://thockapp.com/docs/1.23.0/raw/features/keyboard-cleaning.md): Block all keyboard input while you wipe down your keys, without triggering shortcuts or typing anything unwanted.
- [Translation](https://thockapp.com/docs/1.23.0/raw/features/translation.md): Thock is fully translated into multiple languages. Select your preferred language in the general settings.

## CLI

- [Introduction](https://thockapp.com/docs/1.23.0/raw/cli/introduction.md): `thock-cli` is a command-line interface for controlling Thock from your terminal, scripts, or automation tools like Raycast.
- [Installation](https://thockapp.com/docs/1.23.0/raw/cli/installation.md): Get `thock-cli` set up depending on how you installed Thock.
- [Command: set-enabled](https://thockapp.com/docs/1.23.0/raw/cli/command-set-enabled.md): Enables or disables Thock. Requires Thock to be running.
- [Command: set-soundpack](https://thockapp.com/docs/1.23.0/raw/cli/command-set-soundpack.md): Sets the active soundpack by name or UUID. Requires Thock to be running.
- [Command: ls](https://thockapp.com/docs/1.23.0/raw/cli/command-ls.md): Lists all installed soundpacks. Does not require Thock to be running.

## Additional

- [mechvibes2thock](https://thockapp.com/docs/1.23.0/raw/additional/mechvibes2thock.md): **`mechvibes2thock`** is a Python script that converts a MechVibes soundpack into a ready-to-use Thock soundpack. Download: [mechvibes2thock.py](https://github.com/kamillobinski/thock/blob/main/scripts/mechvibes2thock.py)

## Other

- [FAQ](https://thockapp.com/docs/1.23.0/raw/faq.md)
- [Contributing](https://thockapp.com/docs/1.23.0/raw/contributing.md): Thanks for your interest in contributing! Whether you're fixing a bug, improving the code, or just filing an issue, it all helps.