Skip to content

Commit d50d2b1

Browse files
Volker1984Schneegans
Volker1984
authored and
Schneegans
committed
📝 Add three new tutorials for macOS
1 parent df1f447 commit d50d2b1

9 files changed

Lines changed: 174 additions & 1 deletion

‎astro.config.mjs‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,10 @@ export default defineConfig({
8282
items: [
8383
'opening-menus',
8484
'ahk-tutorial',
85-
'input-remapper-tutorial',
85+
'input-remapper-tutorial',
86+
'bm-tutorial',
87+
'btt-tutorial',
88+
'ke-tutorial',
8689
],
8790
},
8891
'portable-mode',

‎src/assets/img/bm_config.png‎

290 KB
Loading

‎src/assets/img/btt_configuration.png‎

1.13 MB
Loading

‎src/assets/img/karabiner_elements_add_rule.png‎

286 KB
Loading

‎src/assets/img/karabiner_elements_devices.png‎

398 KB
Loading

‎src/content/docs/bm-tutorial.mdx‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
# SPDX-FileCopyrightText: Simon Schneegans <code@simonschneegans.de>
3+
# SPDX-License-Identifier: CC-BY-4.0
4+
5+
title: BetterMouse (macOS)
6+
description: A guide on how to use BetterMouse to open Kando menus with mouse buttons.
7+
---
8+
9+
import { Aside, Tabs, TabItem, LinkButton } from '@astrojs/starlight/components';
10+
import { Icon } from 'astro-icon/components';
11+
import Intro from '../../components/Intro.astro';
12+
import {Image} from 'astro:assets';
13+
import bm_config from '../../assets/img/bm_config.png';
14+
15+
![banner](../../assets/banners/banner12.png)
16+
17+
<Intro>
18+
On macOS, you can use a tool called [BetterMouse](https://better-mouse.com/) to open Kando menus with mouse buttons!
19+
</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"/>

‎src/content/docs/btt-tutorial.mdx‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
---
2+
# SPDX-FileCopyrightText: Simon Schneegans <code@simonschneegans.de>
3+
# SPDX-License-Identifier: CC-BY-4.0
4+
5+
title: BetterTouchTool (macOS)
6+
description: A guide on how to use BetterTouchTool to open Kando menus with mouse buttons.
7+
---
8+
9+
import { Aside, Tabs, TabItem, LinkButton } from '@astrojs/starlight/components';
10+
import { Icon } from 'astro-icon/components';
11+
import Intro from '../../components/Intro.astro';
12+
import {Image} from 'astro:assets';
13+
import btt_config from '../../assets/img/btt_configuration.png';
14+
15+
![banner](../../assets/banners/banner12.png)
16+
17+
<Intro>
18+
On macOS, you can use a tool called [BetterTouchTool](https://folivora.ai/) to open Kando menus with mouse buttons or trackpad gestures.
19+
</Intro>
20+
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)
33+
34+
35+
<Image src={btt_config} alt="" class="shadow"/>
36+
37+
```
38+
[
39+
{
40+
"BTTLastUpdatedAt" : 1772350987.4586649,
41+
"BTTTriggerType" : 1007,
42+
"BTTTriggerTypeDescriptionReadOnly" : "Button 7",
43+
"BTTTriggerParentUUID" : "1345F060-135B-4341-B6F0-E7480914A160",
44+
"BTTTriggerClass" : "BTTTriggerTypeNormalMouse",
45+
"BTTUUID" : "95B2EC52-89A1-4B3D-A12F-783D55A1DF10",
46+
"BTTOrder" : 8,
47+
"BTTActionsToExecute" : [
48+
{
49+
"BTTLastUpdatedAt" : 1772351016.1467381,
50+
"BTTTriggerParentUUID" : "95B2EC52-89A1-4B3D-A12F-783D55A1DF10",
51+
"BTTIsPureAction" : true,
52+
"BTTTriggerClass" : "BTTTriggerTypeNormalMouse",
53+
"BTTUUID" : "0F38CC89-29A3-45F3-A993-E5C59B206009",
54+
"BTTLayoutIndependentActionChar" : "F13",
55+
"BTTGenericActionConfig2" : "onlyDown",
56+
"BTTShortcutToSend" : "59,105",
57+
"BTTShortcutUpDown" : "onlyDown",
58+
"BTTOrder" : 0
59+
},
60+
{
61+
"BTTActionCategory" : 31,
62+
"BTTLastUpdatedAt" : 1772351022.5314541,
63+
"BTTTriggerParentUUID" : "95B2EC52-89A1-4B3D-A12F-783D55A1DF10",
64+
"BTTIsPureAction" : true,
65+
"BTTTriggerClass" : "BTTTriggerTypeNormalMouse",
66+
"BTTUUID" : "97337D1F-B44B-4F00-B47F-35959C8723D8",
67+
"BTTLayoutIndependentActionChar" : "F13",
68+
"BTTGenericActionConfig2" : "onlyUp",
69+
"BTTShortcutToSend" : "59,105",
70+
"BTTShortcutUpDown" : "onlyUp",
71+
"BTTOrder" : 2
72+
}
73+
]
74+
}
75+
]
76+
```
77+
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)

‎src/content/docs/ke-tutorial.mdx‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
# SPDX-FileCopyrightText: Simon Schneegans <code@simonschneegans.de>
3+
# SPDX-License-Identifier: CC-BY-4.0
4+
5+
title: Karabiner-Elements (macOS)
6+
description: A guide on how to use Karabiner-Elements to open Kando menus with mouse buttons.
7+
---
8+
9+
import { Aside, Tabs, TabItem, LinkButton } from '@astrojs/starlight/components';
10+
import { Icon } from 'astro-icon/components';
11+
import Intro from '../../components/Intro.astro';
12+
import {Image} from 'astro:assets';
13+
import karabiner_elements_add_rule from '../../assets/img/karabiner_elements_add_rule.png';
14+
import karabiner_elements_devices from '../../assets/img/karabiner_elements_devices.png';
15+
16+
![banner](../../assets/banners/banner12.png)
17+
18+
<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!
20+
</Intro>
21+
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+
35+
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)
38+
39+
40+
41+
```
42+
{
43+
"description": "Middle Mouse Button sends CTRL + F13",
44+
"manipulators": [
45+
{
46+
"from": { "pointing_button": "button3" },
47+
"to": [
48+
{
49+
"key_code": "f13",
50+
"modifiers": ["control"]
51+
}
52+
],
53+
"type": "basic"
54+
}
55+
]
56+
}
57+
```

‎src/content/docs/opening-menus.mdx‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,11 @@ You can either open an issue, edit this file, or join the [Discord server](https
2626

2727
<LinkCard title="AutoHotkey (Windows only)" description='AHK 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.' href="/ahk-tutorial" />
2828
<LinkCard title="Input Remapper (Linux only)" description='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.' href="/input-remapper-tutorial" />
29+
<LinkCard title="BetterMouse (macOS only)" description='BetterMouse is a macOS utility app that gives you smooth mouse scrolling, cursor speed control, and powerful mouse/keyboard bindings. You can use it to
30+
open a Kando menu via a mouse button.' href="/bm-tutorial" />
31+
<LinkCard title="BetterTouchTool (macOS only)" description='BetterTouchTool is a great, feature packed app that allows you to customize various input devices on your Mac. You can use it to
32+
open a Kando menu via touchpad gestures or a mouse button.' href="/btt-tutorial" />
33+
<LinkCard title="Karabiner-Elements (macOS only)" description='Karabiner-Elements is a powerful and stable keyboard customizer for macOS that also can be used to send keyboard shortcuts with your mouse.' href="/ke-tutorial" />
2934

3035
## More Third-Party Tools
3136

0 commit comments

Comments
 (0)