Skip to content

Commit cfcdfb9

Browse files
refactor: rename shortcut -> kbd
1 parent 6d92b03 commit cfcdfb9

File tree

9 files changed

+24
-24
lines changed

9 files changed

+24
-24
lines changed

streamerbot/1.get-started/installation/linux.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ Download `lutris/streamerbot.yaml` from GitHub
138138
All actions and commands are listed in the order they have been added.
139139

140140
### Viewer Context Menu
141-
The :shortcut{value="Right-Click"} context menu on users within the viewers tab may not render correctly. You need to move the mouse over the opening context menu to let it fully appear.
141+
The :kbd{value="Right-Click"} context menu on users within the viewers tab may not render correctly. You need to move the mouse over the opening context menu to let it fully appear.
142142

143143
::success
144144
This issue has been resolved in Wine 7 and later

streamerbot/1.get-started/installation/macos.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ You can remove the Streamer.bot installation by right clicking the `Bottle` name
9494
All actions and commands are listed in the order they have been added.
9595

9696
### Viewer Context Menu
97-
The :shortcut{value="Right-Click"} context menu on users within the viewers tab may not render correctly. You need to move the mouse over the opening context menu to let it fully appear.
97+
The :kbd{value="Right-Click"} context menu on users within the viewers tab may not render correctly. You need to move the mouse over the opening context menu to let it fully appear.
9898

9999
::success
100100
This issue has been resolved in Wine 7 and later

streamerbot/2.guide/07.MIDI.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Streamer.bot ships with full MIDI input & output support, allowing you to execut
1515
`MIDI In` and `MIDI Out` devices are stored separately, so be sure to navigate to the appropriate tab for the type of interactions you would like to make. You can also add the same device in both tabs.
1616
::
1717

18-
To add a new device, :shortcut{value="Right-Click"} anywhere in the device pane and select `Add`
18+
To add a new device, :kbd{value="Right-Click"} anywhere in the device pane and select `Add`
1919

2020
![Add Device Context Menu](assets/midi-add-device.png)f
2121

@@ -43,7 +43,7 @@ This will open the add device dialog:
4343
::
4444

4545
### Context Menu
46-
:shortcut{value="Right-Click"} any existing device to reveal the context menu options:
46+
:kbd{value="Right-Click"} any existing device to reveal the context menu options:
4747

4848
![Context Menu](assets/midi-context-menu.png)
4949

@@ -73,11 +73,11 @@ This will open the add device dialog:
7373
Once you have created a `MIDI In` device, you can select it to register your incoming event listeners in the bottom pane.
7474

7575
::warning
76-
Make sure the device is currently connected. You can manually :shortcut{value="Right-Click"} the device and select `Open`
76+
Make sure the device is currently connected. You can manually :kbd{value="Right-Click"} the device and select `Open`
7777
::
7878

7979

80-
With your device selected in the top pane, you can :shortcut{value="Right-Click"} on bottom pane and select `Add` to create a new event listener.
80+
With your device selected in the top pane, you can :kbd{value="Right-Click"} on bottom pane and select `Add` to create a new event listener.
8181

8282
![Add MIDI Event](assets/midi-add-event.png)
8383

streamerbot/2.guide/20.platforms/0.twitch.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ You can also `Add` or `Delete` rewards directly from Streamer.bot, with all chan
2525
In Streamer.bot, navigate to **Platforms > Twitch > Channel Point Rewards**
2626
::
2727

28-
To create a new Channel Point Reward, :shortcut{value="Right-Click"} anywhere in the rewards pane and select `Add`
28+
To create a new Channel Point Reward, :kbd{value="Right-Click"} anywhere in the rewards pane and select `Add`
2929

3030
![Add Channel Reward Dialog](assets/add-channel-reward.png)
3131

@@ -95,7 +95,7 @@ To create a new Channel Point Reward, :shortcut{value="Right-Click"} anywhere in
9595
::
9696

9797
### Context Menu
98-
:shortcut{value="Right-Click"} any existing device to reveal the context menu options:
98+
:kbd{value="Right-Click"} any existing device to reveal the context menu options:
9999

100100
::field-group
101101
::field{name=Add}

streamerbot/2.guide/22.integrations/crowd-control.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Integrate Streamer.bot with [Crowd Control](https://crowdcontrol.live){target=_b
1616
Navigate to **Overlay > Assets** in the Crowd Control application
1717
::
1818

19-
- Click the :shortcut{value=Copy} button next to your `Overlay URL`
19+
- Click the :kbd{value=Copy} button next to your `Overlay URL`
2020

2121
![image](https://github.com/Streamerbot/docs/assets/8848167/d7b2db23-313a-40fa-b883-180d204ee7ce)
2222

streamerbot/2.guide/23.extra-features/chat.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,10 @@ While on the combined chat view, you can toggle which chat(s) to send to:
3333
Keyboard shortcuts exist to easily direct your chat messages to/from different accounts:
3434
| Keybind | Action |
3535
|--------:| ------ |
36-
| :shortcut{value="Enter"} | Send to **selected** chat(s) |
37-
| :shortcut{value="Shift+Enter"} | Send to **all** chats |
38-
| :shortcut{value="Ctrl+Enter"} | Send to **selected** chat(s) with the **bot account** |
39-
| :shortcut{value="Ctrl+Shift+Enter"} | Send to **all** chats with the **bot account** |
36+
| :kbd{value="Enter"} | Send to **selected** chat(s) |
37+
| :kbd{value="Shift"} :kbd{value="Enter"} | Send to **all** chats |
38+
| :kbd{value="meta"} :kbd{value="Enter"} | Send to **selected** chat(s) with the **bot account** |
39+
| :kbd{value="meta"} :kbd{value="Shift"} :kbd{value="Enter"} | Send to **all** chats with the **bot account** |
4040

4141
### Command Menus
4242
Autocomplete menus exist for the following options:
@@ -49,7 +49,7 @@ Autocomplete menus exist for the following options:
4949

5050
#### Slash Commands
5151
::note
52-
You can open the slash command menu with :shortcut{value="/"}
52+
You can open the slash command menu with :kbd{value="/"}
5353
::
5454

5555
Slash commands contain a set of actions that are directly integrated with your Streamer.bot instance.
@@ -63,22 +63,22 @@ Some commands support **Multi-Platform** execution, such as `/title` which can s
6363

6464
#### Streamer.bot Commands
6565
::note
66-
You can open the command menu with the :shortcut{value="!"} prefix
66+
You can open the command menu with the :kbd{value="!"} prefix
6767
::
6868

6969
For commands to appear in the command menu they must be configured with:
7070
- Set `Location` to `Start`
7171
- Start with the `!` prefix
7272

73-
When selecting a command, :shortcut{value=Enter} will submit the command immediately to chat.
73+
When selecting a command, :kbd{value=Enter} will submit the command immediately to chat.
7474

75-
If you wish to add input for a command, use :shortcut{value=Tab} to select the command and continue typing.
75+
If you wish to add input for a command, use :kbd{value=Tab} to select the command and continue typing.
7676

7777
![Streamer.bot Commands Menu](assets/chat-commands.png){width="500" caption-alt}
7878

7979
#### Emote Autocomplete
8080
::note
81-
You can open the emote menu with :shortcut{value=":"}
81+
You can open the emote menu with :kbd{value=":"}
8282
::
8383

8484
Emote autocomplete can be triggered at any time and contains emotes from the following sources:
@@ -89,7 +89,7 @@ Emote autocomplete can be triggered at any time and contains emotes from the fol
8989
- FFZ (Twitch)
9090
- BTTV (Twitch & YouTube)
9191

92-
To select an emote and continue typing, you can use either :shortcut{value="Enter / Tab"}
92+
To select an emote and continue typing, you can use either :kbd{value="Enter"} or :kbd{value="Tab"}
9393

9494
![Emotes Menu](assets/chat-emotes.png){width="500" caption-alt}
9595

streamerbot/2.guide/23.extra-features/html-overlay.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ The HTML Overlay application is now running!
5050
You should also now see an accompanying icon your system tray.
5151

5252
::tip
53-
You can close HTML Overlay by :shortcut{value=Double-Clicking} the tray icon at any time.
53+
You can close HTML Overlay by :kbd{value=Double-Click} the tray icon at any time.
5454
::
5555

5656
### Configuration

streamerbot/3.api/1.sub-actions/core/system/run-a-program.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ parameters:
88
description: |
99
The command or executable to run
1010
11-
This can contain anything you can normally execute via the :shortcut{value=Win+R} Windows Run dialog or `cmd`
11+
This can contain anything you can normally execute via the :kbd{value=Win} :kbd{value="R"} Windows Run dialog or `cmd`
1212
1313
Examples:
1414
- Executables

streamerbot/4.examples/chat-message-timer.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,13 @@ In this example, we are going to create a simple timer to send a chat message ev
1616

1717
1. Create a new action
1818

19-
:shortcut{value=Right-Click} the Actions pane in Streamer.bot and select `Add` to create a new action.
19+
:kbd{value=Right-Click} the Actions pane in Streamer.bot and select `Add` to create a new action.
2020

2121
![Create Action Dialog](assets/timer-create-action.png)
2222

2323
2. Create a timer trigger
2424

25-
With your new action selected, :shortcut{value=Right-Click} in the Triggers pane and select `Core > Timed Actions` to add a timer trigger.
25+
With your new action selected, :kbd{value=Right-Click} in the Triggers pane and select `Core > Timed Actions` to add a timer trigger.
2626

2727
![Create Trigger Dialog](assets/timer-create-trigger.png)
2828

@@ -51,7 +51,7 @@ In this example, we are going to create a simple timer to send a chat message ev
5151
The [Send Message to Channel](/api/sub-actions/twitch/chat/send-message-to-channel) sub-action allows us to easily send text to our Twitch chat.
5252

5353
::navigate
54-
:shortcut{value=Right-Click} in the sub-actions pane and select **Twitch > Chat > Send Message to Channel**
54+
:kbd{value=Right-Click} in the sub-actions pane and select **Twitch > Chat > Send Message to Channel**
5555
::
5656

5757
You will then see the sub-action dialog:

0 commit comments

Comments
 (0)