Let the keys awaken a comfortable sound.

[English](README.md) · [简体中文](README.zh-CN.md)

# KeyTone ## Introduction KeyTone is a practical software that can simulate the sound of keystrokes in real-time in environments where silence is required, thereby enhancing your comfort when using a computer. Although there are already many similar software on the market, KeyTone is still committed to providing users with the best experience. KeyTone's **core is implemented in high-performance Go**, which lays a solid foundation for the application's performance and allows for greater optimization potential. In addition, KeyTone is an open-source software that follows the GPL license. ## Features * Support for mouse and keyboard key sound effects triggering. > Designed based on the actual triggering of keys, sound effects are only emitted at the moment of pressing and releasing, and holding the key will not repeat the sound effect. * Highly customizable, users can quickly customize the key sound effect bindings according to their own needs. > This software focuses on key sound albums and has developed a series of rich and convenient functions. In addition, this project provides rich [documentation support](https://keytone.xuanhall.com/guide/getting-started/quick-start/) to help users better understand and use it. ## Highlights Unleash your creativity with keystroke sounds to craft a unique and personalized auditory experience. KeyTone does not provide any audio files—this is by design! > We encourage you to tap into your creativity by uploading your own or collected audio to create your personalized keystroke sound collection. With KeyTone, you can: * Combine multiple sounds into a single ***advanced sound*** and bind it to a single key, setting these sounds to play randomly or in sequence each time the key is pressed (playing one sound at a time). * Allow these ***advanced sounds*** to be combined, inherited, and nested with each other, helping you create rich, varied sound effects and unlocking endless possibilities for keystroke sounds. * **Participate in the production and sharing of Keytone albums. The main sharing community is the [Keytone community on itch](https://lusrackhall.itch.io/keytone/community). Welcome to contribute topics or join discussions on existing topics!** * Audio source files, which are the prerequisite for everything, are not provided in this project and will not be provided in the future.

You can obtain audio source files through self-recording, searching open-source communities, free audio resource sharing websites, AI generation, etc.
> > `Generally, you are free to use these audio resources locally; however, if you need to share them further, please be sure to review their specific license agreements.` > > * [Nigh/OpenKeySound](https://github.com/Nigh/OpenKeySound) — This repository, provided by [Nigh](https://github.com/Nigh), contains **self-recorded** and edited mechanical keyboard switch sounds, along with related usage instructions. > * [Pixabay](https://pixabay.com/sound-effects/search/keyboard/), [Freesound](https://freesound.org/search/?q=keyboard), and other websites claiming to share free audio resources. (*Note: Third-party website resources have not been verified for content, please validate them yourself.*) > * **With the rapid development and continuous advancement of artificial intelligence, it may be possible in the future to use AI audio generation technology to create customized keyboard sound effects through prompts; or even inform it of the KeyTone sound album format to generate key sound albums directly importable for use.**

KeyTone offers you a stage for free creation, turning every keystroke into a unique piece of sound art. ## Installation You can obtain **KeyTone** through the following methods: 1. **GitHub Releases** As an open-source project, you can download the latest version for free from our [GitHub Releases](https://github.com/LuSrackhall/KeyTone/releases) page. 2. **Official Website** You can also visit our [official website](https://keytone.xuanhall.com) to get the latest version and installation instructions for free. 3. **itch.io** Download via the itch website, [click here to enter the release page](https://lusrackhall.itch.io/keytone). 4. **App Stores** Get the latest version of KeyTone through official app stores on various platforms. * Windows —— Get from [Microsoft Store](https://apps.microsoft.com/store/detail/9NGKDXHPGJXD?cid=DevShareMCLPCS)

* MacOS —— No plans to list yet The advantage of downloading through app stores is that you can get automatic update support for the listed software. In addition, the built-in sandbox mechanism of app stores and the strict application review management mechanism can provide users with further security guarantees. **KeyTone software is open-source and free,** but we also welcome everyone to purchase through app stores.

Like most open-source products, KeyTone cannot develop on its own. Therefore, purchasing or other forms of sponsorship can provide financial support to developers, which is beneficial for the continuous maintenance and iteration of the project.

## System Requirements * Windows 10 or higher. macOS 11 or higher. * Audio output device. ## Stargazers over time [![Stargazers over time](https://starchart.cc/LuSrackhall/KeyTone.svg?variant=adaptive)](https://starchart.cc/LuSrackhall/KeyTone) ## Development Environment & Local Debugging The project requires the following development environment: * Go 1.24.5 * Node.js 20.x * Quasar CLI ### Setup Steps on Windows 1. Install [Go 1.24.5](https://go.dev/dl/) and configure your environment variables. 2. Install [Node.js 18.x](https://nodejs.org/en/download/). 3. Install Quasar CLI globally: ```shell npm install -g @quasar/cli ``` 4. Install frontend dependencies: ```shell cd frontend npm install ``` 5. Start the development environment (Electron desktop): ```shell quasar dev -m electron ``` For details about build differences and encrypted output compatibility, see [BUILD_COMPATIBILITY.md](./BUILD_COMPATIBILITY.md). ## Roadmap At this stage, our hybrid architecture selects Electron as the client framework due to its ability to quickly and reliably implement complex cross-platform functionalities. Although Electron applications are larger in size, this does **not pose a long-term bottleneck for the KeyTone project architecture**. From the project’s outset, our technical roadmap has included the evaluation and integration of lighter Go desktop frameworks, such as Wails. Wails achieves a smaller size by using the system’s native WebView instead of bundling an entire browser engine like Electron. [We will adopt Wails 3 upon its release](https://github.com/LuSrackhall/KeyTone/issues/69), fully addressing the size issue. The project's roadmap can be found [here](https://github.com/LuSrackhall/KeyTone/milestones). Please check it before creating enhancement requests. 😊 ## Issues Welcome any ideas! ## Contributions Welcome contributions in any form! ## License This project follows the [GPL License](https://github.com/LuSrackhall/KeyTone/blob/main/LICENSE). ## Copyright Copyright (C) 2024-present LuSrackhall