Skip to content

Commit a5d3360

Browse files
committed
📝 Add some more input-remapper info
1 parent 8126275 commit a5d3360

2 files changed

Lines changed: 27 additions & 15 deletions

File tree

src/content/docs/ahk-tutorial.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# SPDX-FileCopyrightText: Simon Schneegans <code@simonschneegans.de>
33
# SPDX-License-Identifier: CC-BY-4.0
44

5-
title: AutoHotKey (Windows)
5+
title: AutoHotKey
66
description: A guide on how to use AutoHotKey to open Kando menus with mouse buttons.
77
banner:
88
content: 🚧 This page is currently under construction 🚧

src/content/docs/input-remapper-tutorial.mdx

Lines changed: 26 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# SPDX-FileCopyrightText: Simon Schneegans <code@simonschneegans.de>
33
# SPDX-License-Identifier: CC-BY-4.0
44

5-
title: Input Remapper (Linux)
5+
title: Input Remapper
66
description: A guide on how to use Input Remapper to open Kando menus with mouse buttons.
77
---
88

@@ -16,52 +16,64 @@ import Intro from '../../components/Intro.astro';
1616
On Linux, you can use a tool called [Input Remapper](https://github.com/sezanzeb/input-remapper) to remap mouse buttons or controller buttons to keyboard shortcuts and open Kando menus this way!
1717
</Intro>
1818

19-
![input-remapper](../../assets/img/input-remapper.png)
2019

2120
# Introduction
2221

23-
**Input Remapper** is a tool which allows you to remap mouse buttons to keyboard shortcuts. While you can use it directly to bind menus to mouse buttons via keyboard shortcuts, it also allows for more advanced setups like showing menus when pressing two mouse buttons at the same time.
22+
**Input Remapper** is a Linux-only tool which allows you to remap mouse or controller buttons to keyboard shortcuts.
23+
While you can use it directly to bind menus to mouse buttons via keyboard shortcuts, it also allows for more advanced setups like showing menus when pressing two mouse buttons at the same time.
24+
25+
Get Input Remapper from GitHub: https://github.com/sezanzeb/input-remapper
2426

25-
Input Remapper on GitHub: https://github.com/sezanzeb/input-remapper
27+
You can visit the repository to learn about installation and general usage.
28+
This guide here will focus specifically on how to work with Kando.
2629

27-
You can visit the repository to learn about installation and general usage. This article will focus specifically on how to work with Kando.
30+
![input-remapper](../../assets/img/input-remapper.png)
31+
<center><sup>You can choose which button (on the left) should trigger which actions (on the right).</sup></center>
2832

2933
# Configuration
3034

31-
There are three ways to trigger a Kando menu through Input Remapper.
35+
In this guide, we will explore three ways to trigger a Kando menu through Input Remapper.
36+
First, we will look at the simplest method of directly mapping a mouse button to a keyboard shortcut.
37+
Then, we will explore how to trigger a menu with a long press of a mouse button while keeping the original function on tap.
38+
Finally, we will see how to trigger a menu by holding one mouse button and tapping another.
3239

3340
<Aside type="note" title="Note">
3441
To demonstrate the most complex scenarios, the examples below use `Ctrl+Shift+F1` as the trigger. You can modify this to your preferred shortcut.
3542
</Aside>
3643

3744
## Option 1: Direct Shortcut Mapping
3845

39-
This is the simplest method. Pressing a single mouse button triggers the Kando menu:
46+
This is the simplest method.
47+
Pressing a single mouse button triggers the Kando menu.
48+
In the Input pane on the left, add a new mapping and record the mouse button you want to use.
49+
In the output pane on the right, set the **type to "Key or Macro"** and the **target to "keyboard"** and type in the shortcut you want to use to trigger the Kando menu:
4050

4151
```yaml
42-
# Any Mouse Button
43-
# Target: keyboard
4452
KEY_LEFTCTRL + KEY_LEFTSHIFT + KEY_F1
4553
```
4654

55+
After applying the changes, pressing the mouse button will trigger the Kando menu assigned to `Ctrl+Shift+F1`.
56+
4757
- **Pros**: Fast response with zero latency; simple setup.
4858
- **Cons**: The button loses its original function, only suitable for mice with extra buttons.
4959

5060
## Option 2: Long Press Mouse Button
5161

52-
A long press triggers the Kando menu, while a short press (tap) retains the button's original function. The following example uses the **Right Mouse Button**:
62+
With the following configuration, a long press triggers the Kando menu, while a short press (tap) retains the button's original function.
63+
The following example uses the **Right Mouse Button**.
64+
65+
First, bind the right mouse button in the Input pane on the left.
66+
Then, in the output pane on the right, set the **type to "Key or Macro"** and the **target to "keyboard + mouse"** and use the following configuration:
5367

5468
```yaml
55-
# Mouse Button RIGHT
56-
# Target: keyboard + mouse
5769
if_tap( key( BTN_RIGHT ), modify( KEY_LEFTCTRL, modify( KEY_LEFTSHIFT, key (KEY_F1 ))).wait( 100 ).hold( KEY_LEFTCTRL ), 150 )
5870
```
5971

6072
<Aside type="tip" title="Tip">
61-
The number `150` at the end represents the duration required for a long press in milliseconds (ms). You can adjust this value, but setting it too short may lead to accidental triggers.
73+
The number `150` at the end represents the duration required for a long press in milliseconds. You can adjust this value, but setting it too short may lead to accidental triggers.
6274
</Aside>
6375

64-
- **Pros**: Preserves the button's original tap functionality.
76+
- **Pros**: Preserves the button's original tap functionality, you can directly engage in Marking Mode by holding the button without the need for an additional mouse click.
6577
- **Cons**: You lose the button's original hold function; holding and dragging will now interact with the Kando menu instead.
6678

6779
## Option 3: Combining Two Mouse Buttons

0 commit comments

Comments
 (0)