Skip to content

Latest commit

 

History

History
238 lines (181 loc) · 7.96 KB

README.md

File metadata and controls

238 lines (181 loc) · 7.96 KB
Raw


OverKeys Logo

OverKeys

A customizable, open-source on-screen keyboard for alternative layouts!
Explore the docs »

Download Release · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Features
  3. Getting Started
  4. Contributing
  5. License
  6. Contact
  7. Acknowledgments

About The Project

OverKeys Demo

OverKeys is an open-source on-screen keyboard designed for users to practice alternative keyboard layouts, such as Canary, Colemak, Dvorak, and many more. Built in Flutter, it allows full customizability, making it perfect for users learning or working with non-traditional layouts.

This project was initially developed to help with system-wide practice of the Canary layout, but has since evolved to support multiple layouts and customization options.

Samples

aurora dark background

Aurora (On Dark Background)

 aurora light background

Aurora (On Light Background)
custom dark background

Custom (On Dark Background)

 custom light background

Custom (On Light Background)
catpuccin

Catppuccin

 split matrix

Red Samurai
red samurai

Split Matrix Style

 matrix

Matrix Style
Note: The themes are not provided by default and were instead manually configured. Colors were based on the MonkeyType themes of the same name.

(back to top)

Features

  • Multi-layout support: The following layouts are currently supported:
    • QWERTY
    • Colemak
    • Dvorak
    • Canaria
    • Canary
    • Canary Matrix
    • Colemak DH
    • Colemak DH Matrix
    • Engram
    • Gallium (Col-Stag)
    • Gallium V2 (Row-Stag)
    • Graphite
    • Halmak
    • Hands Down
    • NERPS
    • Norman
    • Sturdy
    • Sturdy Angle (Staggered)
    • Workman
  • Customizable styles: Change colors, fonts, sizes, offsets, and key styles to fit your preference.
  • Always on top: Keep the keyboard on top of all windows for constant access.
  • Auto-hide: The keyboard hides automatically when not in use.
  • Keymap layouts: Supports keymap layouts such as staggered, matrix, and split matrix.

(back to top)

Getting Started

Follow these instructions to set up OverKeys on your local machine.

Prerequisites

  • Windows OS

Installation

  1. Download the latest EXE installer.
  2. Run the installer and follow the on-screen instructions.
  3. Once installed, OverKeys will be available for use.

Configuration

To change the app settings, right-click the OverKeys icon in the system tray and select Preferences. A separate window will open, displaying the available settings.

Loading Your Own Layout

To load your own keyboard layout, follow these steps:

  1. Install Flutter:

  2. Install Git:

    • Download and install using the installer from the Git website.

    • Alternatively, if you have winget installed, you can use the following command in your terminal:

      winget install --id Git.Git -e --source winget

  3. Clone the Repository:

    • Open a terminal and navigate to the folder where you want to clone the repository using the cd command. For example:

      cd path/to/your/folder

    • With Git installed, use the following command in your terminal:

      git clone https://github.com/conventoangelo/OverKeys.git

  4. Build the Project Locally:

    • Open a terminal and navigate to the root directory of the project.

    • Run the following command to get the Flutter dependencies:

      flutter pub get

    • Run the app with the terminal open:

      flutter run

    • Alternatively, build the project by running:

      flutter build windows

    • Once the build is complete, you can find the executable file in ..\OverKeys\build\windows\x64\runner\Release.

(back to top)

Contributing

Contributions are what make the open-source community such an amazing place to learn and collaborate. Any contributions to OverKeys are greatly appreciated.

  1. Fork the Project.
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature).
  3. Commit your Changes (git commit -m 'Add some AmazingFeature').
  4. Push to the Branch (git push origin feature/AmazingFeature).
  5. Open a Pull Request.

(back to top)

License

Distributed under the GPL-3.0 License. See LICENSE file for more information.

(back to top)

Contact

Angelo Convento

GitHub: conventoangelo
Email: [email protected]

Project Link: https://github.com/conventoangelo/OverKeys

(back to top)

Acknowledgments

  • win32 - Access common Win32 APIs directly from Dart using FFI — no C required!
  • leanflutter.dev
    • window_manager - A plugin that allows Flutter desktop apps to resizing and repositioning the window.
    • tray_manager - A plugin that allows Flutter desktop apps to defines system tray.
    • launch_at_startup - A plugin that allows Flutter desktop apps to Auto launch on startup / login.
  • desktop_multi_window - A flutter plugin that create and manager multi window in desktop.
  • flex_color_picker - A highly customizable Flutter color picker.
  • Best-README-Template - An awesome README template to jumpstart your projects!
  • Alaine - for the OverKeys logo.

(back to top)