Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ililim/dual-key-remap
Remap any key to any other two keys on Windows 🔥. Remap CapsLock to both Ctrl and Escape! (It's like xcape for windows!)
https://github.com/ililim/dual-key-remap
Last synced: about 1 month ago
JSON representation
Remap any key to any other two keys on Windows 🔥. Remap CapsLock to both Ctrl and Escape! (It's like xcape for windows!)
- Host: GitHub
- URL: https://github.com/ililim/dual-key-remap
- Owner: ililim
- License: gpl-2.0
- Created: 2018-07-27T17:53:29.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-10-04T05:04:06.000Z (about 2 years ago)
- Last Synced: 2024-08-02T16:34:45.303Z (4 months ago)
- Language: C
- Homepage:
- Size: 104 KB
- Stars: 492
- Watchers: 15
- Forks: 37
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- my-awesome-github-stars - ililim/dual-key-remap - Remap any key to any other two keys on Windows 🔥. Remap CapsLock to both Ctrl and Escape! (It's like xcape for windows!) (C)
README
# Windows Dual Key Remap: Capslock to Ctrl/Escape
Remap any key to any other two keys on Windows. Most commonly used to remap CapsLock to Escape when pressed alone and Ctrl when pressed with other keys. Written in C to run at the lowest Windows API level for speed and reliability 🔥.
## Features
- Fast with minimal cpu footprint
- Does not swallow or leak inputs
- Handles edge cases (correct key timings!)
Other solutions can leak inputs, get stuck, or do not handle key timing edge cases. Dual Key Remap runs at the lowest Windows API level making it both fast and reliable with an absolutely tiny cpu footprint.
## Installation
1) Download and unzip the latest [release](https://github.com/ililim/dual-key-remap/releases).
2) Put both 'dual-key-remap.exe' and 'config.txt' in a permanent directory of your choice. (e.g. `C:\Program Files\dual-key-remap`).
3) Create a shortcut to 'dual-key-remap.exe' in your startup directory (e.g. `C:\Users\%USERNAME%\AppData\Roaming\Microsoft\Windows\Start Menu\Programs\Startup\dual-key-remap.lnk`).
4) Optionally edit config.txt (see below) and run 'dual-key-remap.exe'. 🥳 Your chosen keys are now remapped!
To uninstall, terminate the script from the task manager and remove the startup shortcut.
## Configuration
With the default configuration Dual Key Remap will remap CapsLock to Escape when pressed alone and Ctrl when pressed with other keys. To change this simply edit config.txt and adjust the key values. You can refer to keys by their names as described in the [wiki](https://github.com/ililim/dual-key-remap/wiki/Using-config.txt#key-names).
## Tips and Tricks
Below are a few optional advanced tips for configuring your system and using Dual Key Remap. They assume you are using it to rebind CapsLock to Ctrl/Escape, but if you are rebinding other keys they might still be helpful to you.
### Shortcuts that require Escape
Certain applications might require shortcuts such as Shift+Escape. These can still be launched with Dual Key Remap. To launch these, simply hold the modifier keys (e.g. Shift) **first** and then press the CapsLock key last. Dual Key Remap will send the Shift+Escape key combination as expected!
The reason this works is because Dual Key Remap decides which key to send depending on whether any other keys where pressed _after_ CapsLock was held down, so tapping CapsLock as the last part of a key sequence will always send Escape.
### Administrator access
If launched normally Dual Key Remap will not be able to rebind your key inputs while you're viewing escalated/administrator applications (e.g. Task Manager). To make your rebindings work in those contexts make sure to run Dual Key Remap as administrator. You can also create an [elevated shorcut](https://winaero.com/create-elevated-shortcut-to-skip-uac-prompt-in-windows-10/) for Dual Key Remap.
### Rebind keys during login / before Windows loads
Dual Key Remap won't rebind any keys until the application is running, which means that on the login screen (and until Windows has fully loaded) your keys aren't rebound yet. This is not a problem for most people, but if it bothers you there are some additional steps you could take to improve your experience.
By using an utility like [Sharp Keys](https://github.com/randyrants/sharpkeys) you can rebind keys in the windows registry. While this method only supports simple key-to-key rebinding, these rebindings persist in the Windows login screen. So if you want to use CapsLock as Ctrl/Escape you could do the following:
- Rebind CapsLock to Escape in Sharp Keys.
- Rebind Escape to Ctrl/Escape in Dual Key Remap.
- Your CapsLock key will work as Escape during login and early startup, and once Windows is fully loaded the dual key functionality will activate!
## Contributing
### Building dual-key-remap.exe
1. Prerequisite: You will need [Visual Studio's build tools installed](https://msdn.microsoft.com/en-us/library/bb384838.aspx).
2. Launch the "Command Prompt for VS" (or equivalent) so you can use the `cl` and `nmake` programs.
3. Use `nmake` to run the various commands from the [Makefile](./Makefile):
```
# Run the test suite
nmake tests
# Build dual-key-remap.exe
nmake dual-key-remap
```