Skip to content

Commit 531461f

Browse files
docs: fix mdc rendering
1 parent 8eb5122 commit 531461f

File tree

1 file changed

+76
-67
lines changed

1 file changed

+76
-67
lines changed

streamerbot/2.guide/01.core/04.commands.md

Lines changed: 76 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -28,118 +28,127 @@ To create your first command, :kbd{value="Right-Click"} in commands pane and sel
2828
![Commands Configuration Dialog](assets/commands-edit.png)
2929

3030
::field-group
31-
::field{name=Name type=Text required}
32-
Enter a friendly name for this command
3331

34-
::warning
35-
This can be any label to recognize your command with. The actual text used for command execution will be defined in the `Commands` field.
36-
::
32+
:::field{name=Name type=Text required}
33+
Enter a friendly name for this command
3734

38-
::
35+
::::warning
36+
This can be any label to recognize your command with. The actual text used for command execution will be defined in the `Commands` field.
37+
::::
38+
:::
3939

40-
::field{name=Enabled type=Toggle default=true}
40+
:::field{name=Enabled type=Toggle default=true}
4141
Toggle this command on or off
42-
::
42+
:::
4343

44-
::field{name=Include type=Toggle default=true}
44+
:::field{name=Include type=Toggle default=true}
4545
Include this command in the [Get Commands](/api/sub-actions/core/commands/get-commands) sub-action
46-
::
46+
:::
4747

48-
::field{name=Mode type=Select required}
48+
:::field{name=Mode type=Select required}
4949
Select a text matching mode for this command:
5050

51-
- `Basic` - Match at least one of the strings entered, based on the configured `Location` option
52-
- `Regex` - Match based on Regular Expression
51+
- `Basic` - Match at least one of the strings entered, based on the configured `Location` option
52+
- `Regex` - Match based on Regular Expression
5353

54-
::
54+
:::
5555

56-
::field{name=Location type=Select}
56+
:::field{name=Location type=Select}
5757
Modify the text matching behavior when using the `Basic` mode:
5858

59-
- `Start` - Match chat messages that **begin with** at least one command alias
60-
- `Exact` - Match chat messages that are **exactly** the same text as at least one command alias
61-
- `Anywhere` - Match chat messages that **contain** at least one command alias
59+
- `Start` - Match chat messages that **begin with** at least one command alias
60+
- `Exact` - Match chat messages that are **exactly** the same text as at least one command alias
61+
- `Anywhere` - Match chat messages that **contain** at least one command alias
6262

63-
::
63+
:::
6464

65-
::field{name="Commands" type=Text required}
65+
:::field{name="Commands" type=Text required}
6666
Enter the text from chat used to execute this command
6767

68-
::tip
69-
You can enter multiple trigger strings or aliases by adding one item per line
70-
::
71-
::warning
72-
Command cooldowns are **shared across all configured aliases** within a command entity. You should create separate commands if you need exclusive cooldowns for each.
73-
::
68+
::::tip
69+
You can enter multiple trigger strings or aliases by adding one item per line
70+
::::
71+
::::warning
72+
Command cooldowns are **shared across all configured aliases** within a command entity. You should create separate commands if you need exclusive cooldowns for each.
73+
::::
7474

75-
::
75+
:::
7676

77-
::field{name=Group type=Text}
77+
:::field{name=Group type=Text}
7878
Optionally type or select a group for this command
79-
::
79+
:::
8080
::
8181

8282
### Options
8383

8484
::field-group
85-
::field{name="Ignore Bot Account" type=Toggle default=true}
85+
:::field{name="Ignore Bot Account" type=Toggle default=true}
8686
Ignore messages from the bot account, if it is configured for the respective chat [platform](/guide/platforms/twitch)
87-
::
88-
::field{name="Ignore Internal Messages" type=Toggle default=true}
87+
:::
88+
89+
:::field{name="Ignore Internal Messages" type=Toggle default=true}
8990
Ignore messages from the internal Streamer.bot chat loopback.
9091

91-
::tip
92-
Disabling this option is useful if you want to trigger commands internally, such as inside the **Streamer.bot Chat Window**
93-
::
92+
::::tip
93+
Disabling this option is useful if you want to trigger commands internally, such as inside the **Streamer.bot Chat Window**
94+
::::
9495

95-
::
96-
::field{name="Persist per User Counter" type=Toggle default=false}
96+
:::
97+
98+
:::field{name="Persist per User Counter" type=Toggle default=false}
9799
Persist the `User Counter` data for this command across restarts of Streamer.bot
98100

99-
::read-more{to=/api/triggers/core/commands/command-triggered}
100-
Refer to the `userCounter` variable returned by the **Command Triggered** trigger
101-
::
101+
::::read-more{to=/api/triggers/core/commands/command-triggered}
102+
Refer to the `userCounter` variable returned by the **Command Triggered** trigger
103+
::::
102104

103-
::
104-
::field{name="Persist Counter" type=Toggle default=false}
105+
:::
106+
107+
:::field{name="Persist Counter" type=Toggle default=false}
105108
Persist the `Counter` data for this command across restarts of Streamer.bot
106109

107-
::read-more{to=/api/triggers/core/commands/command-triggered}
108-
Refer to the `counter` variable returned by the **Command Triggered** trigger
109-
::
110+
::::read-more{to=/api/triggers/core/commands/command-triggered}
111+
Refer to the `counter` variable returned by the **Command Triggered** trigger
112+
::::
110113

111-
::
112-
::field{name="Case Sensitive" type=Toggle default=false}
114+
:::
115+
116+
:::field{name="Case Sensitive" type=Toggle default=false}
113117
Require command aliases to be matched using the exact casing specified
114-
::
115-
::field{name=Source(s) type=Toggle}
118+
:::
119+
120+
:::field{name=Source(s) type=Toggle}
116121
You can select any combination of chat sources to watch for execution of this command:
117122

118-
- `Twitch Message` - Accept commands from the chat of the configured [Twitch Broadcaster](/guide/platforms/twitch) account
119-
- `YouTube Message` - Accept commands from the chat of the configured [YouTube Broadcaster](/guide/platforms/youtube) account
120-
- `Twitch Whisper` - Accept commands from whispers sent to the configured [Twitch Broadcaster](/guide/platforms/twitch) account
121-
- `Twitch Subscription Message` - Accept commands included in the Twitch sub message
122-
- `Twitch Re-subscription Message` - Accept commands incldued in the Twitch re-sub message
123+
- `Twitch Message` - Accept commands from the chat of the configured [Twitch Broadcaster](/guide/platforms/twitch) account
124+
- `YouTube Message` - Accept commands from the chat of the configured [YouTube Broadcaster](/guide/platforms/youtube) account
125+
- `Twitch Whisper` - Accept commands from whispers sent to the configured [Twitch Broadcaster](/guide/platforms/twitch) account
126+
- `Twitch Subscription Message` - Accept commands included in the Twitch sub message
127+
- `Twitch Re-subscription Message` - Accept commands incldued in the Twitch re-sub message
128+
129+
:::
123130

124-
::
125131
::
126132

127133
### Cooldowns
128134

129135
To prevent spam or generally restrict usage of your command, you can configure cooldown options:
130136

131137
::field-group
132-
::field{name="Global Cooldown" type="Number" default=0}
138+
:::field{name="Global Cooldown" type="Number" default=0}
133139
Enter a minimum time, in seconds, before the command can be used by **anyone** again after it is executed
134140

135141
- Set to `0` to disable global cooldowns
136-
::
137-
::field{name="User Cooldown" type="Number" default=0}
138-
Enter a minimum time, in seconds, before the command can be used by **a specific user** again after it is executed by that user
142+
143+
:::
144+
145+
:::field{name="User Cooldown" type="Number" default=0}
146+
Enter a minimum time, in seconds, before the command can be used by **a specific user** again after it is executed by that user
139147

140148
- Set to `0` to disable user cooldowns
141-
::
142-
::
149+
150+
:::
151+
::
143152

144153
::warning
145154
**The Broadcaster Account is always exempt from cooldowns.** If you are testing this feature, ensure you use a different account.
@@ -154,21 +163,21 @@ By default, commands can be executed by **anyone** in chat.
154163
You can restrict access to your commands by configuring permissions options:
155164

156165
::field-group
157-
::field{name="Grant Type" type=Select}
166+
:::field{name="Grant Type" type=Select}
158167
Modify the grant type for all configured permissions within this command:
159168

160169
- `Allow` - Only the specified groups or users can execute this command
161170
- `Deny` - Everyone **except** the specified groups or users can execute this command
162-
::
163171

164-
::warning
172+
::::warning
165173
If the `Allowed` or `Denied` fields are left empty, the permission applies to **everyone**. - Grant type `Allow`, with an empty `Allowed` field will **allow all users** access - Grant type `Deny` with an empty `Denied` field will **deny all users** access
166-
::
174+
::::
175+
:::
167176
::
168177

169-
::warning
178+
:::warning
170179
**The Broadcaster Account is always exempt from permission settings.** If you are testing this feature, ensure you use a different account.
171-
::
180+
:::
172181

173182
## Context Menu
174183

0 commit comments

Comments
 (0)