PowerToys/src/modules/keyboardmanager
2020-05-21 11:06:50 +02:00
..
common Added check for Type key/shortcut open but not in focus (#3235) 2020-05-20 09:56:00 -07:00
dll adding readme (#3045) 2020-05-15 17:16:04 -07:00
ui [KBM] Fix compilation error 2020-05-21 11:06:50 +02:00
README.md Dev/saahmedm/fixlabel (#3366) 2020-05-20 14:52:10 -07:00

Keyboard Manager

The Keyboard Manager (KBM) is a keyboard remapper that allows a user to redefine keys on their keyboard (ex. swapping the letter A and D) as well as shortcuts (Ctrl+C to alt text+C). You can use these remappings as long as KBM is enabled and PowerToys is running in the background. Below is an example of using keys and shortcuts that were remapped:

alt text

1. Get Started  

1.1 General Settings

To create mappings with Keyboard Manager, you have the option of launching either the Remap Keyboard UI by clicking the Remap a Key button or Remap Shortcuts UI by clicking the Remap a shortcut button.

1.2 Remap Keys

To remap a key to another key, click the Remap a Key button to launch the Remap Keyboard UI. When first launched, you are met with no predefined mappings and must click the + button to add a new remap. From there, select the key whose output you want to change as the “Key” and then keys new output as the “Mapped To”. For example, if you want to press A and have B appear, Key A would be your “Key” and Key B would be your “Mapped To" key. If you want to swap keys, add another remapping with Key B as your "Key" and Key A as your "Mapped To".

alt text

1.3 Remap Shortcuts (Global-only)

Currently you are only able to remap global level shortcuts (they apply to your whole OS), but app-specific shortcuts are coming soon!

To change how you invoke a particular shortcut, click the Remap a shortcut button to launch the Remap Shortcuts UI. When first launched, you are met with no predefined mappings and must click the + button to add a new remap. The "Shortcut" is the shortcut you want to change and the "Mapped To" is the shortcut you want to change it to. Ex. If you want Ctrl+C to paste, Ctrl+C is the "Shortcut" and Ctrl+V is the "Mapped To". Here are a few rules to shortcuts as you get started:

  • Shortcuts must begin with a modifier key (Ctrl, Shift, Alt, alt text)
  • Shortcuts must end with an action key (all non-modifier keys)
  • Shortcuts cannot be longer than 3 keys

alt text

1.4 Keys that cannot be remapped:

  • alt text+L (Locking your computer) and Ctrl+Alt+ Del cannot be remapped as they are reserved by the Windows OS.
  • The Fn key itself cannot be remapped (in most cases) but the F1-24 can be mapped.

1.5 Selecting the keys: Drop down + Type Key / Type Shortcut feature

To select a key in the remap or shortcut UI, you can use either the Type Key button or the drop downs. Once you click the Type Key / Shortcut button a dialogue will pop up. From here, type the key/shortcut using your keyboard. Once youre satisfied with the output, hold Enter to continue. If youd like to leave the dialogue, hold the Esc button. For the drop downs, you can search with the key name and additional drop downs will appear as you progress. However, you can not use the type-key feature while on the drop down.

alt text

1.6 Orphaning Keys

Orphaning a key means that you mapped it to another key and no longer have anything mapped to it. (Ex. If I map A -> B, I no longer have a key on my keyboard that results in A) To fix this, create another remap with that key as the New Key. We have created a warning to ensure you don't do this by accident.

alt text

2. Frequently Asked Questions

  • Question: I remapped the wrong keys, and I want to stop it quickly. How can I do that?

    • You can simply disable KBM from the settings or you can close PowerToys. For the remappings to work PowerToys must be running in the background and KBM must be enabled.
  • Question: Can I use Keyboard Manager at my log-in screen?

    • No, Keyboard Manager is only available when PowerToys is running and doesnt work on any password screen, including Run As Admin.
  • Question: Do I have to turn off my computer for the remapping to take effect?

    • No, as of now, all you need to do is press apply.
  • Question: Can I remap a shortcut to a single key?

    • No, we hope to support this soon.
  • Question: Where are the Mac/Linux profiles?

    • This is the beta release; we will have these features in our V1
  • Question: Why cant I remap a shortcut for a specific app?

    • This is the beta release; we will have these features in our V1
  • Question: Will this work on video games?

    • It depends on how the game accesses your keys. Certain keyboard APIs do not work with Keyboard Manager.
  • Question: Does this work if I change my input language? How?

    • Yes it will. Right now if you remap A to B on English (US) keyboard and then the switch language to French, then typing A on the French keyboard (i.e. Q on the English US physical keyboard) would result in B, this is consistent with how Windows handles multilingual input.

3. Trouble shooting if remappings are not working:

  • Could be one of the following issues:

    • Run As Admin: Remappings will not work on an app / window if that window is running as an admin (elevated) and PowerToys itself is not running as admin. Try running PowerToys as an administrator.
    • Not Intercepting Keys: KBM intercepts keyboard hooks to remap your keys. Some apps that also do this can interfere with Keyboard Manager, to fix this go to the Settings and Disable then Re-Enable Keyboard manager.

4. Known Issues

For a list of all known issues/suggestions, check it out here.