Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sigoden committed Nov 24, 2024
1 parent 55f0046 commit 9d04aa1
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,35 @@ While not mandatory, running `window-switcher.exe` with administrator privileges
* **Running as Admin + Enabling Startup:** Launches `window-switcher.exe` with administrator privileges every time you start your computer.
* **Running without Admin + Enabling Startup:** Launches `window-switcher.exe` with regular user privileges at startup.

<details>
<summary>

## Hotkeys for non-English keyboard layouts

When using non-English keyboard layouts, standard keycodes might not match the expected keys, leading to functionality issues with hotkeys. To ensure your hotkeys work correctly, follow these guidelines:

</summary>

1. **Visit kbdlayout.info**: Go to [http://kbdlayout.info/shortcut](http://kbdlayout.info/shortcut) and select your keyboard layout and desired keys. This will provide an image and detailed mapping.

![kbdlayout](https://github.com/user-attachments/assets/311c452a-d725-4853-adfe-097f63caf21a)

2. **Keycode Mapping**: Use the keycodes provided to correctly map your hotkeys. Here are some standard keycodes:

https://github.com/sigoden/window-switcher/blob/55f00463318971fca79204fe7a4eb9592f659881/src/config.rs#L227-L324

3. **Customizing for Language-Specific Keyboards**:

- If your keyboard is in a language other than English, such as German, you may need to adjust the hotkeys. For example:
- Original hotkey: ``` alt+` ```
- Adjusted hotkey: `alt+|` or `alt+vk_oem_5`

4. **Test Your Hotkey Setup**: After configuring, test the hotkeys to ensure they perform the intended actions across different keyboard layouts.

By following these steps, you can adapt hotkeys for various non-English keyboard layouts, ensuring smooth functionality regardless of the language or region of your keyboard.

</details>

## License

Copyright (c) 2023-2024 window-switcher developers.
Expand Down

0 comments on commit 9d04aa1

Please sign in to comment.