{{mirc guide}}{{title|mIRC Scripting Language}}[[File:mirc logo.png|left|64px]] ...ogramming paradigm|procedural]] [[scripting language]] embedded inside the mIRC client. mSL's main feature is its seamless ability to interact with other [

{{mirc title|String Manipulation}} <syntaxhighlight lang="mIRC">var %x = This is an example string.</syntaxhighlight>

{{mirc title|Token Manipulation}} ...separated by a single, unique character. mIRC provides an extensive set of identifiers and commands to help you manipulate this list of tokens.

{{mirc title|Aliases}} <syntaxhighlight lang="mIRC">;single-line alias

{{mirc title|Conditional Statements}} ...as a false [[truth value]] if it's {{mIRC|$null}}, [[$false - identifier - mIRC|$false]], or 0.

{{mirc title|While Loops}} <syntaxhighlight lang="mirc">while (<condition>) {

{{mirc title|Operators}} ...s or keywords that perform specific operations on two or three operands in mIRC.

{{mirc title|Custom Windows}} Prior to mIRC 5.5, '''Custom Windows''' was the main method for making a GUI (graphical u

{{mirc title|INI Files}} ...nd [[Hash Tables - mIRC|hash tables]]. If speed is needed, [[Hash Tables - mIRC|hash tables]] are a much superior choice.

{{mirc title|mSL Injection}} ...y to dynamically evaluate code on the run. With mSLs powerful commands and identifiers, the result of a code injection attack can be disastrous. It is important t

{{mirc title|/aline Command}} <syntaxhighlight lang="mIRC">Alias Example {

{{mirc title|/bcopy Command}} <syntaxhighlight lang="mIRC">Alias Example {

{{mirc title|/beep Command}} * '''[number]''' - Number of beeps, default to 3 if not specified.

{{mirc title|/bset Command}} <syntaxhighlight lang="mIRC">Alias Example {

{{mirc title|/bwrite Command}} * '''-t''' - Treats everything as plain text (i.e. $identifiers and %variables (but not contents of %variables) are evaluated, but binary v

{{mirc title|/comopen Command}} ...programmatic identifier with the assigned name. Your script should check {{mIRC|$comerr}} after opening the connection to make sure the connection was esta

{{mirc title|Introduction}} ...ence is people with no knowledge, or very limited knowledge, of the [[mirc|mIRC scripting language]].

{{mirc title|/dialog Command}} ...ot return a value when the dialog closes. As a result it does not halt the mIRC scripting engine, letting other script to keep processing. Dialogs can be k

{{mirc title|/did Command}} ...o change multiple ids at once, 1-5,6,9 would change the following ids: 1,2,3,4,5,6,9

{{mirc title|/window Command}} ...to create [[Custom Windows - mIRC|custom windows]] and [[Picture Windows - mIRC|picture windows]] (using the -p switch), or to manipulate an existing custo

{{mirc title|/while Command}} The '''/while command''' is a [[While Loops - mIRC|construct in the mIRC scripting language]] that can perform repetitive operations. The block of s

{{mirc title|/echo Command}} * '''-r''' - Applies the strip settings to the text (as defined in mIRC Options / IRC / Messages).

{{mirc title|/flush Command}} ...on is removed from the remote user list. If you do not specify levels then mIRC clears all nicks from the remote user list that do not exist on channels yo

{{mirc title|/var Command}} ...ault /var creates local variable, this can be changed via the -g switch ({{mIRC|/set}} command can be used to set global variables by default).

{{mirc title|/inc Command}} ...numeric value of a variable by a given value. If [value] is not specified, mIRC will increase the variable by one. The /inc command works with both positiv

{{mirc title|/maxdepth Command}} <syntaxhighlight lang="mIRC">example {

{{mirc title|/goto Command}} ...within the same event, alias, or menu. The label must have been parsed by mIRC previously inside that event/alias/menu or the label is considered undefine

{{mirc title|/haltdef Command}} ...only have an effect inside an event using the '^' prefix, and will prevent mIRC from performing his default action.

{{mirc title|/msg Command}} ...specific channel or person. Many networks support multi-target messages - mIRC will not display the message in all the targets like it would with individu

{{mirc title|/scon Command}} ...will continue to execute on that connection. When a command is specified, mIRC will execute the command on the specified connection or connections based o

{{mirc title|/set Command}} ...and, set cannot assign a value to multiple variables at once. It support {{mirc|variables#Math_Operations|one math operation}}.

{{mirc title|/timer Command}} * '''[time]''' - Time to activate the timer, for example '15:30' for 3:30PM

{{mirc title|/tokenize Command}} ...ommand replaces the existing $0 through $N'th tokens, filling $1 $2 ... $N identifiers with portions of a string, divided into tokens based on the location of the

{{mirc title|/unset Command}} ...''/unset command''' removes any variables by their specified names. If a {{mirc|wildcard}} pattern was specified, all variables matching that pattern will

{{mirc title|Evaluation Brackets}} ...are a mechanism by which a program can alter the natural behavior of the [[mIRC]] [[interpreter]].

{{mirc title|Component Object Model}} ...specification will be able to use it. mSL offers a variety of commands and identifiers to handle COM objects.

{{mirc title|/dline Command}} <syntaxhighlight lang="mIRC">Alias Example {

{{mirc title|Picture Windows}} ...|commands]], [[list of identifiers - mIRC|identifiers]], and [[on events - mIRC|events]] for manipulating them. Picture windows provide an alternative mean

{{mirc title|$dialog Identifier}} ...sed as an identifier in order to get properties for a specific [[Dialogs - mIRC|dialog window]].

{{mirc title|$? Identifier}}{{Deprecated feature|new={{mIRC|$input}}}} <source lang="mIRC">

{{mirc title|Dialogs}} ...inside of mIRC. The {{mIRC|/dialog}} command opens new dialogs, and the {{mIRC|dialog components}} are the objects within the dialog, such as buttons, lab

{{mirc title|$did Identifier}}The '''$did''' identifier allows you to get the sett ...RC|alias]] called ''/whatEvents'' which will open up the local [[Dialogs - mIRC|dialog]] ''whatEvents'':

{{mirc title|/updatenl Command}} <syntaxhighlight lang="mIRC">on !*:part:#example:{

{{mirc title|/iline Command}} <syntaxhighlight lang="mIRC">Alias Example {

{{mirc title|/scid Command}} ...will continue to execute on that connection. When a command is specified, mIRC will execute the command on the connection specified by the Connection ID o

{{mirc title|$vcmd Identifier}}The '''$vcmd''' identifier is used to retrieve comm <pre>//echo -a $vcmd(3)</pre>

...'' can be used to get the current status of the voice command listener for mIRC. <span style="display: inline-block; width: 30px;">'''3'''</span>Service is on, and listening for commands.

{{mirc title|$alias Identifier}}'''$alias''' can be used to return the filename of <pre>//echo -a $alias(3)</pre>

{{mirc title|$bytes Identifier}}'''$bytes''' allows you to format a number of byte * '''3''' - Returns the result in 3-digit format.

...ier}}'''$calc''' can be used to perform mathematical calculations from the mIRC editbox line, or from inside of a custom script. The accuracy of results is ...' can also be used to calculate variables in mIRC, as well as other custom identifiers that return numerical values.

...r}}'''=$nick''' is a special identifier. Inside the {{mIRC|on chat}} and {{mIRC|on serv}} events, if you want to send a message to the dcc chat/serv window <source lang="mIRC">; Event messages a user back inside of a DCC Chat

...returns the target of an event. For instance, when a window closes, the {{mIRC|on close}} event triggers and '''$target''' is filled with the window name <source lang="mIRC">; When any window is closed, echo the window name

{{mirc title|On Dialog - Events}} ...''' event listens for events which take place inside of custom [[Dialogs - mIRC|dialog windows]].

{{mirc title|On Keydown - Events}} ...triggered when a key is pressed down inside of a custom [[custom windows - mIRC|@window]].

...s the key code of the key being pressed inside an {{mIRC|on keydown}} or {{mIRC|on keyup}} event. ...is incorrect, inside {{mirc|on char}}, it only makes sense to check for {{mirc|$keychar}}

...during an {{mirc|on keydown}}, or an {{mirc|on keyup}} event inside of a {{mirc|custom windows|custom @window}}, it returns $true if the key is held down, Create an alias that launches a custom, [[Picture Windows - mIRC|picture window]] which listens for key presses and displays the key value p

...rc|on keydown}}, {{mirc|on keyup}} or {{mIRC|on char}} event inside of a {{mirc|custom windows|custom @window}}, it returns the characters that was inputte ...' This identifier is broken by design inside the {{mirc|on keydown}} and {{mirc|on keyup}} events.

{{mirc title|On Keyup - Events}} ...en a key has been pressed, but subsequently released, inside of a custom {{mirc|custom windows|@window}}.

{{mirc title|/sockread Command}} ...only understands {{mIRC|$lf}} terminated line (any {{mirc|$cr}} before a {{mirc|$lf}} is removed).

...fier can be used to gather various details regarding open [[/dcc command - mIRC|DCC Chat]] windows. | stamp | Returns either {{mIRC|$true}}, or {{mIRC|$false}} depending on if time-stamping is enabled or disabled.

...fier can be used to gather various details regarding open [[/dcc command - mIRC|DCC Get]] windows, even if the transfers completed. ...ges nick, the $get is still associated with the old nick unless you use: {{mIRC|/dcc|/dcc nick -sgcf <oldnick> <newnick>}}

{{mirc title|$count Identifier}}The '''$count''' identifier allows mIRC to return the total count of a matching substring, or set of substrings to <source lang="mIRC">//echo -a Result: $count(My string to match,str)</source>

{{mirc title|/toolbar Command}} ...uch as Connect, Notify, etc. may not always work since they are managed by mIRC. They can however be deleted.

{{mirc title|File Handling}}'''File Handling''' allows you to manipulate files on ...u must be familiar with text file operations such as {{mIRC|/write}} and {{mIRC|$read}}.

{{mirc title|RegEx}} mIRC uses the 8bits version of [[PCRE library]] to implement regex with the foll

{{mirc title|Unicode}} This page does not attempt to describe what [[Unicode]] is but rather how mIRC handles it (or in some cases doesn't handle it). The technical terms are om

{{mirc title|$* Identifier}}'''$*''' is a construct, not an identifier, it allows <syntaxhighlight lang="mIRC">var %list a b c d,%a 1

{{mirc title|$address Identifier}}'''$address''' return the address of the user as '''Note''': $address returns $null string if the {{mIRC|$ial}} doesn't contain the address for this nick.

{{mirc title|$channel Identifier}}{{Deprecated feature|new={{mIRC|$chan}}}}'''$channel''' returns informations about channels. See {{mIRC|$chan}} for more informations.

{{mirc title|$sockerr identifier}}'''$sockerr''' returns the sock error number if * 3: failure establishing socket connection (W)

{{mirc title|Optimization}} mIRC Script Language is an interpreted language - which means that mIRC has to work out what each statement means each and every time it is execute

{{mirc title|On Parseline - Events}} ...ctcp}} also uses PRIVMSG with a special encoding to indicate it is CTCP. {{mIRC|/me}} action messages are a specific type of CTCP message etc. '''''Use of

{{mirc title|$gettok Identifier}} '''C:''' - The {{mIRC|$asc|$asc()}} value which splits TEXT into tokens<br />

{{mirc title|$len Identifier}}'''$len(text)''' returns the number of characters in <source lang="mIRC">

{{mirc title|$numtok identifier}}'''$numtok''' returns the number of $asc(C)-delim '''C:''' - The {{mIRC|$asc|$asc()}} value which splits LIST into tokens<br />

{{mirc title|$puttok identifier}}'''$puttok''' replaces the Nth $asc(C)-delimited '''C:''' - The {{mIRC|$asc|$asc()}} value which splits TEXT into tokens<br />

{{mirc title|$hypot Identifier}}'''$hypot''' returns the hypotenuse for the other <source lang="mIRC">$hypot(<A>,<B>)</source>

{{mirc title|$atan Identifier}}'''$atan''' returns the arctangent of N. ...triangle where opposite side is 3 and adjacent is 4, angle is $atan( $calc(3/4) ).deg degrees

{{mirc title|$biton Identifier}}'''$biton''' returns N with the Bth bit set to 1. <pre>//var %n 10 | echo -a $biton(%n,3)

{{mirc title|$rgb Identifier}}'''$rgb''' converts between R,G,B vs color-number, o ;Method#3 - Return RGB Color Number for System Color Settings

{{mirc title|$compress Identifier}} ...ression method N, where N = 1 is raw, N = 2 is zlib (the default), and N = 3 is gzip. (0 uses default m2, invalid 4+ uses m3)

{{mirc title|$sqrt identifier}}'''$sqrt''' returns the square root. <source lang="mIRC">$sqrt(<N>)</source>

{{mirc title|$str identifier}}'''$str''' duplicates the specified text string n ti <source lang="mIRC">

{{mirc title|$strip identifier}}'''$strip''' removes colors and/or other control-c | c | Colors $chr(3) followed by N[,N]

{{mirc title|$uptime identifier}}'''$uptime''' returns the number of milliseconds <pre>$uptime(<mirc> | <server> | <system>[,N])</pre>

{{mirc title|$envvar Identifier}} ...returns the value of the 3rd variable not the value of the variable named 3.

{{mirc title|$bitoff identifier}}'''$bitoff''' returns N with the Bth bit set to 0 The /window switch -wN uses bit settings, with default 3 if N not used.

{{mirc title|$log identifier}}'''$log''' returns the natural logarithm (base e) of There may be a rounding error due to mIRC preserving fractional digits to only 6 places.

{{mirc title|$file Identifier}}'''$file''' can be used in two ways: ...recated syntax, display the select file dialog, {{Deprecated feature|new={{mIRC|$sfile}}}}

{{mirc title|$style Identifier}}'''$style''' can be used inside menu definition to * '''N''' - use N = 1 for checked, N = 2 for disabled and N = 3 for both

{{mirc title|$gettok Identifier}}{{Deprecated feature|new={{mIRC|$gettok}}}}'''$token''' returns the Nth $asc(C)-delimited token from a list '''C:''' - The {{mIRC|$asc|$asc()}} value which splits TEXT into tokens<br />

{{mirc title|$tip Identifier}}'''$tip''' Allows you to create scripted tips that a * '''delay''' - The duration of the tip, betwee, 3 and 60

{{mirc title|$fline Identifier}}'''$fline''' returns the number of the Nth line ma * '''expr''' - the expression to search, {{mirc|wildcard}} by default

{{mirc title|$window Identifier}}'''$window''' returns information about the speci <source lang="mIRC">$window(N/name)

{{mirc title|$bvar Identifier}}'''$bvar''' returns the contents of a binary variab <source lang="mIRC">//bset &abc 1 12 34 56 78 | echo -a $iif($bvar(&abc),$v1 exists) $iif($bva

{{mirc title|$iif Identifier}}'''$iif''' returns a conditional value depending on <source lang="mIRC">

{{mirc title|$hget identifier}}'''$hget''' returns informations about hash tables <source lang="mIRC">

{{mirc title|$mask Identifier}}'''$mask''' returns the address with a mask of the ** 3: *!*user@*.host

{{mirc title|$hash Identifier}} <source lang="mIRC">//echo -a The hash is $hash(test,32)

{{mirc title|$msfile Identifier}}'''$msfile''' Opens dialog to select 1 or more fi ...e editbox until the next time any of these 3 commands are used, when these identifiers are replaced by the new results. (Using $msfile(N) does not reset $sfstate)

{{mirc title|Binary Variables}} '''Binary variables''' are a special storage offered by mIRC that can hold an array of bytes of arbitrary length.

...ls. $hmac is used to provide the security strength for the $hotp and $totp identifiers. <source lang="mIRC">

{{mirc title|$read Identifier}}The '''$read''' returns a line from a disk file <source lang="mIRC">$read(filename [,ntswrp] [,matchtext] [,N])</source>

{{mirc title|$submenu Identifier}}'''$submenu''' can be used in popups definition ...dentifier called by mIRC, the parameter passed to it is always $1, used by mIRC to pass information to your identifier.

{{mirc title|$regerrstr Identifier}}'''$regerrstr''' returns the PCRE error string * 3: unrecognized character follows \

{{mirc title|$com Identifier}}'''$com''' calls a member of an open COM connection | 3 || (1+2) Call a member and return a value *

{{mirc title|$comcall Identifier}}'''$comcall''' calls a member of an open COM con ..., this means that the object is not compatible with the threading model of mIRC, so $com() must be used. You can check the $comerr value in the alias to de

{{mirc title|$urlget identifier}}'''$urlget''' sends a HEAD/GET/POST/PUT/PATCH/DEL <source lang="mIRC">

{{mirc title|Line Lenght Limit}} The mIRC scripting language works using instructions/commands/statement, each comman

{{mirc title|On Char - Events}} ...er results from pressing one or more inside of a custom [[custom windows - mIRC|@window]].

{{mirc title|$codepage Identifier}}The '''$codepage''' identifier allows you to li <source lang="mIRC">//var %a 1 | while ($codepage(%a)) { echo -sg $v1 -- $codepage(%a).name --

{{mirc title|$powmod identifier}}'''$powmod''' performs integer exponentiation ove * While most math identifiers support numbers as large as 2^53, care should be used for this function if

{{mirc title|/bigfloat Command}} ...force the script in/out of bigfloat mode, where operation of several math identifiers, commands etc are affected.