OverKeys Documentation
January 1, 2026 ยท View on GitHub
Welcome to the OverKeys documentation! This guide will help you get started with OverKeys, a customizable, open-source on-screen keyboard visualizer for alternative layouts.
Getting Started
- Installation - Install and set up OverKeys on your Windows machine
- Basic Usage - Learn how to use OverKeys's core features
User Guide
- Preferences - Configure OverKeys to match your needs
- Learning Mode - Use the specialized color scheme for learning new layouts
- Supported Layouts - View the list of built-in keyboard layouts
Advanced Features
- Custom Font - Use a system-installed font not found in the dropdown
- Custom Layouts - Create and use your own keyboard layouts
- Alternative Layouts - Quickly switch between different layouts
- 6-Column Layouts - Set up OverKeys for a 6-column split matrix keyboard
- Layer Switching - Switch between multiple custom keyboard layers with custom triggers
- Ignored Keys - Prevent specific keys from triggering the keyboard overlay
- Kanata Integration - Connect OverKeys with Kanata for advanced functionality
- Custom Aliases - Define custom aliases for key combinations
- Shift Mappings - Customize shift-key behavior for specific characters
- Supported Keys - Complete list of keys you can use in custom layouts
- Locales - Add locale-specific keys in user configuration for key press recognition
Additional Resources
- Project README - Overview of the project
- Changelog - Release history and features
- GitHub Repository - Source code and issue tracking
Common Tasks
- Creating a custom layout
- Setting up alternative layout switching
- Finding key names for custom layouts
- Troubleshooting custom layouts
Support
If you encounter any issues or have questions, please visit the GitHub Discussions page or report a bug.