2017-04-14 06:45:25 +02:00
<!DOCTYPE html>
< html >
< title > Chatty - Custom Commands / Context Menus< / title >
< link rel = "stylesheet" type = "text/css" href = "style.css" / >
< body >
< div id = "backlink" > < a href = "help.html" > To main help page< / a > < / div >
< h1 > < a name = "top" > Custom Commands / Context Menus< / a > < / h1 >
< p > Under < code > Settings - Commands< / code > you can add Custom Commands and
customize some Context Menus (and the User Info Dialog) with your own entries.< / p >
2020-01-14 08:54:27 +01:00
< p > Check out < a href = "https://www.youtube.com/user/chattyclient" > YouTube< / a >
for various video tutorials.< / p >
2017-04-14 06:45:25 +02:00
< ul >
2018-12-31 07:36:39 +01:00
< li >
< a href = "#custom-commands" > Custom Commands< / a >
< ul >
2019-03-27 05:22:33 +01:00
< li > < a href = "#restrict-channel" > Restrict to channel< / a > < / li >
2018-12-31 07:36:39 +01:00
< li > < a href = "#anonymous-custom-commands" > Anonymous Custom Commands< / a > < / li >
2019-03-27 05:22:33 +01:00
< li > < a href = "#chain-commands" > Chaining Commands< / a > < / li >
2018-12-31 07:36:39 +01:00
< / ul >
< / li >
2017-04-14 06:45:25 +02:00
< li >
< a href = "#replacements" > Replacements< / a >
< ul >
< li > < a href = "#simple-replacements" > Simple Replacements< / a > < / li >
2021-03-04 11:21:03 +01:00
< li > < a href = "#escaping" > Escaping / Literal Text< / a > < / li >
2017-04-14 06:45:25 +02:00
< li > < a href = "#parameters-context" > Pre-defined Parameters< / a > < / li >
< li > < a href = "#functions" > Functions< / a > < / li >
2017-05-27 20:48:54 +02:00
< li > < a href = "#custom-replacements" > Custom Replacements< / a > < / li >
2017-04-14 06:45:25 +02:00
< / ul >
< / li >
< li >
< a href = "#menus" > Custom Context Menus / User Dialog Buttons< / a >
< ul >
< li > < a href = "#commands-list" > Format 1: List Custom Command Names< / a > < / li >
< li > < a href = "#inline-commands" > Format 2: Inline-Commands< / a > < / li >
< li > < a href = "#submenus" > Format 3: Submenus< / a > < / li >
2017-12-26 18:26:29 +01:00
< li > < a href = "#separators" > Separators< / a > < / li >
2017-04-14 06:45:25 +02:00
< li > < a href = "#shortcuts" > Shortcuts< / a > < / li >
2017-05-27 20:48:54 +02:00
< li > < a href = "#positioning" > Positioning< / a > < / li >
2017-09-12 17:39:01 +02:00
< li > < a href = "#special-commands" > Special Commands< / a > < / li >
2017-04-14 06:45:25 +02:00
< / ul >
< / li >
< / ul >
< h2 > < a name = "custom-commands" > Custom Commands< / a > < / h2 >
< p > Custom commands allow you to specify aliases for anything you could also
enter directly into the inputbox, like chat messages or regular
commands (with the exception of other custom commands, which is a
limitation implemented to prevent infinite loops).< / p >
< p > To add a Custom Command add a new entry to the list labeled
"Custom Commands", in the following format:< / p >
< p > < code > /< commandName> < what the command should do> < / code > < / p >
< p > Everything up to the first space is the < em > name< / em >
of the command, and everything after the first space is what the command
will do or execute. For example:< / p >
< p > < code > /hello Hello World!< / code > < / p >
< p > If you added that to the Custom Commands list and
enter < code > /hello< / code > in the inputbox, then it would send
< code > Hello World!< / code > to chat, just as if you would have written it
yourself and pressed Enter.< / p >
2019-10-07 21:12:57 +02:00
< p > Any entry in the "Custom Commands" list starting with a < code > #< / code >
will be completely ignored. For example:< / p >
< p > < code > # Hello World!< / code > < / p >
2019-03-27 05:22:33 +01:00
< p > See < a href = "#replacements" > Replacements< / a > for more advanced usage.< / p >
< h3 > < a name = "restrict-channel" > Restrict to channel< / a > < / h3 >
2017-05-27 20:48:54 +02:00
< p > Adding a < code > #< / code > and a channel name you can restrict the command
to that channel:< / p >
< p > < code > /hello#joshimuz Hello Joshimuz Chat!< / code > < / p >
< p > This < code > /hello< / code > command would only be executed in #joshimuz,
however if you still have the version without a channel in the Custom
Commands list as well, it will fallback to that in other channels. This
way to can add variations of commands for specific channels.< / p >
2018-12-31 07:36:39 +01:00
< h3 > < a name = "anonymous-custom-commands" > Anonymous Custom Commands< / a > < / h3 >
< p > Custom Commands that aren't defined in the Custom Commands list do not
have a name and can thus only be executed from the context they are
defined, for example when adding < a href = "#inline-commands" > Inline-Commands< / a >
to the User Dialog or Context Menus.< / p >
2021-03-04 11:21:03 +01:00
< p > You can also execute Anonymous Custom Commands directly from the
2018-12-31 07:36:39 +01:00
inputbox, by prepending < code > //< / code > , which allows you to use
Replacements:< / p >
< dl class = "defList" >
< dt > < code > /echo Open Channels: $(chans)< / code > < / dt >
< dd > Executes as a normal command (nothing replaced)< / dd >
< dd > Outputs < code > Open Channels: $(chans)< / code > < / dd >
< dt > < code > //echo Open Channels: $(chans)< / code > < / dt >
< dd > Executes as an Anonymous Custom Command< / dd >
< dd > Outputs < code > Open Channels: joshimuz lotsofs cirno_tv< / code > < / dd >
< / dl >
2019-03-27 05:22:33 +01:00
< h3 > < a name = "chain-commands" > Chaining Commands< / a > < / h3 >
< p > Executing several commands in a row is not a feature of Custom Commands,
although the < a href = "help.html#commands-chain" > /chain command< / a > can
be used to achieve something like that.< / p >
2017-04-14 06:45:25 +02:00
< h2 > < a name = "replacements" > Replacements< / a > < / h2 >
2017-12-26 18:26:29 +01:00
< ul >
< li > < a href = "#simple-replacements" > Simple Replacements< / a > < / li >
2021-03-04 11:21:03 +01:00
< li > < a href = "#escaping" > Escaping / Literal Text< / a > < / li >
2017-12-26 18:26:29 +01:00
< li > < a href = "#parameters-context" > Pre-defined Parameters< / a > < / li >
< li > < a href = "#functions" > Functions< / a > < / li >
< li > < a href = "#custom-replacements" > Custom Replacements< / a > < / li >
< / ul >
2017-04-14 06:45:25 +02:00
< p > Anything starting with < code > $< / code > in the < code > < what the command
should do> < / code > section is treated as some sort of replacement.
Each replacement must contain an < strong > identifier< / strong >
which identifies what the replacement should be replaced with.< / p >
< p > For the < strong > short notation< / strong > the identifier is written
directly after the dollar sign: < code > $< identifier> < / code > .
2017-09-12 17:39:01 +02:00
In thise case it may only consist of a number and an optional dash:
< code > $< 1-9> [-]< / code > . Numeric identifiers refer to the parameters
2017-04-14 06:45:25 +02:00
supplied to the command.< / p >
< p > For the < strong > regular notation< / strong > the identifier is written after
the < code > $< / code > in parentheses: < code > $(< identifier> )< / code > .
This type of notation makes a more clear distinction between replacement
and the rest of the (literal) text and may contain numbers (including higher than 9)
and other identifiers, depending on the context.< / p >
< p > Put < code > $$< / code > (the < code > $< / code > twice) for any
< strong > required replacement< / strong > (for example < code > $$1< / code > ),
which means the whole Custom Command will only be run if that replacement
turns into a non-empty value. This can be used to make sure that a
parameter that is necessary for the command to make sense is actually
being supplied.< / p >
2021-03-04 11:21:03 +01:00
< h3 > < a name = "escaping" > Escaping / Literal Text< / a > < / h3 >
< p > If you want to use a dollar sign < code > $< / code > literally, without it
beginning a replacement, you can escape it with a backslash:
< code > \$< / code > . A backslash will always interpret the following
character as a regular character without a special meaning, while
the backslash itself will not show up in the result.< / p >
< p > Example: < code > $replace($1-,(\\w+),(\$1\),regRef)< / code > < / p >
< p > This < a href = "#functions" > function< / a > (surrounds all
consecutive word characters with brackets) contains some escaping:< / p >
< ul >
< li > The < code > (\\w+)< / code > turns into the plain text < code > (\w+)< / code > . The backslash needs to be escaped so
it actually shows up for the regex.< / li >
< li > The < code > (\$1\)< / code > turns into the plain text < code > ($1)< / code > . The dollar sign is used for the regex,
not an actual Custom Command replacement and the closing bracket
needs to be escaped here because the following function parameter is
optional, so the bracket would close the function.< / li >
< / ul >
< p > Alternatively you can use < code > $"< literal text> "< / code > which
interprets everything inside the quotes as literal text without any
special meaning. To use a quote inside the literal text, it can be
doubled: < code > $"This is a dollar sign: ""$"""< / code > turns into the
plain text < code > This is a dollar sign: "$"< / code > . Instead of < code > "< / code >
you can also use < code > `< / code > (backquote) or < code > '< / code > (single quote):
< code > $`This is a dollar sign: "$"`< / code > is equivalent to the above.< / p >
< p > The previous example could also be written like this: < code > $replace($1-,$"(\w+)",$"($1)",regRef)< / code > < / p >
2017-04-14 06:45:25 +02:00
< h3 > < a name = "simple-replacements" > Simple Replacements< / a > < / h3 >
< p > A basic use of replacements is using the < strong > short notation< / strong >
to put in parameters supplied when executing the command. Consider this
Custom Command:< / p >
< p > < code > /slap /me slaps < strong > $$1< / strong > around a bit with a large trout< / code > < / p >
< p > Then, when you enter < code > /slap moobot< / code > in the inputbox, it will
replace < code > $$1< / code > with the first word after the command, which in
this case would be < code > moobot< / code > , making the resulting command:< / p >
< p > < code > /me slaps < strong > moobot< / strong > around a bit with a large trout< / code > < / p >
< p > This is the syntax for specifying parameters (word in this context means
2018-12-31 07:36:39 +01:00
anything separated by a space):< / p >
2017-04-14 06:45:25 +02:00
< dl >
< dt > < code > $1, $2, $3< / code > < / dt >
< dd > First word, second word, third word etc.< / dd >
< dd > < code > $(1), $(2), $(3)< / code > is the equivalent in the regular notation< / dd >
< dt > < code > $1-< / code > < / dt >
< dd > First word, and all the words after it< / dd >
< dd > < code > $2-, $3-< / code > is also possible< / dd >
< dd > < code > $(1-), $(2-), $(3-)< / code > is the equivalent in the regular notation< / dd >
< dt > < code > $$1< / code > < / dt >
< dd > First word, but required, meaning the command will only be executed
if this parameter is actually present< / dd >
< dd > < code > $$2, $$3-< / code > is also possible< / dd >
< dd > < code > $$(1), $$(2), $$(3-)< / code > is the equivalent in the regular notation< / dd >
< / dl >
< p > The short notation ( < code > $1< / code > ) only works for the numbers 1 to 9,
which usually should be enough. For other kinds of replacements you must
2019-03-27 05:22:33 +01:00
use the regular notation including parentheses: < code > $(10)< / code > .< / p >
2017-04-14 06:45:25 +02:00
< h3 > < a name = "parameters-context" > Pre-defined Parameters< / a > < / h3 >
< p > Custom Commands can be used in a number of different places. Depending on
the context there are different pre-defined parameters available. The
2017-09-12 17:39:01 +02:00
following table shows which identifiers can be used in which
2017-04-14 06:45:25 +02:00
context. To use an identifier put it in a replacement, for example
< code > $(chan)< / code > or < code > $$join(1-,/)< / code > .< / p >
2020-01-14 08:54:27 +01:00
< table class = "settings" cellspacing = "1" >
2017-04-14 06:45:25 +02:00
< tr >
< th > Context< / th >
< th > Identifier< / th >
< th > Description< / th >
< / tr >
< tr >
2020-05-14 15:39:09 +02:00
< th rowspan = "10" > < em > All< / em > < / th >
2017-04-14 06:45:25 +02:00
< td > < code > chan< / code > < / td >
< td > The current channel context (without leading #)< / td >
< / tr >
2018-12-31 07:36:39 +01:00
< tr >
< td > < code > stream< / code > < / td >
< td > The stream name of the current channel context (different from
< code > chan< / code > for Chatrooms)< / td >
< / tr >
< tr >
< td > < code > chans< / code > < / td >
< td > All currently open regular channels (separated by spaces,
without leading #)< / td >
< / tr >
2020-05-14 15:39:09 +02:00
< tr >
< td > < code > hostedChan< / code > < / td >
< td > The currently hosted channel (if any)< / td >
< / tr >
2017-04-14 06:45:25 +02:00
< tr >
< td > < code > streamstatus< / code > < / td >
< td > Stream Status (Title/Game or Offline)< / td >
< / tr >
< tr >
< td > < code > streamtitle< / code > < / td >
< td > Stream Title (only if live)< / td >
< / tr >
< tr >
< td > < code > streamgame< / code > < / td >
< td > Stream Game (only if live)< / td >
< / tr >
< tr >
< td > < code > streamviewers< / code > < / td >
< td > Number of viewers (only if live)< / td >
< / tr >
< tr >
< td > < code > streamuptime< / code > < / td >
< td > Stream Uptime (only if live)< / td >
< / tr >
< tr >
< td colspan = "2" > The stream info is of the current channel context< / td >
< / tr >
2018-12-31 07:36:39 +01:00
<!-- User Context Menu -->
2017-04-14 06:45:25 +02:00
< tr >
2021-03-04 11:21:03 +01:00
< th rowspan = "5" > User Context Menu< / th >
< td > < code > 1< / code > < / td >
2017-04-14 06:45:25 +02:00
< td > Name of the user< / td >
< / tr >
2019-10-07 21:12:57 +02:00
< tr >
2021-03-04 11:21:03 +01:00
< td > Various< / td >
< td > < a href = "#user-identifiers" > Various user-related identifiers< / a > < / td >
2019-10-07 21:12:57 +02:00
< / tr >
2019-08-05 18:08:32 +02:00
< tr >
< td > < code > msg< / code > < / td >
< td > Message text of the selected message (depending on the line in
chat you opened the User Contex Menu from, not available for
your own messages)< / td >
< / tr >
2017-04-14 06:45:25 +02:00
< tr >
2018-12-31 07:36:39 +01:00
< td > < code > msg-id< / code > < / td >
< td > Message id of the selected message (depending on the line in
2019-08-05 18:08:32 +02:00
chat you opened the User Contex Menu from, not available for
your own messages)< / td >
2018-12-31 07:36:39 +01:00
< / tr >
< tr >
< td > < code > automod-msg-id< / code > < / td >
< td > Message id of the selected message filtered by AutoMod, for
approving or denying the message (when opened by clicking on
an appropriate message in chat)< / td >
< / tr >
<!-- User Dialog -->
< tr >
2020-01-14 08:54:27 +01:00
< th rowspan = "7" > User Dialog< / th >
2019-10-07 21:12:57 +02:00
< td > < em > All from User Context Menu< / em > < / td >
< td > See above< / td >
2017-04-14 06:45:25 +02:00
< / tr >
< tr >
2019-08-05 18:08:32 +02:00
< td > < code > 2-< / code > , < code > reason< / code > < / td >
2017-04-14 06:45:25 +02:00
< td > Ban reason (if selected)< / td >
< / tr >
2019-08-05 18:08:32 +02:00
< tr >
< td > < code > msg< / code > < / td >
< td > Message text of the selected message (< code > > < / code > in front
of message, depending on the line in chat you opened it from,
not available for your own messages)< / td >
< / tr >
2018-12-31 07:36:39 +01:00
< tr >
< td > < code > msg-id< / code > < / td >
< td > Message id of the selected message (< code > > < / code > in front
2019-08-05 18:08:32 +02:00
of message, depending on the line in chat you opened it from,
not available for your own messages)< / td >
2018-12-31 07:36:39 +01:00
< / tr >
< tr >
< td > < code > automod-msg-id< / code > < / td >
< td > Message id of the selected message filtered by AutoMod, for
approving or denying the message (when opened by clicking on
an appropriate message in chat)< / td >
< / tr >
2019-01-08 12:59:46 +01:00
< tr >
< td > < code > followage< / code > /
< code > accountage< / code > < / td >
< td > How long ago (e.g. < code > 3.2 years< / code > ) the user has followed
/ has created the Twitch account (only if available)< / td >
< / tr >
< tr >
< td > < code > followdate< / code > / < code > acccountdate< / code > < / td >
< td > The date (e.g. < code > 2012-09-15 17:19:29 +0200< / code > ) the user
has followed / has created the Twitch account (only if available)< / td >
< / tr >
2018-12-31 07:36:39 +01:00
<!-- Channel Context Menu -->
2017-04-14 06:45:25 +02:00
< tr >
2020-01-14 08:54:27 +01:00
< th > Channel Context menu< / th >
2017-04-14 06:45:25 +02:00
< td > < code > 1< / code > < / td >
< td > Name of the currently active channel (without leading #)< / td >
< / tr >
2018-12-31 07:36:39 +01:00
<!-- Streams Context Menu -->
2017-04-14 06:45:25 +02:00
< tr >
2020-01-14 08:54:27 +01:00
< th > Streams Context menu< / th >
2017-04-14 06:45:25 +02:00
< td > < code > 1-< / code > < / td >
< td > Names of selected streams< / td >
< / tr >
2020-05-14 15:39:09 +02:00
<!-- Hotkey -->
2017-04-14 06:45:25 +02:00
< tr >
2020-01-14 08:54:27 +01:00
< th > Hotkey< / th >
2017-04-14 06:45:25 +02:00
< td > < code > 1< / code > < / td >
< td > The currently < a href = "help.html#userselection" > selected user< / a > (if present)< / td >
< / tr >
2020-05-14 15:39:09 +02:00
<!-- Text Context Menu -->
< tr >
< th > Selected Text Context menu< / th >
< td > < code > 1-< / code > , < code > msg< / code > < / td >
< td > The selected text< / td >
< / tr >
<!-- Admin Context Menu -->
< tr >
< th rowspan = "4" > Admin Context menu< / th >
< td > < code > title< / code > < / td >
< td > The stream title currently set in the Admin Dialog< / td >
< / tr >
< tr >
< td > < code > game< / code > < / td >
< td > The game (category) currently set in the Admin Dialog< / td >
< / tr >
< tr >
< td > < code > tag-ids< / code > < / td >
< td > The tags currently set in the Admin Dialog (ids, comma-separated)< / td >
< / tr >
< tr >
< td > < code > tag-names< / code > < / td >
< td > The tags currently set in the Admin Dialog (display names, comma-separated)< / td >
< / tr >
2017-04-14 06:45:25 +02:00
< / table >
2021-03-04 11:21:03 +01:00
< h3 > < a name = "user-identifiers" > User-related Identifiers< / a > < / h3 >
< p > These are available where a user is involved, such as the User Dialog and
User Context Menu. In some contexts they may also be available with the
< code > my-< / code > prefix for your own user info (e.g. < code > my-full-nick< / code > ).< / p >
< ul >
< li > < code > nick< / code > - Name of the user, maybe capitalized< / li >
< li > < code > display-nick< / code > - Same as < code > nick< / code > , but may not match the regular username (spaces, completely different)< / li >
< li > < code > display-nick2< / code > - Same as < code > display-nick< / code > , but contains the regular username in parentheses if necessary< / li >
< li > < code > custom-nick< / code > - Same as < code > display-nick< / code > , but may also be the < a href = "help.html#customNames" > Custom Name< / a > you set< / li >
< li > < code > full-nick< / code > - The same name that is displayed in the userlist (includes status symbols)< / li >
< li > < code > full-nick2< / code > - Same as < code > full-nick< / code > , but contains the regular username in parentheses if necessary< / li >
< li > < code > special-nick< / code > - Returns < code > true< / code > if the user has a display name not matching the regular username< / li >
< li > < code > user-id< / code > - The Twitch ID of the user (if available)< / li >
< li > < code > twitch-badges< / code > - A textual representation of the Twitch badges (if available)< / li >
< li > < code > twitch-badge-info< / code > - Another textual representation of the Twitch badges (if available)< / li >
< / ul >
< h3 > Pre-defined Parameters Example< / h3 >
2017-04-14 06:45:25 +02:00
< dl class = "defList" >
< dt > < code > /streaminfo /echo [Stream Status] $(streamstatus) [Uptime] $(streamuptime)< / code > < / dt >
< dd > Entering < code > /streaminfo< / code > outputs an info message (only for
you) with the current stream status and uptime.< / dd >
< / dl >
< p > In addition, there is an implicit channel context, which means channel-aware
commands like < code > /ban< / code > are executed in the appropriate channel.< / p >
< h3 > < a name = "functions" > Functions< / a > < / h3 >
2020-05-14 15:39:09 +02:00
< p > Functions are replacements, however they have a function name before the
identifier (there is no short notation for functions):< / p >
2017-04-14 06:45:25 +02:00
2017-05-27 20:48:54 +02:00
< p > < code > $< functionName> (< identifier> ,< some parameters> ,[optional parameters])< / code > < / p >
2017-04-14 06:45:25 +02:00
2019-08-05 18:08:32 +02:00
< p class = "note" > < em > Note:< / em > The < code > < identifier> < / code > parameter
means anything not starting with < code > $< / code > is interpreted as the
identifier only. You can think of it as an extension to the regular
replacement:
< code > $(1-) -> $< u > join< / u > (1-< u > ,/< / u > )< / code > < / p >
2020-05-14 15:39:09 +02:00
< p > The following functions are always available:< / p >
2017-04-14 06:45:25 +02:00
< dl class = "defList" >
2017-05-27 20:48:54 +02:00
< dt > < code > $if(< identifier> ,< output if exists> ,[output if not])< / code > < / dt >
2017-04-14 06:45:25 +02:00
< dd > If the value the identifier refers to exists (non-empty), it will
return the first function parameter, the second otherwise.< / dd >
2017-05-27 20:48:54 +02:00
< dd > < em > Example:< / em > < code > $if(1,$1,nope)< / code > with command parameters < code > cheese cake< / code > turns into < code > cheese< / code > ,
with no parameters turns into < code > nope< / code > , the optional < code > [output if not]< / code > function parameter.< / dd >
< dt > < code > $ifeq(< identifier> ,< comparison> ,< output if equal> ,[output if not])< / code > < / dt >
2020-05-14 15:39:09 +02:00
< dd > Similar to < code > $if< / code > , but instead of just checking for the
2017-05-27 20:48:54 +02:00
existence of a parameter it compares it to a given value
(< code > < comparison> < / code > ).< / dd >
< dd > < em > Example:< / em > < code > $ifeq(1,cheesecake,yummy)< / code > with parameters
< code > cheesecake< / code > turns into < code > yummy< / code > , with parameters
< code > cheese cake< / code > turns into an an empty string, since the
optional < code > [output if not]< / code > has not been specified.< / dd >
2017-04-14 06:45:25 +02:00
2020-05-14 15:39:09 +02:00
< dt > < code > $switch(< identifier> ,< case1> :< result1> ,..,[casen]:[resultn],[default])< / code > < / dt >
< dd > Similiar to a switch statement in programming, or one or several < code > $ifeq()< / code > functions.
Compares the value associated with the identifier with the case values and returns the following
result if it matches. If none of the case values match, it will return the default, or an empty value.< / dd >
< dd > < em > Example:< / em > < code > /set fontSize $switch($get(fontSize),25:50,50:18,25)< / code > when added
as a Custom Command alternates between font sizes 18, 25 and 50.< / dd >
2017-04-14 06:45:25 +02:00
< dt > < code > $join(< identifier> ,< separator> )< / code > < / dt >
< dd > Joins together the arguments the identifier refers to, using the
given separator.< / dd >
< dd > < em > Example:< / em > < code > $join(1-,/)< / code > with < code > 1-< / code > referring to
< code > flour sugar eggs< / code > turns into < code > flour/sugar/eggs< / code > < / dd >
< dd > This effectively replaces spaces in the parameters with the separator.< / dd >
2017-09-12 17:39:01 +02:00
< dt > < code > $lower(< identifier> )< / code > < / dt >
< dd > Makes the given input lowercase.< / dd >
< dd > < em > Example:< / em > < code > $lower(1)< / code > with < code > 1< / code >
referring to < code > Fremily< / code > turns into < code > fremily< / code > .< / dd >
2018-12-31 07:36:39 +01:00
2019-08-05 18:08:32 +02:00
< dt > < code > $upper(< identifier> )< / code > < / dt >
< dd > Makes the given input uppercase.< / dd >
< dd > < em > Example:< / em > < code > $upper(1)< / code > with < code > 1< / code >
referring to < code > Fremily< / code > turns into < code > FREMILY< / code > .< / dd >
2019-10-07 21:12:57 +02:00
< dt > < code > $replace(< input> ,< search> ,< replace> ,[method])< / code >
2021-03-04 11:21:03 +01:00
< dd > Search and replace in text.< / dd >
< dd > Especially when using Regex, remember
escaping < code > \< / code > (< code > \\< / code > ) and < code > $< / code > (< code > \$< / code > )
when they should e.g. be used in regex rather than interpreted as special Custom Command characters.
Instead of escaping each special character individually, you can also
use < a href = "#escaping" > Literal Text< / a > .< / dd >
2019-10-07 21:12:57 +02:00
< dd > Methods are:
< ul style = "margin-top:0" >
< li > < em > Not specified< / em > - Literal case-insensitive search< / li >
< li > < code > cs< / code > - Literal case-sensitive search< / li >
< li > < code > reg< / code > - Regular Expression search< / li >
2021-03-04 11:21:03 +01:00
< li > < code > regRef< / code > - Regular Expression search, with references to groups via < code > \$1< / code > < br / >
Note: The "replace" text basicially gets fed to the < a href = "https://docs.oracle.com/javase/8/docs/api/java/lang/String.html#replaceAll-java.lang.String-java.lang.String-" > String.replaceAll()< / a > method as "replacement". The < code > $1< / code > in this case does not refer to a Custom Command replacement, but something that the replaceAll() method uses, so it needs to be escaped in the Custom Command function, either by using < code > \$1< / code > or using < a href = "#escaping" > Literal Text< / a > . In addition, if < code > $< / code > or < code > \< / code > should show up literally instead of being interpreted by the replaceAll() method then they need to be escaped again (e.g. < code > $replace(..,..,Dollar: \\\$1 Ref: \$1,regRef)< / code > , whereas < code > Dollar: \$1 Ref: $1< / code > would be given to the replaceAll() method).< / li >
2019-10-07 21:12:57 +02:00
< li > < code > regFirst< / code > , < code > refFirstRef< / code > - Same as above, but only replace first occurence< / li >
2021-03-04 11:21:03 +01:00
< li > < code > regCustom< / code > - Regular Expression search, the replace parameter has access to match values and is
executed for each match (< code > $1-< / code > full match, < code > $(g1)< / code > first group in the search regex
if available, < code > $(g2)< / code > second group, ..).< / li >
< li > < code > regFunc< / code > - Regular Expression search, the replace must be the name
of a Custom Replacement which is called with the same values as < code > regCustom< / code >
(doesn't always work in Custom Commands, can use < code > regCustom< / code >
with e.g. < code > $(_< name> ,$1-)< / code > instead).< / li >
2019-10-07 21:12:57 +02:00
< / ul >
< / dd >
< dd > < em > Example:< / em > < code > $replace(A b and another B,b,bee)< / code > turns into < code > A bee and another bee< / code > < / dd >
< dd > < em > Example:< / em > < code > $replace(Was timed out for 30 seconds,.*?(\\d+) seconds,Number of seconds: \$1,regRef)< / code > turns into < code > Number of seconds: 30< / code > < / dd >
2021-03-04 11:21:03 +01:00
< dd > < em > Example:< / em > < code > $replace($1-,$"~([a-z]+)~",< span style = "text-decoration: underline" > $replace($(g1),$"(\w)",$"$1+",regRef)< / span > ,regCustom)< / code > adds < code > +< / code > behind every character surrounded by < code > ~< / code > (the inner < code > $replace()< / code > is in the < code > replace< / code > parameter and executed for each match)< / dd >
2019-10-07 21:12:57 +02:00
2019-08-05 18:08:32 +02:00
< dt > < code > $rand([output1],[output2],[output3],..)< / code > < / dt >
2018-12-31 07:36:39 +01:00
< dd > Randomly chooses one of the outputs.< / dd >
< dd > < em > Example:< / em > < code > $rand(cheesecake,strawberry cake,$1-)< / code >
with < code > 1-< / code > referring to < code > apple pie< / code > turns into
either < code > cheesecake< / code > , < code > strawberry cake< / code > or
< code > apple pie< / code > .< / dd >
2019-03-27 05:22:33 +01:00
< dt > < code > $randnum(< from> ,< to> )< / code > or < code > $randnum(< to> )< / code > < / dt >
< dd > Randomly chooses a number in the given range (inclusive). If only
one number is given, it the range is 0 to the given number. If the
"from" is not a number, it defaults to 0, if the "to" is not a
number it defaults to a really big number.< / dd >
< dd > < em > Example:< / em > < code > $randnum(600,800)< / code > chooses a random
number between 600 and 800.< / dd >
< dd > < em > Example:< / em > < code > $randum($$1)< / code > chooses a random number
between 0 and what is the first parameter.< / dd >
2020-05-14 15:39:09 +02:00
< dt > < code > $calc(< simple math expression> )< / code > < / dt >
< dd > Limited support for performing calculations.< / dd >
< dd > < em > Example:< / em > < code > //echo $calc(2^3) $calc( (3+4\) / 2)< / code >
when entered into the inputbox returns < code > 8 3.5< / code > (note the
parentheses in the second, as well as how the closing parenthesis
needs to be escaped).< / dd >
2019-08-05 18:08:32 +02:00
< dt > < code > $urlencode(< input> )< / code > < / dt >
< dd > Uses < a href = "https://docs.oracle.com/javase/8/docs/api/java/net/URLEncoder.html#encode-java.lang.String-java.lang.String-" > UrlEncoder.encode()< / a >
to prepare the input to be used in a URL query parameter.< / dd >
< dd > < em > Example:< / em > < code > $urlencode($(msg))< / code > in User Dialog
encodes the currently selected message.< / dd >
2020-10-17 22:19:41 +02:00
< dt > < code > $sort(< input> ,[type],[separator])< / code > < / dt >
2019-08-05 18:08:32 +02:00
< dd > Sorts the given input alphabetically. The sort type can be "abc"
(default) for case-insensitive sorting or "Abc" for case-sensitive
sorting. The separator is what separates the parts that are sorted,
by default a space.< / dd >
< dd > < em > Example:< / em > < code > $sort(B c a)< / code > turns into < code > a B c< / code > < / dd >
< dd > < em > Example:< / em > < code > $sort(B c a,Abc)< / code > turns into < code > B a c< / code > < / dd >
2020-10-17 22:19:41 +02:00
< dt > < code > $input([message],[intial],[type])< / code > < / dt >
< dd > Requests text input from the user by showing an input dialog.
Execution is paused while the dialog is open. The user may enter an
empty value (the result is just empty) or cancel the dialog (the
command will not be executed).< / dd >
< dd > The < code > message< / code > is shown in the input dialog, the < code > initial< / code >
text will already be in the input field when the dialog opens. The
< code > type< / code > is currently not used and can just be left empty.< / dd >
< dd > < em > Example:< / em > < code > $input()< / code > < / dd >
< dd > < em > Example:< / em > < code > $input(Enter a number please)< / code > < / dd >
2019-03-27 05:22:33 +01:00
< dt > < code > $datetime([format],[timezone],[locale])< / code > < / dt >
< dd > Outputs the current date/time. You can optionally give a format
pattern (based on < a href = "https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html#patterns" > DateTimeFormatter< / a > ),
a timezone (based on < a href = "https://docs.oracle.com/javase/8/docs/api/java/time/ZoneId.html" > ZoneId< / a > ,
although something like "New York" should also work) and a locale
(a language tag such as "en").< / dd >
< dd > Predefined formats:
< ul style = "margin-top:0" >
< li > Short: < code > date< / code > , < code > time< / code > , < code > datetime< / code > < / li >
< li > With timezone: < code > date2< / code > , < code > time2< / code > , < code > datetime2< / code > < / li >
< li > Locale-specific: Append < code > _short< / code > , < code > _medium< / code > ,
< code > _long< / code > or < code > _full< / code > , e.g. < code > datetime_full< / code > < / li >
< / ul >
< / dd >
< dd >
< em > Examples:< / em >
< dl style = "margin-top:0" >
< dt > < code > $datetime()< / code > < / dt >
< dd > < code > Wednesday, March 13, 2019 3:11:48 PM CET< / code > < / dd >
< dd > (Default format depends on the locale, in this case using the system default.)< / dd >
< dt > < code > $datetime(,,de)< / code > < / dt >
< dd > < code > Mittwoch, 13. März 2019 15:12 Uhr MEZ< / code > < / dd >
< dd > (Default format depends on the locale, in this case explicitly specified.)< / dd >
< dt > < code > $datetime(time)< / code > < / dt >
< dd > < code > 23:31:27< / code > < / dd >
< dd > (Using one of the pre-defined formats "< code > time< / code > ".)< / dd >
< dt > < code > $datetime(datetime2,Vancouver)< / code > < / dt >
< dd > < code > 2019-03-12 15:31:45 PDT GMT-0700< / code > < / dd >
< dd > (Using the more verbose "< code > datetime2< / code > " pre-defined format, with a timezone specified.)< / dd >
< dt > < code > $datetime(datetime_full,Rome,it)< / code > < / dt >
< dd > < code > mercoledì 13 marzo 2019 15.32.03 CET< / code > < / dd >
< dd > (Using one of the locale-specific pre-defined formats, with timezone and locale specified.)< / dd >
< dt > < code > $datetime(,london)< / code > < / dt >
< dd > < code > Wednesday, March 13, 2019 2:16:36 PM GMT< / code > < / dd >
< dd > (Empty format to be able to specify timezone.)< / dd >
< dt > < code > $datetime(HH:mm:ss zzzz,Tokyo,en)< / code > < / dt >
< dd > < code > 07:50:20 Japan Standard Time< / code > < / dd >
< dd > (Output is usually based on your system language, but you
can also explicitely specify it.)< / dd >
< dt > < code > $datetime(eeee\, dd. MMMM yyyy,,de)< / code > < / dt >
< dd > < code > Dienstag, 12. März 2019< / code > < / dd >
< dd > (Custom format, < code > ,< / code > escaped since it normally
separates function parameters, empty timezone in order to be
able to specify locale.)< / dd >
< / dl >
2017-04-14 06:45:25 +02:00
< / dl >
2020-05-14 15:39:09 +02:00
< p > The following functions are only available in some contexts:< / p >
< dl class = "defList" >
< dt > < code > $is(< match input> )< / code > < / dt >
< dd > Outputs < code > true< / code > if the match succeeds, nothing otherwise.
The < code > match input< / code > is in the < a href = "help-settings.html#Highlight_Matching" > Highlight< / a >
format, although what can actually be matched against depends on
where the command is ran from, for example the user or message text
is only available from the User Dialog or User Context Menu.< / dd >
< dd > < em > Example:< / em > < code > $if($is(mystatus:bm),I'm a mod,Not a mod)< / code >
will output < code > I'm a mod< / code > in channels where you are the
broadcaster or a moderator, < code > Not a mod< / code > otherwise.< / dd >
< dt > < code > $get(< settingName> ,[key])< / code > < / dt >
< dd > Returns the value of a setting. Different setting types return
differently formatted values. There is no comprehensive list of
settings, unless you count the < a href = "https://github.com/chatty/chatty/blob/master/src/chatty/SettingsManager.java" > Chatty source< / a > .< / dd >
< dd > One intended use for this is the special setting < code > var< / code > ,
where you can set a string value using setting commands
(< code > /set var foo bar< / code > ) and then retrieve the value with
this function (< code > $get(var,foo)< / code > returns < code > bar< / code > ).< / dd >
< dd > < em > Example:< / em > < code > //echo $get(username)< / code > returns the
name you are logged into Chatty with.< / dd >
< dd > < em > Example:< / em > < code > $if($get(ontop),ONTOP)< / code > will return
< code > ONTOP< / code > only if "View - Always on top" is enabled.< / dd >
2021-03-04 11:21:03 +01:00
< dt > < code > $request(< url> ,[options])< / code > < / dt >
< dd > Performs a GET request on the given http/https URL and returns the
body of the reponse interpreted as UTF-8 encoded text. If an error
occurs the response will be empty.< / dd >
< dd > Options:
< ul >
< li > < code > error< / code > - A request error will return an error
message instead of an empty response.< / li >
< / ul > < / dd >
< dd > < em > Note:< / em > Normally Custom Commands are performed instantaneously, however the
replacements for any Custom Command that contains the < code > $request()< / code >
function will be performed asynchronously so that it can complete
the request without freezing the GUI. This means the result of the
Custom Command may be run seconds or more later.< / dd >
< dd > < em > Tip:< / em > Open "Extra - Debug window" to view debug output of
the requests being performed.< / dd >
2020-05-14 15:39:09 +02:00
< / dl >
2019-03-27 05:22:33 +01:00
< p class = "note" > < em > Tip:< / em > Enter e.g. < code > //echo $datetime()< / code >
into the chat inputbox to test a function directly, use arrow up/down
keys to cycle through previous inputs. Of course you won't be able to
use some context dependant parameters this way.< / p >
2019-08-05 18:08:32 +02:00
2017-04-14 06:45:25 +02:00
< p > Examples of Custom Commands with these functions:< / p >
< dl class = "defList" >
< dt > < code > /slap /me slaps $$1 around a bit with a large $if(2,$2,trout)< / code > < / dt >
< dd > Entering < code > /slap Nightbot< / code > turns into < code > /me slaps Nightbot around a bit with a large trout< / code > < / dd >
< dd > Entering < code > /slap Nightbot cheesecake< / code > turns into < code > /me slaps Nightbot around a bit with a large cheesecake< / code > < / dd >
< dt > < code > /mt /openUrlPrompt http://multitwitch.tv/$$join(1-,/)< / code > < / dt >
< dd > Entering < code > /mt< / code > outputs an "insufficient parameters" message
because the < code > $$join< / code > is required to return something,
which it can't from the identifier < code > 1-< / code > if there are no
parameters< / dd >
< dd > Entering < code > /mt joshimuz lotsofs< / code > opens the URL < code > http://multitwitch.tv/joshimuz/lotsofs< / code > < / dd >
< / dl >
< p class = "note" > < em > Note:< / em > A backslash can be used to escape parenthesis
in function parameters. Example: < code > $if(streamuptime,$(streamuptime),(n/a\))< / code > .
In this example only the closing one after < code > n/a< / code > has to be
escaped, because the opening one doesn't have a special meaning in this
context and the ones around < code > streamuptime< / code > have a special
2017-05-27 20:48:54 +02:00
meaning that takes precedence (opening/closing the replacement).< / p >
< h3 > < a name = "custom-replacements" > Custom Replacements< / a > < / h3 >
< p > You can create your own identifiers for replacements by adding an entry
to the Custom Commands list starting with an underscore:< / p >
< p > < code > _m $ifeq(1,$(chan),,$$1: )< / code > < / p >
< p > Instead of a command, this creates an identifier that can be used in a
replacement:< / p >
< p > < code > /faq $(_m)FAQ: https://pastebin.com/KySx3KDu< / code > < / p >
< p > When the < code > /faq< / code > command is run, the < code > $(_m)< / code > gets
replaced with whatever is defined in < code > _m< / code > , in this case it
creates a mention if the first parameter isn't equal to the current
channel.< / p >
2021-03-04 11:21:03 +01:00
< p > The data that can be accessed via replacements is the same as in the
command it is used in, so in this example the text provided after the
< code > /faq< / code > is available via the < code > $1-< / code > replacement.< / p >
< p > Optionally you can also provide a second parameter in a Custom Replacement
that overwrites the default value of the < code > $1-< / code > replacement:< / p >
< p > < code > /faq $(_m,$(custom-nick))FAQ: https://pastebin.com/KySx3KDu< / code > < / p >
< p > This will make whatever value is contained in < code > $(custom-nick)< / code >
available in < code > $1-< / code > instead of the default.< / p >
< p class = "note" > < em > Note:< / em > Custom Replacement identifiers always start
with an underscore.< / p >
< p class = "note" > < em > Note:< / em > Custom Replacements don't work when placed
inside eachother. So for example in < code > _abc Abc: $(_m)< / code > the < code > $(_m)< / code > will
always be empty (whether it's defined in the Custom Commands list or not).< / p >
2017-05-27 20:48:54 +02:00
2017-04-14 06:45:25 +02:00
< h2 > < a name = "menus" > Custom Context Menus / User Dialog Buttons< / a > < / h2 >
2017-12-26 18:26:29 +01:00
< ul >
< li > < a href = "#commands-list" > Format 1: List Custom Command Names< / a > < / li >
< li > < a href = "#inline-commands" > Format 2: Inline-Commands< / a > < / li >
< li > < a href = "#submenus" > Format 3: Submenus< / a > < / li >
< li > < a href = "#separators" > Separators< / a > < / li >
< li > < a href = "#shortcuts" > Shortcuts< / a > < / li >
< li > < a href = "#positioning" > Positioning< / a > < / li >
< li > < a href = "#special-commands" > Special Commands< / a > < / li >
< / ul >
2017-04-14 06:45:25 +02:00
< p > Under < code > Settings - Commands< / code > there are several settings that
allow you to add additional entries/buttons in a few different places:< / p >
< dl class = "dl-settings" >
< dt > User Context Menu< / dt >
< dd > Entries get appended to the menu that opens when you right-click on
a user in chat or the userlist.< / dd >
< dt > Channel Context Menu< / dt >
< dd > Entries get appended to the menu that opens when you right-click on
the chat.< / dd >
< dt > Streams Context Menu< / dt >
< dd > Entries get appended to any menu that contains a "Twitch Stream"
submenu (for example the User Context Menu, Live Streams Dialog
Context Menu).< / dd >
< dt > User Dialog Buttons< / dt >
< dd > Defines which buttons are visible in the dialog that opens when you
2017-09-12 17:39:01 +02:00
click on a user in chat (or double-click in the userlist). Note
the < a href = "#special-commands" > Special Commands< / a > you can use for
this setting.< / dd >
2017-04-14 06:45:25 +02:00
< / dl >
< p > All those settings share the same format (with some slight differences
noted separately). A setting can contain several lines, and each line can contain one of the
available formats:< / p >
< div class = "codeblock" > < pre >
/Ban[B] /Unban[U] 5s[1] 2m[2] 10m[3] 30m[4]
Spoiler[S]=/timeout $$1 600 No spoilers
@b1
./Message /Report
.Warn User=$$1: Plz no spammerino< / pre > < / div >
2017-05-27 20:48:54 +02:00
< p class = "note" > < em > Note:< / em > Command Names/Labels may not contain the
characters < code > [ ] { }< / code > except for their special meaning of
< a href = "#shortcuts" > Shortcuts< / a > and < a href = "#positioning" > Positioning< / a > .< / p >
< h3 > < a name = "commands-list" > Format 1: List Custom Command Names< / a > < / h3 >
2017-04-14 06:45:25 +02:00
< p > You can list the name of several Custom Commands in one line, for example:< / p >
< p > < code > /Slap /Permit< / code > < / p >
< p > Which means the command with the name "slap" will be added first, then
"permit" after that. These must be existing commands, either pre-defined
Chatty commands or Custom Commands you added yourself.< / p >
< p > Note that you may only specify the command names, no parameters. The
parameters will be supplied automatically depending on the < a href = "#parameters-context" > context< / a > . For
example when you have < code > /Slap< / code > added to the User Dialog and
then open the dialog on the user < code > tailsgaming< / code > and click the
"Slap" button, it's as if you entered < code > /slap tailsgaming< / code > .< / p >
< dl class = "defList" >
< dt > < code > /Slap /Permit< / code > < / dt >
< dd > Command names should be prepended with a forward slash < code > /< / code >
(although it may also work without).< / dd >
< dt > < code > //Slap< / code > < / dt >
< dd > Prepending two forward slashes < code > //< / code > will put the command
in the special submenu < code > More..< / code > (for Context Menus) or in
a second line of buttons (for the User Dialog).< / dd >
< dt > < code > /Set_color< / code > is displayed as < code > Set color< / code > < / dt >
< dd > Underscores in commands are replaced with a space for display in a
Context menu or on a button.< / dd >
< / dl >
< p > In the same line, you can also specify < strong > Timeout Buttons< / strong > :< / p >
< dl class = "defList" >
< dt > < code > 5 2m 10m< / code > < / dt >
< dd > Times are added just like Custom Commands, except that they must not
start with a slash < code > /< / code > and must be a number followed by
an optional suffix. They are interpreted as seconds by default,
unless you add a suffix:
< code > s< / code > - seconds, < code > m< / code > - minutes,
< code > h< / code > - hours, < code > d< / code > - days.< / dd >
< dt > < code > 120s 120< / code > is displayed as two buttons with the label < code > 120s< / code > and < code > 2m< / code > < / dt >
< dd > Both definitions create a button with a 120 seconds timeout, however
if you use a suffix, then the definition is used as button label
directly, otherwise the label is automatically created based on the
time.< / dd >
< / dl >
< h3 > < a name = "inline-commands" > Format 2: Inline-Commands< / a > < / h3 >
< p > You can define commands directly in the setting, without having to add
them as a named Custom Command first. The syntax for this is:< / p >
< p > < code > < label with spaces> =< what the command should do> < / code > < / p >
< p > Note that as opposed to Custom Command names the label may contain spaces,
and for that purpose the separating character is an equals sign < code > =< / code > .
The label may not contain an equals sign itself. Example:< / p >
< p > < code > Warn User=$$1: Plz no spammerino< / code > < / p >
< p > As with Custom Commands, the < code > < what the command should do> < / code >
part can contain < a href = "#replacements" > replacements< / a > using
identifiers for the current < a href = "#parameters-context" > context< / a > .< / p >
< h3 > < a name = "submenus" > Format 3: Submenus< / a > < / h3 >
< p > Any line starting with < code > @< / code > defines a custom submenu. Any
following lines that start with a dot < code > .< / code > will then be put in
that menu (both command name lists and inline commands). For example:< / p >
< div class = "codeblock" > < pre >
@Rules
./No_Spam /No_Spoilers
.Spoiler=/timeout $$1 600 no spoilers
< / pre > < / div >
< p > For < strong > Context Menus< / strong > you can add submenus with custom names
(only 1 level though), or even add entries to existing submenus by
specifying the name (for example < code > @Twitch Stream< / code > ).< / p >
< p > For < strong > User Dialog Buttons< / strong > there are no named submenus,
however this notation can be used to put the buttons in separate rows.
Any submenu name starting with < code > a< / code > will create a row on the
top, all other ones on the bottom. The menu name < code > a1< / code > is the
default for buttons that don't have a menu defined, and < code > b1< / code >
is the default for the < code > //Command< / code > notation. Example:< / p >
< div class = "codeblock" > < pre >
/Ban /Unban
@a1
.Spoiler=/timeout $$1 600 no spoilers
@a2
.5s[1] 2m[2] 10m[3] 30m[4]
@b1
./Slap
< / pre > < / div >
< p > In this case the < code > Ban< / code > and < code > Unban< / code > commands are in
the default < code > a1< / code > row, which means they are in the same row as
the < code > Spoiler< / code > button (these are just different ways of
writing it). This also adds a second top row < code > a2< / code > for the
timeout buttons as well as a single bottom row for the < code > Slap< / code >
command.< / p >
2017-05-27 20:48:54 +02:00
2017-12-26 18:26:29 +01:00
< h3 > < a name = "separators" > Separators< / a > < / h3 >
< p > In < strong > Context menus< / strong > you can add separators between entries.
When you use a < a href = "#commands-list" > commands list< / a > , you can add
a vertical bar (< code > |< / code > ) between entries.< / p >
< p > You can also add a separator by adding a single dash (< code > -< / code > ) on
it's own line.< / p >
< p > Example (separator before < code > Timeout< / code > menu, before < code > Message< / code >
and before < code > Vods< / code > ):< / p >
< div class = "codeblock" > < pre >
/Ban /Purge
-
@Timeout
.5s 10m
-
/Message /Report | /Vods
< / pre > < / div >
2017-04-14 06:45:25 +02:00
< h3 > < a name = "shortcuts" > Shortcuts< / a > < / h3 >
< p > You can add a shortcut to the end of a label or command name by enclosing
2017-05-27 20:48:54 +02:00
it with < code > [ ]< / code > (square brackets):< / p >
2017-04-14 06:45:25 +02:00
2017-09-12 17:39:01 +02:00
< p > < code > /Ban[B]< / code > or < code > Spoiler[S]=/timeout $$1 ..< / code >
(depending on the line format)< / p >
2017-04-14 06:45:25 +02:00
< p > For < strong > User Dialog Buttons< / strong > those can be used while the
dialog is open and focused. They are interpreted by
< a href = "https://docs.oracle.com/javase/7/docs/api/javax/swing/KeyStroke.html#getKeyStroke%28java.lang.String%29" > getKeyStroke()< / a >
which means anything that function understands can be used. However
2018-04-02 02:28:44 +02:00
spaces are not allowed, so a plus sign < code > +< / code > can be used instead.
Examples: < code > alt+Q< / code > , < code > shift+1< / code > , < code > INSERT< / code > < / p >
< p > < em > Note:< / em > The lowercase/uppercase matters for it to be parsed
correctly.< / p >
2017-04-14 06:45:25 +02:00
< p > Adding a vertical bar < code > |< / code > after the shortcut will use the text
after it as label for the shortcut on the button (no spaces allowed). If
you include the < code > |< / code > but don't specify any text, then no label
will be displayed for that shortcut:< / p >
< p > < code > /Slap[NUMPAD1|Np1] /Permit[NUMPAD2|]< / code > < / p >
< p > For the User Dialog Buttons you can also include the string
< code > nokeylabels< / code > anywhere in the setting, which removes any
labels for the shortcuts, unless they are explicitly defined.< / p >
< p > For < strong > Context Menus< / strong > a single character can be used as a
Mnemonic, for quick access to menu entries. For this purpose, submenus
may also contain the same syntax: < code > @Rules[R]< / code > (which would
allow you to open that submenu by pressing R on your keyboard when the
context menu is open).< / p >
2017-05-27 20:48:54 +02:00
< h3 > < a name = "positioning" > Positioning< / a > < / h3 >
< p > You can define an absolute position in the menu the entry should appear
at by enclosing it with < code > { }< / code > (curly brackets) at the end of
the label or command name (but before a shortcut if there is any):< / p >
< p > < code > Mention{1}=/insertword $$1: \< / code > < / p >
< p > This will put the < code > Mention< / code > menu entry at the < em > second< / em >
position in the menu (counting starts from 0).< / p >
< p > Another example:< / p >
< div class = "codeblock" > < pre >
@Twitch Stream[s]
.Videos{2}[v]=/openUrlPrompt https://www.twitch.tv/$$1/videos/past-broadcasts
@Important{0}
.Slap=/me slaps $$1 around a bit with a large trout
@Really Important{0}
.FAQ=FAQ: https://pastebin.com/KySx3KDu
< / pre > < / div >
< p > This puts the < code > Videos< / code > entry into the pre-defined
< code > Twitch Stream< / code > submenu at the third position in the submenu
(also adding the accelerator key < code > s< / code > to the menu and
< code > v< / code > to the entry).< / p >
< p > It also adds the < code > Important< / code > submenu at the first position
(since it hasn't been added yet) and after that adds the
< code > Really Important< / code > submenu at the first position as well,
moving down < code > Important< / code > . This demonstrates that the
positioning is based on the current state of the menu, so it can matter
< em > when< / em > you add entries with absolute positioning.< / p >
2017-09-12 17:39:01 +02:00
< h3 > < a name = "special-commands" > Special Commands< / a > < / h3 >
< p > In the User Dialog Buttons setting you can use some special commands:< / p >
< ul >
< li > Add the command < code > /modunmod< / code > to ada a < strong > Mod/Unmod-Button< / strong >
which automatically changes depending on the selected user and
whether you are the broadcaster on the channel (so the button
doesn't always show up).< / li >
< li > The commands < code > /Automod_approve< / code > and < code > /Automod_deny< / code >
only appear as buttons when you opened the User Dialog by clicking
on the username of a message rejected by AutoMod.< / li >
< / ul >
< p > To make use of these you only need to enter the command, you don't need
any parameters (Chatty will take care of that). For example simply add
< code > /Modunmod< / code > or < code > Approve=/Automod_approve< / code > to add
it to the layout (using the syntax shown on this help page). Chatty will
then recognize the command names and the buttons will only show up when
they are needed.< / p >
2017-04-14 06:45:25 +02:00
< / body >
< / html >
