TinTin++ Mud Client Manual
         SUBSTITUTIONS

          TinTin++ will perform various types of substitions as detailed below.

          Variables

$ & * @   All variable and function names must begin with an alphabetic
          character, followed by any combination of alphanumeric characters and
          underscores.

$         The dollar sign is used to retrieve the value of a variable.

&         The ampersand sign is used to retrieve the index of a variable.

*         The astrix sign is used to retrieve the name of a variable.

@         The at sign is used for functions.

[ ]       Brackets are used for nested variables which function as an
          associative array. Associative arrays are also known as tables and
          maps. Regex can be used within brackets to match multiple variables.

+ -       The plus and minus signs are used to access variables by their index,
          with the first variable having index +1, and the last variable
          having index -1. Variables are ordered alphanumerically.

          All variables and functions can be escaped by doubling the sign,
          like $$variable_name or @@function_name. To escape a variable
          twice use $$$var_name. One escape is removed each time tintin
          needs to substitute a variable or function.

          Arguments

%0 - %99  The percent sign followed by a number is used for arguments by the
          following triggers:

          alias, action, button, event, function, prompt, and substitute.

&0 - &99  The ampersand sign followed by a number is used for arguments in the
          regex and replace commands.

          All trigger and command arguments can be escaped by doubling the
          sign like %%1 or &&1. One escape is removed each time tintin
          substitutes trigger or command arguments. To escape three times
          triple the sign like %%%1, etc.

          Colors

<000>     Three alphanumeric characters encapsulated by the less- and greater-
          than signs are used for 4 and 8 bit color codes.

<0000>    Either a B (background) or F (foreground) followed by three
          hexadecimal characters encapsulated by < > signs are used for 12
          bit color codes. Requires truecolor capable terminal.

<0000000> Either a B (background) or F (foreground) followed by six
          hexadecimal characters encapsulated by < > signs are used for 24
          bit color codes. Requires truecolor capable terminal.

          More information is available at #help color.

          Escapes

\         The back slash is used to escape a character. All available options
          are listed at #help escape. Escapes are typically escaped when text
          leaves the client, by being sent to a server, the shell, being
          displayed on the screen, or being processed as part of a regex.
          Escapes try to mimic escapes in PCRE when possible.

Related: characters, colors, escape_codes and pcre.