|
1 | 1 | --- |
2 | 2 | title: Hot Keys |
3 | | -description: Execute your actions with keyboard shortcuts |
| 3 | +description: Execute your actions with keyboard shortcuts or mouse inputs |
4 | 4 | --- |
5 | 5 |
|
6 | | -## Overview |
7 | | -The Hot Keys tab allows you to configure global keyboard shortcuts to trigger specific [actions](/guide/actions). |
8 | | - |
9 | | -::tip{color=amber} |
10 | | -If you instead wish to simulate keystrokes from Streamer.bot, check out the [Keyboard Press](/api/sub-actions/core/system/keyboard-press) sub-action. |
| 6 | +::note |
| 7 | +**Updated in Streamer.bot v1.0.0** |
| 8 | +<br> |
| 9 | +Hot Keys are now configured as trigger inputs and support any key combination or mouse input. |
11 | 10 | :: |
12 | 11 |
|
13 | | - |
14 | | - |
15 | | -To create your first hot key, <kbd>Right-Click</kbd> in the hot key pane and select `Add` to open the configuration dialog |
16 | | - |
17 | | -## Configuration |
18 | | - |
19 | | -::field-group |
20 | | - ::field{name=Key type=Select required} |
21 | | - Select the key |
22 | | - :: |
23 | | - |
24 | | - ::field{name=Modifiers type=Toggle required} |
25 | | - Assign one or more modifiers to your selected hot key |
26 | | - |
27 | | - ::tip{color=amber} |
28 | | - Left and right versions of keys, such as <kbd>LShift</kbd> and <kbd>RShift</kbd>, are **always treated the same** |
29 | | - :: |
30 | | - :: |
31 | | - |
32 | | - ::field{name=Group type=Text} |
33 | | - Optionally type or select a group for this hot key |
34 | | - :: |
35 | | - |
36 | | - ::field{name=Enabled type=Toggle} |
37 | | - Toggle this hot key on or off |
38 | | - |
39 | | - ::callout{icon=i-mdi-alert color=amber} |
40 | | - Once a `Hot Key` has been defined, even when disabled, it will make the selected key combination **unavailable to all other applications** while Streamer.bot is running. |
41 | | - :: |
42 | | - :: |
43 | | -:: |
44 | | - |
45 | | -## Context Menu |
46 | | - |
47 | | -<kbd>Right-Click</kbd> any existing hot key to reveal the context menu. |
48 | | - |
49 | | -Options are outlined below: |
| 12 | +## Inputs |
50 | 13 |
|
51 | | -#### `Add` |
52 | | -Create a new hot key |
| 14 | +If you wish to execute your actions with keyboard shortcuts or mouse inputs, you can use the following trigger inputs: |
53 | 15 |
|
54 | | -#### `Edit` |
55 | | -Open the hot key configuration dialog |
| 16 | +### Keyboard Press |
| 17 | +:read-more{to=/api/triggers/core/inputs/key-press} |
56 | 18 |
|
57 | | -This is the same as <kbd>Double-Clicking</kbd> the entry |
| 19 | +### Mouse Click |
| 20 | +:read-more{to=/api/triggers/core/inputs/mouse-click} |
58 | 21 |
|
59 | | -#### `Delete` |
60 | | -Delete the selected hot key and free up the configured key combination for other applications |
61 | 22 |
|
62 | | -#### `Group` |
63 | | -Quickly assign the hot key to another group |
| 23 | +## Outputs |
64 | 24 |
|
65 | | -#### `Enabled` |
66 | | -Quickly toggle the selected hot key on or off |
| 25 | +You can also simulate keyboard inputs *from* Streamer.bot using the [Keyboard Press](/api/sub-actions/core/system/keyboard-press) sub-action. |
67 | 26 |
|
68 | | -## Assign an Action |
69 | | -You can assign any configured hot keys to your actions using the [Hot Key Press Trigger](/api/triggers/core/hot-keys/hotkey-press) |
| 27 | +This can be useful if you wish to trigger hotkeys or keyboard shortcuts in other applications. |
70 | 28 |
|
71 | | -## Usage |
72 | | -:api-reference-cards{path=core/hot-keys} |
| 29 | +:read-more{to=/api/sub-actions/core/system/keyboard-press} |
0 commit comments