winkled

The WINdows Keyboard Layout EDitor

Requirements

• Node >= 20

Usage

Clone this repo and change directory to it.

git clone https://github.com/tenkirin/winkled.git; cd winkled

Remapping

Note

Refer to the MDN docs or this file for the complete list of key names.

1. Create a configuration file named remappings.winkled.json containing key remapping rules in the format "FROM_KEY": "TO_KEY" under the root directory of the project.

   Example: Swap CapsLock key with ControlLeft key

   {
     "CapsLock": "ControlLeft",
     "ControlLeft": "CapsLock"
   }

2. Run npm scripts

   • To generate a batch (.bat) file, run

     npm run bat

   • To generete a Registration entries (.reg) file, run

     npm run reg

3. Execute the generated file remap.winkled.* in ./dist directory and reboot the computer.

Recover

To remove all remappings and recover to the system default:

1. Delete the configuration file remappings.winkled.json.

2. Run npm scripts as mentioned above.

3. Execute the generated file recover.winkled.* in ./dist directory and reboot the computer.

License

MIT License