KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #developer-tools #ai-agent #claude-code #codex #typescript #ai-agents #deepseek-harness #mcp #cli #rust

OverKeys

★ 235 Open GitHub ↗

An open-source keyboard layout visualizer for Windows. Learn and practice alternative layouts, personalize appearance, and improve your typing.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<br />
<div align="center">
  
  <img src="assets/images/OK.png" alt="OverKeys Logo" width="160" height="160">
  <h1 align="center">OverKeys</h1>
  
  
  <p align="center">
    <a href="https://github.com/conventoangelo/OverKeys/releases/latest">
      <img src="https://img.shields.io/github/v/release/conventoangelo/OverKeys?label=Release&style=for-the-badge&logo=github&logoColor=FAFBFE&labelColor=10151D&color=A87FFB" alt="Release (Inverted)">
    </a>
    <a href="https://github.com/conventoangelo/OverKeys/releases">
      <img src="https://img.shields.io/github/downloads/conventoangelo/OverKeys/total?label=Downloads&style=for-the-badge&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9IiNGQUZCRkUiIHN0cm9rZS13aWR0aD0iMiIgc3Ryb2tlLWxpbmVjYXA9InJvdW5kIiBzdHJva2UtbGluZWpvaW49InJvdW5kIiBjbGFzcz0ibHVjaWRlIGx1Y2lkZS1kb3dubG9hZC1pY29uIGx1Y2lkZS1kb3dubG9hZCI+PHBhdGggZD0iTTEyIDE1VjMiLz48cGF0aCBkPSJNMjEgMTV2NGEyIDIgMCAwIDEtMiAySDVhMiAyIDAgMCAxLTItMnYtNCIvPjxwYXRoIGQ9Im03IDEwIDUgNSA1LTUiLz48L3N2Zz4=&logoColor=FAFBFE&labelColor=10151D&color=A87FFB" alt="Downloads (Inverted)">
    </a>
    <a href="https://github.com/conventoangelo/OverKeys/blob/main/LICENSE">
      <img src="https://img.shields.io/github/license/conventoangelo/OverKeys?style=for-the-badge&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9IiNGQUZCRkUiIHN0cm9rZS13aWR0aD0iMiIgc3Ryb2tlLWxpbmVjYXA9InJvdW5kIiBzdHJva2UtbGluZWpvaW49InJvdW5kIiBjbGFzcz0ibHVjaWRlIGx1Y2lkZS1jb3B5cmlnaHQtaWNvbiBsdWNpZGUtY29weXJpZ2h0Ij48Y2lyY2xlIGN4PSIxMiIgY3k9IjEyIiByPSIxMCIvPjxwYXRoIGQ9Ik0xNC44MyAxNC44M2E0IDQgMCAxIDEgMC01LjY2Ii8+PC9zdmc+&logoColor=FAFBFE&labelColor=10151D&color=A87FFB" alt="License (Inverted)">
    </a>
    <a href="https://github.com/conventoangelo/OverKeys/stargazers">
      <img src="https://img.shields.io/github/stars/conventoangelo/OverKeys?style=for-the-badge&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSIjRkFGQkZFIiBzdHJva2U9IiNGQUZCRkUiIHN0cm9rZS13aWR0aD0iMiIgc3Ryb2tlLWxpbmVjYXA9InJvdW5kIiBzdHJva2UtbGluZWpvaW49InJvdW5kIiBjbGFzcz0ibHVjaWRlIGx1Y2lkZS1zdGFyLWljb24gbHVjaWRlLXN0YXIiPjxwYXRoIGQ9Ik0xMS41MjUgMi4yOTVhLjUzLjUzIDAgMCAxIC45NSAwbDIuMzEgNC42NzlhMi4xMjMgMi4xMjMgMCAwIDAgMS41OTUgMS4xNmw1LjE2Ni43NTZhLjUzLjUzIDAgMCAxIC4yOTQuOTA0bC0zLjczNiAzLjYzOGEyLjEyMyAyLjEyMyAwIDAgMC0uNjExIDEuODc4bC44ODIgNS4xNGEuNTMuNTMgMCAwIDEtLjc3MS41NmwtNC42MTgtMi40MjhhMi4xMjIgMi4xMjIgMCAwIDAtMS45NzMgMEw2LjM5NiAyMS4wMWEuNTMuNTMgMCAwIDEtLjc3LS41NmwuODgxLTUuMTM5YTIuMTIyIDIuMTIyIDAgMCAwLS42MTEtMS44NzlMMi4xNiA5Ljc5NWEuNTMuNTMgMCAwIDEgLjI5NC0uOTA2bDUuMTY1LS43NTVhMi4xMjIgMi4xMjIgMCAwIDAgMS41OTctMS4xNnoiLz48L3N2Zz4=&logoColor=FAFBFE&labelColor=10151D&color=A87FFB" alt="GitHub stars (Inverted)">
    </a>
  </p>

<h3 align="center">An open-source keyboard layout visualizer for Windows</h3>

<p align="center">
    <a href="#getting-started">Install Now</a>
    ·
    <a href="https://github.com/conventoangelo/OverKeys/issues/new?template=bug_report.md">Report Bug</a>
    ·
    <a href="https://github.com/conventoangelo/OverKeys/issues/new?template=feature_request.md">Request a Feature</a>
    ·
    <a href="https://github.com/conventoangelo/OverKeys/discussions/new?category=q-a">Ask a Question</a>
  </p>
</div>

<details>
  <summary>Table of Contents</summary>
  <ol>
    <li><a href="#about-the-project">About The Project</a></li>
    <li><a href="#features">Features</a></li>
    <li><a href="#getting-started">Getting Started</a></li>
    <li><a href="#documentation">Documentation</a></li>
    <li><a href="#contributing">Contributing</a></li>
    <li><a href="#building-from-source">Building from Source</a></li>
    <li><a href="#license">License</a></li>
    <li><a href="#contact">Contact</a></li>
    <li><a href="#acknowledgments">Acknowledgments</a></li>
  </ol>
</details>

## About The Project

![OverKeys Demo](https://github.com/conventoangelo/OverKeys/blob/main/assets/images/OverKeysDemo.gif)

<https://github.com/user-attachments/assets/c687a448-52b0-41bc-9b6b-07e61c2d3b31>

OverKeys is a free and open-source keyboard layout visualizer designed for users to practice alternative keyboard layouts, such as **Colemak**, **Dvorak**, **Graphite**, **Focal**, and many more. Learn and practice your layouts system-wide, personalize keyboard appearance, and improve your typing.

This project was initially developed to help with the creator's system-wide practice of the **Canary layout**, but has since evolved to support user-defined layouts, layer switching integration, and customization options.

### Samples

<table>
    <tr>
      <td colspan="2" style="text-align:center;">
        <img src="assets/images/overkeys_cover.png" alt="overkeys cover" style="max-width:100%;height:auto;">
        <p align="center">OverKeys Default</p>
      </td>
    </tr>
  <tr>
    <td>
      <img src="assets/images/aurora1.png" alt="aurora dark background">
      <p align="center">Aurora (On Dark Background)</p>
    </td>
    <td>
      <img src="assets/images/aurora2.png" alt="aurora light background">
      <p align="center">Aurora (On Light Background)</p>
    </td>
  </tr>
  <tr>
    <td>
      <img src="assets/images/eyco1.png" alt="custom dark background">
      <p align="center">Custom (On Dark Background)</p>
    </td>
    <td>
      <img src="assets/images/eyco2.png" alt="custom light background">
      <p align="center">Custom (On Light Background)</p>
    </td>
  </tr>
  <tr>
    <td>
      <img src="assets/images/catpuccin.png" alt="catpuccin">
      <p align="center">Catppuccin</p>
    </td>
    <td>
      <img src="assets/images/redsamurai.png" alt="split matrix">
      <p align="center">Red Samurai</p>
    </td>
    </tr>
    <tr>
    <td>
      <img src="assets/images/splitmatrix.png" alt="red samurai">
      <p align="center">Split Matrix Style</p>
    </td>
    <td>
      <img src="assets/images/matrix.png" alt="matrix">
      <p align="center">Matrix Style</p>
    </td>
  </tr>
</table>
<sub>Note: The themes are not provided by default and were instead manually configured. Colors were based on the MonkeyType themes of the same name.</sub>

## Features

- **Multi-layout support**: The following layouts are currently natively supported.
  <details>
  <summary>Layouts</summary>
    <ul>
      <li>QWERTY</li>
      <li>Colemak</li>
      <li>Dvorak</li>
      <li>Canaria</li>
      <li>Canary</li>
      <li>Canary Matrix</li>
      <li>Colemak DH</li>
      <li>Colemak DH Matrix</li>
      <li>Engram</li>
      <li>Focal</li>
      <li>Gallium (Col-Stag)</li>
      <li>Gallium V2 (Row-Stag)</li>
      <li>Graphite</li>
      <li>Halmak</li>
      <li>Hands Down</li>
      <li>NERPS</li>
      <li>Norman</li>
      <li>Sturdy</li>
      <li>Sturdy Angle (Staggered)</li>
      <li>Workman</li>
      <li>Greek</li>
      <li>Arabic</li>
      <li>Russian</li>
    </ul>
  </details>
- **Customizable styles**: Change colors, fonts, sizes, offsets, and key styles
- **Auto-hide**: The keyboard hides automatically when not in use
- **Keymap styles**: Supports staggered, matrix, and split matrix (5-col and [6-col](/docs/advanced/6-column-layouts.md)) styles
- **User configurations**: Add and use [custom keyboard layouts](/docs/advanced/custom-layouts.md) through configuration files
- **Key modifiers**: Add top labels and held-state keys to custom layouts with [key modifier objects](/docs/advanced/key-modifiers.md)
- **Side-by-side layouts**: Display [alternative layouts](/docs/advanced/alternative-layouts.md) alongside the default layout
- **Top row/Number row**: Optional row above the main keyboard for numbers or user-configured keys
- **[Layer switching](/docs/advanced/layer-switching.md)**: Switch between multiple custom keyboard layers for QMK, ZMK, or other programmable keyboard firmware using configurable triggers and toggle modes
- **[Layer switching (Kanata)](./docs/advanced/kanata-integration.md)**: Connect to [Kanata](https://github.com/jtroo/kanata) through TCP to dynamically display the active layer
- **[Ignored Keys](/docs/advanced/ignored-keys.md)**: Prevent specific keys from triggering the keyboard overlay (e.g., Print Screen, layer triggers)
- **[Learning Mode](/docs/user-guide/learning-mode.md)**: Color-code keys based on proper finger positions for touch typing
- **[Reactive Shift Mapping](/docs/advanced/shift-mappings.md)**: Display alternate key symbols when Shift key is pressed
- **[Locales](/docs/advanced/locales.md)**: Add locale-specific keys in user configuration for key press recognition

For complete feature details, see the [documentation](docs/index.md).

## Getting Started

### Installation

OverKeys can be installed through several methods:

1. **Using Winget (Recommended)**

```pwsh
   winget install AngeloConvento.OverKeys
   ```

<sub>Note: Please check if `winget` version is updated to the latest version as in the repo. Otherwise, use the [installer](https://github.com/conventoangelo/OverKeys/releases/latest) to have the latest version.</sub>

2. **Using the Installer**
   - Download and run the latest [EXE installer](https://github.com/conventoangelo/OverKeys/releases/latest).

3. **Portable Version**
   - Download and extract the [portable ZIP file](https://github.com/conventoangelo/OverKeys/releases/latest)

For detailed installation instructions, see the [Installation Guide](/docs/getting-started/installation.md).

## Documentation

Complete documentation for OverKeys is available in the [docs](docs/index.md) folder:

### Getting Started (Docs)

- [Installation Guide](/docs/getting-started/installation.md)
- [Basic Usage](/docs/getting-started/basic-usage.md)

### User Guide

- [Preferences](/docs/user-guide/preferences.md)
- [Text Settings](/docs/user-guide/text.md)
- [Learning Mode](/docs/user-guide/learning-mode.md)
- [Built-in Layouts](#features)

### Advanced Features

- [Custom Font](/docs/advanced/custom-font.md)
- [Custom Layouts](/docs/advanced/custom-layouts.md)
- [Key Modifiers](/docs/advanced/key-modifiers.md)
- [Alternative Layouts](/docs/advanced/alternative-layouts.md)
- [6-Column Layouts](/docs/advanced/6-column-layouts.md)
- [Layer Switching](/docs/advanced/layer-switching.md)
- [Kanata Integration](/docs/advanced/kanata-integration.md)
- [Shift Mappings](/docs/advanced/shift-mappings.md)
- [Supported Keys](/docs/advanced/supported-keys.md)
- [Locales](/docs/advanced/locales.md)

## Contributing

Contributions are what make the open-source community such an amazing place to learn and collaborate. Any contributions to **OverKeys** are greatly appreciated. If you have suggestions for improvements, bug fixes, or new features, please feel free to open an issue or submit a pull request. For detailed contribution guidelines, see the [CONTRIBUTING.md](.github/CONTRIBUTING.md) file.

## License

Distributed under the GPL-3.0 License. See [`LICENSE`](LICENSE) file for more information.

## Contact

### Angelo Convento

GitHub: [conventoangelo](https://github.com/conventoangelo)  
Email: <convento.angelo@gmail.com>

Project Link: [https://github.com/conventoangelo/OverKeys](https://github.com/conventoangelo/OverKeys)

## Supporting

If you'd like to support the development of OverKeys, I accept contributions through Ko-fi and BuyMeACoffee. Thank you — your support helps fund development and living costs.

## Acknowledgments

- [win32](https://win32.pub/) - Enable direct Win32 API access from Dart using FFI without requiring C code
- [leanflutter.dev](https://leanflutter.dev/our-packages/) - Provider of several essential Flutter desktop packages used in this project
- [desktop_multi_window](https://pub.dev/packages/desktop_multi_window) - Flutter plugin for creating and managing multiple windows in desktop applications
- [flex_color_picker](https://github.com/rydmike/flex_color_picker) - Highly customizable and versatile color picker for Flutter applications
- Alaine - for creating the beautiful OverKeys logo with love and care.

OverKeys

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README