Repository files navigation

Features •Installation •Configuration •Troubleshooting •Disclaimer

KMonad is an advanced tool that lets you infinitely customize and extend the functionalities of almost any keyboard. For a detailed list of features, seehere.

If you want to get started with the latest, stable binary release, please check out the master branch, if you are interested in the latest additions and tweaks, switch on over to develop and compile your own binary.

Additionally, if you need any help or just want to say hi,you can join ourMatrix space orjump into ourIRC channel.There is also aKMonad Subreddit.

KMonad offers advanced customization features such aslayers,multi-tap,tap-hold, and much more. These features are usually available at the hardware level on the QMK-firmware enabled keyboards. However, KMonad allows you to enjoy such features in virtually any keyboard by low-level system manipulations.

For a good introduction to KMonad, have a look atthis YouTube video.

KMonad lets you map any keyboard button to any keymap. Want to swap the uselessCaps Lock key with theEscape key? Want to have your modifiers such asShift andControl on your home row, without breaking your normal typing flow? Want a modifier that is combination ofAlt + Ctrl + Super + Shift? You can do all of those and much more!

A layer is a set of keymaps assigned to your keyboard's buttons. You can have as many layers on top of your base layer as you want. For instance, you can have your regular QWERTY layout, a Colemak/Dvorak layout, a numbers and symbols layer, a function keys layer, a layer for mouse navigation and system controls --- all in a 60% keyboard. When a particular layer is active, any keypress is interpreted according to the layout defined in that layer. With proper configurations, you can jump to a specific layer or switch to one for the next keypress, or do various other complex manipulations.

Multi-Use Buttons are one of the distinguishing features of KMonad. You can have a single button do different things based on whether it is pressed quickly in succession, or pressed once, or held. For example, you can configure theCaps Lock key to act as anEscape button when pressed once and released, aCtrl modifier when held-down, and a button to jump to a layer when pressed twice quickly in succession. You can make the left and rightShift keys to act like left and right parentheses (like the Space Cadet Shift keys) when tapped once, and regularShift keys when held down. The possibilities are infinite!

With Command Buttons you can trigger shell commands with a tap of any button.

There are many more exciting features of KMonad that you can find in theconfiguration tutorial.

For more information on how to install KMonad, please refer to:

• installation

For information on how to configure KMonad, please refer you to:

• the configuration tutorial
• quick reference
• user configurations

Want to add your own keyboard configuration tokmonad-contrib? Justfork the repository, create a new subdirectory using your GitHubusername and submit a pull request!

• Emacs
• Vim
• VSCode

• There are startup scripts available for different init systems instartup/.
• AGNOME Shell extensionis available.

For several commonly asked questions regarding various configuration issues, please see:

• the FAQ

The core maintainer is currently chronically ill with debilitating autoimmunesymptoms. They come and go, but when they are there they very much get in theway of concentrated work. It is very much his intent to keep working on KMonaduntil it is very, very good. But please be aware that he might be gone for weekson end, not out of a lack of interest, but out of a lack of capacity. You arealways free to reach out to him by email.