Skip to content

Commit 2c0ebd4

Browse files
committed
🔧 Restructure mouse input tutorials
1 parent d50d2b1 commit 2c0ebd4

11 files changed

Lines changed: 107 additions & 77 deletions

astro.config.mjs

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -76,16 +76,17 @@ export default defineConfig({
7676
label: 'Tutorials',
7777
items: [
7878
'autostart',
79+
'opening-menus',
7980
{
80-
label: 'Mouse Buttons & More',
81-
collapsed: false,
81+
label: 'App Guides',
82+
collapsed: true,
8283
items: [
83-
'opening-menus',
8484
'ahk-tutorial',
85-
'input-remapper-tutorial',
85+
'input-remapper-tutorial',
86+
'ke-tutorial',
8687
'bm-tutorial',
8788
'btt-tutorial',
88-
'ke-tutorial',
89+
'kanata-tutorial',
8990
],
9091
},
9192
'portable-mode',
-509 KB
Loading
-81.9 KB
Loading
-11.1 KB
Loading

src/content/docs/ahk-tutorial.mdx

Lines changed: 2 additions & 2 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: AutoHotKey
5+
title: AutoHotKey (Windows)
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 🚧
@@ -15,7 +15,7 @@ import Intro from '../../components/Intro.astro';
1515
![banner](../../assets/banners/banner12.png)
1616

1717
<Intro>
18-
On Windows, you can use a free tool called [AutoHotKey](https://www.autohotkey.com/) to open Kando menus with mouse buttons!
18+
[AutoHotKey](https://www.autohotkey.com/) is a powerful scripting language for Windows. You can use it to run the kando command when you press a mouse button or to remap a mouse button to a keyboard shortcut which opens a Kando menu.
1919
</Intro>
2020

2121
Until this page is finished, please check out these guides on how to use AutoHotKey to open Kando menus:

src/content/docs/bm-tutorial.mdx

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,26 +6,26 @@ title: BetterMouse (macOS)
66
description: A guide on how to use BetterMouse to open Kando menus with mouse buttons.
77
---
88

9-
import { Aside, Tabs, TabItem, LinkButton } from '@astrojs/starlight/components';
10-
import { Icon } from 'astro-icon/components';
9+
import { Steps } from '@astrojs/starlight/components';
1110
import Intro from '../../components/Intro.astro';
1211
import {Image} from 'astro:assets';
12+
1313
import bm_config from '../../assets/img/bm_config.png';
1414

1515
![banner](../../assets/banners/banner12.png)
1616

1717
<Intro>
18-
On macOS, you can use a tool called [BetterMouse](https://better-mouse.com/) to open Kando menus with mouse buttons!
18+
[BetterMouse](https://better-mouse.com/) is a macOS utility app that gives you smooth mouse scrolling, cursor speed control, and powerful mouse/keyboard bindings. You can use it to open a Kando menu via a mouse button.
1919
</Intro>
20-
## Overview
21-
Not every third-party tool supports all functionality, below you can find a short overview about BetterMouse:
22-
* Open Kando Menu ✅
23-
* Use Turbo Mode ❌
24-
25-
## BetterMouse tutorial
26-
* In BetterMouse navigate to the 'Buttons' section (1)
27-
* Create a Trigger with the mouse button you want to use (2)
28-
* Add the keyboard shortcut you want to send with this mouse button
29-
* The example sends the keyboard shortcut 'CTRL + F13' when pressing the mouse button 6
30-
* Adjust the example to your own needs (if necessary)
31-
<Image src={bm_config} alt="" class="shadow"/>
20+
21+
## Configuration
22+
23+
<Steps>
24+
1. In BetterMouse navigate to the 'Buttons' section.
25+
2. Create a Trigger with the mouse button you want to use.
26+
3. Add the keyboard shortcut you want to send with this mouse button.
27+
4. The example sends the keyboard shortcut <kbd>Ctrl</kbd>+<kbd>F13</kbd> when pressing the mouse button 6.
28+
5. Adjust the example to your own needs (if necessary).
29+
</Steps>
30+
31+
<Image src={bm_config} alt="" style="width: 50%;" class="shadow"/>

src/content/docs/btt-tutorial.mdx

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,35 +6,34 @@ title: BetterTouchTool (macOS)
66
description: A guide on how to use BetterTouchTool to open Kando menus with mouse buttons.
77
---
88

9-
import { Aside, Tabs, TabItem, LinkButton } from '@astrojs/starlight/components';
10-
import { Icon } from 'astro-icon/components';
9+
import { Steps, Aside } from '@astrojs/starlight/components';
1110
import Intro from '../../components/Intro.astro';
1211
import {Image} from 'astro:assets';
12+
1313
import btt_config from '../../assets/img/btt_configuration.png';
1414

1515
![banner](../../assets/banners/banner12.png)
1616

1717
<Intro>
18-
On macOS, you can use a tool called [BetterTouchTool](https://folivora.ai/) to open Kando menus with mouse buttons or trackpad gestures.
18+
[BetterTouchTool](https://folivora.ai/) is a great, feature packed app that allows you to customize various input devices on your Mac. You can use it to open a Kando menu via touchpad gestures or a mouse button.
1919
</Intro>
2020

21-
## Overview
22-
Not every third-party tool supports all functionality, below you can find a short overview about BetterTouchTool:
23-
* Open Kando Menu ✅
24-
* Use Turbo Mode ✅
25-
26-
## Karabiner-Elements tutorial
27-
* In BetterTouchTool navigate to the 'Normal Mouse' section (1)
28-
* Create a Trigger with the mouse button you want to use (in the example it's mouse button 7)
29-
* Under 'Actions Executed On Press' (2) create a action that 'Send Key Down Only' (3)
30-
* Under 'Actions Executed On Click RELEASE' create a action that 'Send Key Up Only'
31-
* Or Copy & Paste the example code below, to send the keyboard shortcut 'CTRL + F13' when pressing the mouse button 7
32-
* Adjust the example code to your own needs (if necessary)
21+
## GUI Configuration
3322

23+
<Steps>
24+
1. In BetterTouchTool navigate to the 'Normal Mouse' section. There, create a Trigger with the mouse button you want to use (in the example it's mouse button 7).
25+
2. Create an action under 'Actions Executed On Press'.
26+
3. Select 'Send Key Down Only'.
27+
4. Similarily, under 'Actions Executed On Click RELEASE' create a action that 'Send Key Up Only'.
28+
</Steps>
3429

3530
<Image src={btt_config} alt="" class="shadow"/>
3631

37-
```
32+
## JSON Configuration
33+
34+
Alternatively, you can also Copy & Paste the example code below, to send the keyboard shortcut 'CTRL + F13' when pressing the mouse button 7
35+
36+
```json
3837
[
3938
{
4039
"BTTLastUpdatedAt" : 1772350987.4586649,
@@ -74,4 +73,7 @@ Not every third-party tool supports all functionality, below you can find a shor
7473
}
7574
]
7675
```
76+
77+
<Aside type="note">
7778
For additional information, follow the [BetterTouchTool community discussion about how to trigger Kando](https://community.folivora.ai/t/hold-keyboard-shortcut-while-mousebutton-is-pressed/46351/2)
79+
</Aside>

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

Lines changed: 2 additions & 2 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
5+
title: Input Remapper (Linux)
66
description: A guide on how to use Input Remapper to open Kando menus with mouse buttons.
77
---
88

@@ -13,7 +13,7 @@ import Intro from '../../components/Intro.astro';
1313
![banner](../../assets/banners/banner12.png)
1414

1515
<Intro>
16-
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!
16+
[Input Remapper](https://github.com/sezanzeb/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.
1717
</Intro>
1818

1919
<Aside type="note">
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
# SPDX-FileCopyrightText: Simon Schneegans <code@simonschneegans.de>
3+
# SPDX-License-Identifier: CC-BY-4.0
4+
5+
title: Kanata
6+
description: A guide on how to use Kanata to open Kando menus with complex key chords.
7+
banner:
8+
content: 🚧 This page is currently under construction 🚧
9+
---
10+
11+
import { Aside, Tabs, TabItem, LinkButton } from '@astrojs/starlight/components';
12+
import { Icon } from 'astro-icon/components';
13+
import Intro from '../../components/Intro.astro';
14+
15+
![banner](../../assets/banners/banner12.png)
16+
17+
<Intro>
18+
[Kanata](https://github.com/jtroo/kanata) is a powerful tool for creating complex key chords on Windows, Linux, and macOS. You can use it to open Kando menus with intricate key combinations.
19+
</Intro>
20+
21+
Until this page is finished, please check out this guide on how to use Kanata to open Kando menus:
22+
* [Using Kanata to open pie menu](https://github.com/orgs/kando-menu/discussions/1309)

src/content/docs/ke-tutorial.mdx

Lines changed: 15 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -6,39 +6,35 @@ title: Karabiner-Elements (macOS)
66
description: A guide on how to use Karabiner-Elements to open Kando menus with mouse buttons.
77
---
88

9-
import { Aside, Tabs, TabItem, LinkButton } from '@astrojs/starlight/components';
10-
import { Icon } from 'astro-icon/components';
9+
import { Steps } from '@astrojs/starlight/components';
1110
import Intro from '../../components/Intro.astro';
1211
import {Image} from 'astro:assets';
12+
1313
import karabiner_elements_add_rule from '../../assets/img/karabiner_elements_add_rule.png';
1414
import karabiner_elements_devices from '../../assets/img/karabiner_elements_devices.png';
1515

1616
![banner](../../assets/banners/banner12.png)
1717

1818
<Intro>
19-
On macOS, you can use a free tool called [Karabiner-Elements](https://karabiner-elements.pqrs.org/) to open Kando menus with mouse buttons!
19+
[Karabiner-Elements](https://karabiner-elements.pqrs.org/) is a powerful and stable keyboard customizer for macOS that also can be used to send keyboard shortcuts with your mouse.
2020
</Intro>
2121

22-
## Overview
23-
Not every third-party tool supports all functionality, below you can find a short overview about Karabiner-Elements:
24-
* Open Kando Menu ✅
25-
* Use Turbo Mode ✅
26-
27-
## Karabiner-Elements tutorial
28-
* In Karabiner-Elements you need to navigate on the left sidebar to 'Devices' (1) activate 'Modify events' (2) for the mouse that you want to use
29-
<Image src={karabiner_elements_devices} alt="Activate 'Modify events' under 'Devices'" class="shadow"/>
30-
31-
* To setup a keyboard shortcut with your mouse, you need to create a 'Complex Modification' in Karabiner-Elements.
32-
* On the left sidebar of Karabiner-Elements click on 'Complex Modifications' (1) and then on 'Add your own rule' (2)
33-
<Image src={karabiner_elements_add_rule} alt="'Add your own rule' under 'Complex Modifications'" class="shadow"/>
34-
22+
## GUI Configuration
3523

36-
* Copy & Paste the example code below, to send the keyboard shortcut 'CTRL + F13' when pressing the middle mouse button
37-
* Adjust the example code to your own needs (if necessary)
24+
<Steps>
25+
1. In Karabiner-Elements you need to navigate on the left sidebar to 'Devices'.
26+
2. Activate 'Modify events' for the mouse that you want to use. <br /><br />
27+
<Image src={karabiner_elements_devices} alt="Activate 'Modify events' under 'Devices'" class="shadow"/>
28+
3. To setup a keyboard shortcut with your mouse, you need to create a 'Complex Modification' in Karabiner-Elements.
29+
4. Setup the shortcut by clicking on 'Add your own rule'. <br /><br />
30+
<Image src={karabiner_elements_add_rule} alt="'Add your own rule' under 'Complex Modifications'" class="shadow"/>
31+
</Steps>
3832

33+
## JSON Configuration
3934

35+
Alternatively, copy & paste the example code below to send the keyboard shortcut 'CTRL + F13' when pressing the middle mouse button:
4036

41-
```
37+
```json
4238
{
4339
"description": "Middle Mouse Button sends CTRL + F13",
4440
"manipulators": [

0 commit comments

Comments
 (0)