Scriptwiki - User contributions [en]

Tips

2008-04-22T22:52:04Z

Doomie:

Toggles tips on or off.
/tips [on|off]
'''Note:''' Using /tips with no parameters will return whether tips are currently on or off.

[[Category:Tips]]

Category:Tips

2008-04-22T22:51:31Z

Doomie:

Tips

Tip

2008-04-22T22:51:19Z

Doomie:

Edits an open tip.
/tip <-ct> <name> [text]
<name> refers to the name of the tip.

=== Switches ===

* -c - Closes the tip.
* -t - Changes the tip's text. [text] must be included.
'''Note:''' At least one switch must be specified.

== See Also ==

* [[tips|/tips]] - Toggles tips on or off.

[[Category:Tips]]

Clear-Chanlev Script for QuakeNet

2008-04-12T14:02:45Z

Doomie:

; ClearChanlev script by doomie
; #help.script @ QuakeNet
;
;
; You can use this script by typing:
;
; /clearchanlev [-c|-r] #channel
;
; Note, that you must be authed and owner of #channel.
;
; Flags:
; * -r ... Resets the script, i.e. cleans everything up. One usually doesn't need that flag, however, if something didn't work,
; one can use it.
; * -c ... If you use this flag, the script will remove you from the channel aswell. This means, that Q will leave the channel
; completly. Note that you can _NOT_ reverse it!
;
;
; Example output:
;
; ClearChanlev: -----------------------------
; ClearChanlev: Now beginning to remove all chanlevs from channel #channel except yours!
; ClearChanlev: Receiving own auth now!
; ClearChanlev: ...done.
; ClearChanlev: Saving chanlev now...
; ClearChanlev: ...done.
; ClearChanlev: There are 2 lines to send. This will take approximatly 4 seconds. Removing...
; ClearChanlev: ...done.
; ClearChanlev: Cleaned up!
; ClearChanlev: -----------------------------
;

; Returns the milliseconds between every message sent to Q
; If you excess flood, you should increase this value to 4000 or even 5000.
[[alias]] -l ClearChanlev.Delay { [[return]] 3000 }

; $1 = #channel
;
; flags:
; -c --complete = deletes the complete chanlev, inclusive owner. This will
; result in Q parting.
; -r --reset = resets the scripts in case something didn't work the last time.
alias ClearChanlev {
[[echo]] -s ClearChanlev: -----------------------------
[[var]] %i = 1, %c, %ClearChanlev.Complete = 0, %r, %ClearChanlev.Force = 0, %ClearChanlev.Channel
[[While loops|while]] (%i [[If#.3C.3D|<=]] [[$0]]) {
%c = $ [[Evaluation_brackets|[]] [[DollarPlus|$+]] [[Evaluation_brackets|[]] %i [[Evaluation_brackets|] ]]]
[[if]] (%c [[If#.3D.3D|==]] -c) [[If#Combining_comparisons|||]] (%c == --complete) {
%ClearChanlev.Complete = 1
}
elseif (%c == -r) || (%c == --reset) {
%ClearChanlev.Force = 1
}
elseif ([[$left]](%c, 1) == [[$chr]](35)) {
%ClearChanlev.Channel = %c
}
[[inc]] %i
}
if (%ClearChanlev.Global) {
if (%ClearChanlev.Force == 0) {
echo -s ClearChanlev: ClearChanlev is currently running. If this is not the case, please use the -r flag (i.e. /clearchanlev -r #channel)
echo -s ClearChanlev: -----------------------------
return
}
else {
[[unset]] %ClearChanlev.Global
echo -s ClearChanlev: ClearChanlev reseted.
}
}
if (!%ClearChanlev.Channel) {
echo -s ClearChanlev: No channel specified.
return
}
%r = [[$rand]](1,1000)
[[set]] %ClearChanlev.Global %ClearChanlev.Channel %ClearChanlev.Complete %r
echo -s ClearChanlev: Now beginning to remove all chanlevs from channel %ClearChanlev.Channel [[$iif]](%ClearChanlev.Complete, inclusive, except) yours!
echo -s ClearChanlev: Receiving own auth now!
.[[timer]]ClearChanlevCleanUp 1 60 ClearChanlev.CleanUp
.[[who]] [[$me]] n%nat, $+ %r
}

[[:Category:Raws|raw]] [[Raw_354|354]]:*: {
if ([[$1-|$2]] == [[$gettok]](%ClearChanlev.Global, 3, 32)) && ($3 == $me) {
haltdef
set %ClearChanlev.Global %ClearChanlev.Global $4
}
}

raw [[Raw_315|315]]:*: {
if (%ClearChanlev.Global) && ($2 == $me) {
[[haltdef]]
if ($gettok(%ClearChanlev.Global, 4, 32) == 0) {
echo -s ClearChanlev: You are NOT authed.
ClearChanlev.CleanUp
}
else {
echo -s ClearChanlev: ...done.
set %ClearChanlev.Global %ClearChanlev.Global 0
.[[msg]] Q chanlev $gettok(%ClearChanlev.Global, 1, 32)
}
}
}

alias -l ClearChanlev.GotMessages {
if (![[$exists]](ClearChanlev $+ $gettok(%ClearChanlev.Global, 3, 32) $+ .txt)) {
echo -s ClearChanlev: File does not exist!
ClearChanlev.CleanUp
return
}
if ([[$lines]](ClearChanlev $+ $gettok(%ClearChanlev.Global, 3, 32) $+ .txt) == 0) {
echo -s ClearChanlev: No chanlev to remove!
ClearChanlev.CleanUp
return
}
if ($gettok(%ClearChanlev.Global, 5, 32) == 0) {
echo -s ClearChanlev: You are NOT owner of this channel. Aborting!
ClearChanlev.CleanUp
return
}
echo -s ClearChanlev: There are $lines(ClearChanlev $+ $gettok(%ClearChanlev.Global, 3, 32) $+ .txt) lines to send. This will take [[$&]]
approximatly $calc($lines(ClearChanlev $+ $gettok(%ClearChanlev.Global, 3, 32) $+ .txt) * $ClearChanlev.Delay / 1000) seconds. Removing...
.[[play]] Q ClearChanlev $+ $gettok(%ClearChanlev.Global, 3, 32) $+ .txt $ClearChanlev.Delay
}

alias -l ClearChanlev.CleanUp {
.[[remove]] ClearChanlev $+ $gettok(%ClearChanlev.Global, 3, 32) $+ .txt
unset %ClearChanlev.*
.timerClearChanlevCleanUp off
echo -s ClearChanlev: Cleaned up!
echo -s ClearChanlev: -----------------------------
}

; $1- = message from Q
alias -l ClearChanlev.Interpret {
if (%ClearChanlev.Global) {
if (Username*Flags*Last join*Last changed iswm $1-) {
echo -s ClearChanlev: Saving chanlev now...
set %ClearChanlev.Global %ClearChanlev.Global 1
}
elseif (You do not have sufficient access on* iswm $1-) {
echo -s ClearChanlev: You do not have sufficied access on the specified channel!
ClearChanlev.CleanUp
}
elseif (End of list. == $1-) {
echo -s ClearChanlev: ...done.
set %ClearChanlev.Global [[$puttok]](%ClearChanlev.Global, 0, 6, 32)
if ([[$numtok]](%ClearChanLev.Users,32)) {
[[write]] -il1 ClearChanlev $+ $gettok(%ClearChanlev.Global, 3, 32) $+ .txt REMOVEUSER $gettok(%ClearChanlev.Global, 1, 32) %ClearChanLev.Users
unset %ClearChanlev.Users
}
ClearChanlev.GotMessages
}
elseif (Channel * is unknown or suspended. iswm $1-) {
echo -s ClearChanlev: Channel is not known or suspended. Aborting.
ClearChanlev.CleanUp
}
elseif ($gettok(%ClearChanlev.Global, 6, 32) == 1) {
if ($1 == $gettok(%ClearChanlev.Global, 4, 32)) {
if (n !isin $2) {
set %ClearChanlev.Global $puttok(%ClearChanlev.Global, 0, 5, 32)
return
}
else {
set %ClearChanlev.Global $puttok(%ClearChanlev.Global, 1, 5, 32)
}

if ($gettok(%ClearChanlev.Global, 2, 32) == 0) {
return
}
else {
write ClearChanlev $+ $gettok(%ClearChanlev.Global, 3, 32) $+ .txt CHANLEV $gettok(%ClearChanlev.Global, 1, 32) $chr(35) $+ $1 [[$replace]]($2,+,-)
return
}
}
else {
if (n isin $2) {
write -il1 ClearChanlev $+ $gettok(%ClearChanlev.Global, 3, 32) $+ .txt CHANLEV $gettok(%ClearChanlev.Global, 1, 32) $chr(35) $+ $1 $replace($2,+,-)
}
else {
set %ClearChanlev.Users $addtok(%ClearChanLev.users,$chr(35) $+ $1,32)
if ($numtok(%ClearChanlev.Users,32) == 18) {
write -il1 ClearChanlev $+ $gettok(%ClearChanlev.Global, 3, 32) $+ .txt REMOVEUSER $gettok(%ClearChanlev.Global, 1, 32) %ClearChanlev.Users
unset %ClearChanlev.Users
}
}
}
}
}
}

on ^*:[[On_notice|Notice]]:*:?: {
if ([[$nick]] == Q) && (%ClearChanlev.Global) {
haltdef
ClearChanlev.Interpret $1-
}
}

on ^*:[[On_text|Text]]:*:?: {
if ($nick == Q) && (%ClearChanlev.Global) {
haltdef
ClearChanlev.Interpret $1-
}
}

on *:[[On_playend|PLAYEND]]:{
if ([[$nopath]]([[$filename]]) == ClearChanlev $+ $gettok(%ClearChanlev.Global, 3, 32) $+ .txt) {
echo -s ClearChanlev: ...done.
ClearChanlev.Cleanup
}
}
[[Category:Script Archive]]
{{Author|Doomie}}

Clear-Chanlev Script for QuakeNet

2008-04-12T13:27:11Z

Doomie: added -il1 to fix the order of the commands to send

; ClearChanlev script by doomie
; #help.script @ QuakeNet
;
;
; You can use this script by typing:
;
; /clearchanlev [-c|-r] #channel
;
; Note, that you must be authed and owner of #channel.
;
; Flags:
; * -r ... Resets the script, i.e. cleans everything up. One usually doesn't need that flag, however, if something didn't work,
; one can use it.
; * -c ... If you use this flag, the script will remove you from the channel aswell. This means, that Q will leave the channel
; completly. Note that you can _NOT_ reverse it!
;
;
; Example output:
;
; ClearChanlev: -----------------------------
; ClearChanlev: Now beginning to remove all chanlevs from channel #channel except yours!
; ClearChanlev: Receiving own auth now!
; ClearChanlev: ...done.
; ClearChanlev: Saving chanlev now...
; ClearChanlev: ...done.
; ClearChanlev: There are 2 lines to send. This will take approximatly 4 seconds. Removing...
; ClearChanlev: ...done.
; ClearChanlev: Cleaned up!
; ClearChanlev: -----------------------------
;

; Returns the milliseconds between every message sent to Q
; If you excess flood, you should increase this value to 4000 or even 5000.
[[alias]] -l ClearChanlev.Delay { [[return]] 3000 }

; $1 = #channel
;
; flags:
; -c --complete = deletes the complete chanlev, inclusive owner. This will
; result in Q parting.
; -r --reset = resets the scripts in case something didn't work the last time.
alias ClearChanlev {
[[echo]] -s ClearChanlev: -----------------------------
[[var]] %i = 1, %c, %ClearChanlev.Complete = 0, %r, %ClearChanlev.Force = 0, %ClearChanlev.Channel
[[While loops|while]] (%i [[If#.3C.3D|<=]] [[$0]]) {
%c = $ [[Evaluation_brackets|[]] [[DollarPlus|$+]] [[Evaluation_brackets|[]] %i [[Evaluation_brackets|] ]]]
[[if]] (%c [[If#.3D.3D|==]] -c) [[If#Combining_comparisons|||]] (%c == --complete) {
%ClearChanlev.Complete = 1
}
elseif (%c == -r) || (%c == --reset) {
%ClearChanlev.Force = 1
}
elseif ([[$left]](%c, 1) == [[$chr]](35)) {
%ClearChanlev.Channel = %c
}
[[inc]] %i
}
if (%ClearChanlev.Global) {
if (%ClearChanlev.Force == 0) {
echo -s ClearChanlev: ClearChanlev is currently running. If this is not the case, please use the -r flag (i.e. /clearchanlev -r #channel)
echo -s ClearChanlev: -----------------------------
return
}
else {
[[unset]] %ClearChanlev.Global
echo -s ClearChanlev: ClearChanlev reseted.
}
}
if (!%ClearChanlev.Channel) {
echo -s ClearChanlev: No channel specified.
return
}
%r = [[$rand]](1,1000)
[[set]] %ClearChanlev.Global %ClearChanlev.Channel %ClearChanlev.Complete %r
echo -s ClearChanlev: Now beginning to remove all chanlevs from channel %ClearChanlev.Channel [[$iif]](%ClearChanlev.Complete, inclusive, except) yours!
echo -s ClearChanlev: Receiving own auth now!
.[[timer]]ClearChanlevCleanUp 1 60 ClearChanlev.CleanUp
.[[who]] [[$me]] n%nat, $+ %r
}

[[:Category:Raws|raw]] [[Raw_354|354]]:*: {
if ([[$1-|$2]] == [[$gettok]](%ClearChanlev.Global, 3, 32)) && ($3 == $me) {
haltdef
set %ClearChanlev.Global %ClearChanlev.Global $4
}
}

raw [[Raw_315|315]]:*: {
if (%ClearChanlev.Global) && ($2 == $me) {
[[haltdef]]
if ($gettok(%ClearChanlev.Global, 4, 32) == 0) {
echo -s ClearChanlev: You are NOT authed.
ClearChanlev.CleanUp
}
else {
echo -s ClearChanlev: ...done.
set %ClearChanlev.Global %ClearChanlev.Global 0
.[[msg]] Q chanlev $gettok(%ClearChanlev.Global, 1, 32)
}
}
}

alias -l ClearChanlev.GotMessages {
if (![[$exists]](ClearChanlev $+ $gettok(%ClearChanlev.Global, 3, 32) $+ .txt)) {
echo -s ClearChanlev: File does not exist!
ClearChanlev.CleanUp
return
}
if ([[$lines]](ClearChanlev $+ $gettok(%ClearChanlev.Global, 3, 32) $+ .txt) == 0) {
echo -s ClearChanlev: No chanlev to remove!
ClearChanlev.CleanUp
return
}
if ($gettok(%ClearChanlev.Global, 5, 32) == 0) {
echo -s ClearChanlev: You are NOT owner of this channel. Aborting!
ClearChanlev.CleanUp
return
}
echo -s ClearChanlev: There are $lines(ClearChanlev $+ $gettok(%ClearChanlev.Global, 3, 32) $+ .txt) lines to send. This will take [[$&]]
approximatly $calc($lines(ClearChanlev $+ $gettok(%ClearChanlev.Global, 3, 32) $+ .txt) * $ClearChanlev.Delay / 1000) seconds. Removing...
.[[play]] Q ClearChanlev $+ $gettok(%ClearChanlev.Global, 3, 32) $+ .txt $ClearChanlev.Delay
}

alias -l ClearChanlev.CleanUp {
.[[remove]] ClearChanlev $+ $gettok(%ClearChanlev.Global, 3, 32) $+ .txt
unset %ClearChanlev.*
.timerClearChanlevCleanUp off
echo -s ClearChanlev: Cleaned up!
echo -s ClearChanlev: -----------------------------
}

; $1- = message from Q
alias -l ClearChanlev.Interpret {
if (%ClearChanlev.Global) {
if (Username*Flags*Last join*Last changed iswm $1-) {
echo -s ClearChanlev: Saving chanlev now...
set %ClearChanlev.Global %ClearChanlev.Global 1
}
elseif (You do not have sufficient access on* iswm $1-) {
echo -s ClearChanlev: You do not have sufficied access on the specified channel!
ClearChanlev.CleanUp
}
elseif (End of list. == $1-) {
echo -s ClearChanlev: ...done.
set %ClearChanlev.Global [[$puttok]](%ClearChanlev.Global, 0, 6, 32)
if ([[$numtok]](%ClearChanLev.Users,32)) {
[[write]] ClearChanlev $+ $gettok(%ClearChanlev.Global, 3, 32) $+ .txt REMOVEUSER $gettok(%ClearChanlev.Global, 1, 32) %ClearChanLev.Users
unset %ClearChanlev.Users
}
ClearChanlev.GotMessages
}
elseif (Channel * is unknown or suspended. iswm $1-) {
echo -s ClearChanlev: Channel is not known or suspended. Aborting.
ClearChanlev.CleanUp
}
elseif ($gettok(%ClearChanlev.Global, 6, 32) == 1) {
if ($1 == $gettok(%ClearChanlev.Global, 4, 32)) {
if (n !isin $2) {
set %ClearChanlev.Global $puttok(%ClearChanlev.Global, 0, 5, 32)
return
}
else {
set %ClearChanlev.Global $puttok(%ClearChanlev.Global, 1, 5, 32)
}

if ($gettok(%ClearChanlev.Global, 2, 32) == 0) {
return
}
else {
write ClearChanlev $+ $gettok(%ClearChanlev.Global, 3, 32) $+ .txt CHANLEV $gettok(%ClearChanlev.Global, 1, 32) $chr(35) $+ $1 [[$replace]]($2,+,-)
return
}
}
else {
if (n isin $2) {
write -il1 ClearChanlev $+ $gettok(%ClearChanlev.Global, 3, 32) $+ .txt CHANLEV $gettok(%ClearChanlev.Global, 1, 32) $chr(35) $+ $1 $replace($2,+,-)
}
else {
set %ClearChanlev.Users $addtok(%ClearChanLev.users,$chr(35) $+ $1,32)
if ($numtok(%ClearChanlev.Users,32) == 18) {
write -il1 ClearChanlev $+ $gettok(%ClearChanlev.Global, 3, 32) $+ .txt REMOVEUSER $gettok(%ClearChanlev.Global, 1, 32) %ClearChanlev.Users
unset %ClearChanlev.Users
}
}
}
}
}
}

on ^*:[[On_notice|Notice]]:*:?: {
if ([[$nick]] == Q) && (%ClearChanlev.Global) {
haltdef
ClearChanlev.Interpret $1-
}
}

on ^*:[[On_text|Text]]:*:?: {
if ($nick == Q) && (%ClearChanlev.Global) {
haltdef
ClearChanlev.Interpret $1-
}
}

on *:[[On_playend|PLAYEND]]:{
if ([[$nopath]]([[$filename]]) == ClearChanlev $+ $gettok(%ClearChanlev.Global, 3, 32) $+ .txt) {
echo -s ClearChanlev: ...done.
ClearChanlev.Cleanup
}
}
[[Category:Script Archive]]
{{Author|Doomie}}

Challenge auth

2008-03-24T14:07:10Z

Doomie:

; by doomie @ QuakeNet
; channel: #help.script
; written and tested on mIRC 6.31
;
; What does this script do?
;
; auths with Q using the 'CHALLENGEAUTH' command
;
; How to use this script?
;
; if you want to auth, just type: /challengeauth
; However, you need to have the SHA2.dll by slug, which can be downloaded here:
; http://www.quakenet.org/development/challengeauth/SHA2.dll
; A general explanation can be found here:
; http://www.quakenet.org/development/challengeauth/

; CONFIGURE

; $1 = dll function
; $2 = parameter for the dll function
alias -l ChallengeAuth.PathToDll { return $mircdirSHA2.dll }

; DONT CHANGE ANYTHING UNDER THIS LINE UNLESS YOU KNOW WHAT YOU ARE DOING
alias -l ChallengeAuth.Q { return Q@CServe.quakenet.org }
alias -l ChallengeAuth.DLL { return $dll($ChallengeAuth.PathToDll,$1,$2) }

; $1 = string to lower
alias -l ChallengeAuth.IRCToLower {
return $replacex($lower($1),$chr(91),$chr(123),$chr(93),$chr(125),$chr(92),$chr(124),$chr(94),$chr(126))
}

; $1 = Challenge
alias -l ChallengeAuth.Auth {
var %ChallengeAuth.Username = $ChallengeAuth.IRCToLower($?="Username")
if ($len(%ChallengeAuth.Username) == 0) {
echo -s ChallengeAuth: No Username specified.
return
}

var %ChallengeAuth.Password = $left($?*="Password",10)
if ($len(%ChallengeAuth.Password) == 0) {
echo -s ChallengeAuth: No Password specified.
return
}

var %ChallengeAuth.PasswordHash = $ChallengeAuth.DLL(sha256_hex, %ChallengeAuth.Password)
var %ChallengeAuth.Key = $ChallengeAuth.DLL(sha256_hex, %ChallengeAuth.Username $+ : $+ %ChallengeAuth.PasswordHash)
var %ChallengeAuth.Response = $ChallengeAuth.DLL(hmac_sha256, %ChallengeAuth.Key $1)
!.msg $ChallengeAuth.Q CHALLENGEAUTH %ChallengeAuth.Username %ChallengeAuth.Response HMAC-SHA-256
}

alias ChallengeAuth {
if (!$isfile($ChallengeAuth.PathToDll)) {
echo -s ChallengeAuth: The path to your SHA2.dll is wrong. Please configure the challengeauth script correctly and/or download the dll from
echo -s ChallengeAuth: http://www.quakenet.org/development/challengeauth/SHA2.dll
return
}
set %ChallengeAuth.Active $true
echo -s ChallengeAuth: ChallengeAuth is beginning.
!.msg $ChallengeAuth.Q challenge
}

on ^*:NOTICE:*:*: {
if ($fulladdress === Q!TheQBot@CServe.quakenet.org) && ($network === QuakeNet) && ($right($server, 13) === .quakenet.org) {
if ($1 === CHALLENGE) && ($len($2) == 32) && (%ChallengeAuth.Active) {
if ($istok($3-, HMAC-SHA-256, 32)) {
.timer 1 0 ChallengeAuth.Auth $2
}
else {
echo -s ChallengeAuth: HMAC-SHA-256 is not supported. ChallengeAuth is NOT continuing.
}
}
elseif ($1- == CHALLENGE is not available once you have authed.) && (%ChallengeAuth.Active) {
echo -s ChallengeAuth: You are already authed!
unset %ChallengeAuth.Active
}
elseif ($1-6 == You are now logged in as) && (%ChallengeAuth.Active) {
echo -s ChallengeAuth: You are now authed!
unset %ChallengeAuth.Active
}
elseif ($1- == Username or password incorrect.) && (%ChallengeAuth.Active) {
echo -s ChallengeAuth: Username or password incorrect.
unset %ChallengeAuth.Active
}
}
}

raw 401:*: {
if ($1- == $me $ChallengeAuth.Q No such nick) && (%ChallengeAuth.Active) {
echo -s ChallengeAuth: Q is currently not reachable. Please try again later.
unset %ChallengeAuth.Active
haltdef
}
}

Challenge auth

2008-03-23T12:50:59Z

Doomie: parts were missing.

; by doomie @ QuakeNet
; channel: #help.script
; written and tested on mIRC 6.31
;
; What does this script do?
;
; auths with Q using the 'CHALLENGEAUTH' command
;
; How to use this script?
;
; if you want to auth, just type: /challengeauth
; However, you need to have the SHA2.dll by slug, which can be downloaded here:
; http://www.quakenet.org/development/challengeauth/SHA2.dll
; A general explanation can be found here:
; http://www.quakenet.org/development/challengeauth/

; CONFIGURE

; $1 = dll function
; $2 = parameter for the dll function
alias -l ChallengeAuth.PathToDll { return $mircdirSHA2.dll }

; DONT CHANGE ANYTHING UNDER THIS LINE UNLESS YOU KNOW WHAT YOU ARE DOING
alias -l ChallengeAuth.Q { return Q@CServe.quakenet.org }
alias -l ChallengeAuth.DLL { return $dll($ChallengeAuth.PathToDll,$1,$2) }

; $1 = string to lower
alias -l ChallengeAuth.IRCToLower {
return $replacex($lower($1),$chr(91),$chr(123),$chr(93),$chr(125),$chr(92),$chr(124),$chr(94),$chr(126))
}

; $1 = Challenge
alias -l ChallengeAuth.Auth {
var %ChallengeAuth.Username = $ChallengeAuth.IRCToLower($?="Username")
if ($len(%ChallengeAuth.Username) == 0) {
echo -s ChallengeAuth: No Username specified.
return
}

var %ChallengeAuth.Password = $left($?="Password",10)
if ($len(%ChallengeAuth.Password) == 0) {
echo -s ChallengeAuth: No Password specified.
return
}

var %ChallengeAuth.PasswordHash = $ChallengeAuth.DLL(sha256_hex, %ChallengeAuth.Password)
var %ChallengeAuth.Key = $ChallengeAuth.DLL(sha256_hex, %ChallengeAuth.Username $+ : $+ %ChallengeAuth.PasswordHash)
var %ChallengeAuth.Response = $ChallengeAuth.DLL(hmac_sha256, %ChallengeAuth.Key $1)
!.msg $ChallengeAuth.Q CHALLENGEAUTH %ChallengeAuth.Username %ChallengeAuth.Response HMAC-SHA-256
}

alias ChallengeAuth {
if (!$isfile($ChallengeAuth.PathToDll)) {
echo -s ChallengeAuth: The path to your SHA2.dll is wrong. Please configure the challengeauth script correctly and/or download the dll from
echo -s ChallengeAuth: http://www.quakenet.org/development/challengeauth/SHA2.dll
return
}
set %ChallengeAuth.Active $true
echo -s ChallengeAuth: ChallengeAuth is beginning.
!.msg $ChallengeAuth.Q challenge
}

on ^*:NOTICE:*:*: {
if ($fulladdress === Q!TheQBot@CServe.quakenet.org) && ($network === QuakeNet) && ($right($server, 13) === .quakenet.org) {
if ($1 === CHALLENGE) && ($len($2) == 32) && (%ChallengeAuth.Active) {
if ($istok($3-, HMAC-SHA-256, 32)) {
.timer 1 0 ChallengeAuth.Auth $2
}
else {
echo -s ChallengeAuth: HMAC-SHA-256 is not supported. ChallengeAuth is NOT continuing.
}
}
elseif ($1- == CHALLENGE is not available once you have authed.) && (%ChallengeAuth.Active) {
echo -s ChallengeAuth: You are already authed!
unset %ChallengeAuth.Active
}
elseif ($1-6 == You are now logged in as) && (%ChallengeAuth.Active) {
echo -s ChallengeAuth: You are now authed!
unset %ChallengeAuth.Active
}
elseif ($1- == Username or password incorrect.) && (%ChallengeAuth.Active) {
echo -s ChallengeAuth: Username or password incorrect.
unset %ChallengeAuth.Active
}
}
}

raw 401:*: {
if ($1- == $me $ChallengeAuth.Q No such nick) && (%ChallengeAuth.Active) {
echo -s ChallengeAuth: Q is currently not reachable. Please try again later.
unset %ChallengeAuth.Active
haltdef
}
}

Challenge auth

2008-03-23T12:49:00Z

Doomie: updated to the new CHALLENGEAUTH command

User:Doomie

2008-02-15T11:10:52Z

Doomie: age

{{Babel-2|de|en-3}}
<table border="0">
<tr>

<td>
<table border="0">
<tr><td><b>Name</b></td><td>Philipp Krone</td></tr>
<tr><td><b>Age</b></td><td>20</td></tr>
<tr valign="top" height="40"><td><b>Country</b></td><td>Chemnitz, Germany</td></tr>

<tr><td><b>Words of wisdom</b></td><td>Mhh, moo!</td></tr>
</table>
</td>
</tr>
</table>
[[Category:Members]]

Silence

2007-01-17T21:59:36Z

Doomie:

Adds or removes an address from your silence list.
/silence [[+|-]<mask>|<nick>]

This command silences/unsilences the specified nick/mask. The silence works server side, unlike [[ignore]] you won't receive the messages. The number of silences you can set is given on connect by [[Raw_005|raw 005]]. On Quakenet the silence list is normally limited to 15. '''Note''' that all entries of your silence list are deleted if you disconnect.

Results are replied with a [[:Category:Raw_silence|raw]].

== Examples ==
silence
Shows your silence list.
silence *!*@*moo
This would silence every user with a mask matching *!*@*moo.
silence +fishbot
This would silence the nick fishbot.
silence -fishbot
This removes silence of the nick fishbot if its in your silence list.
silence -*
Removes all silences

[[Category:Raw_silence]][[Category:Basic IRC commands]]

Silence

2007-01-17T21:59:23Z

Doomie:

Adds or removes an address from your silence list.
/silence [[+|-]<mask>|<nick>]

This command silences/unsilences the specified nick/mask. The silence works server side, unlike [[ignore]] you won't receive the messages. The number of silences you can set is given on connect by [[Raw_005|raw 005]]. On Quakenet the silence list is normally limited to 15. ''Note'' that all entries of your silence list are deleted if you disconnect.

Results are replied with a [[:Category:Raw_silence|raw]].

== Examples ==
silence
Shows your silence list.
silence *!*@*moo
This would silence every user with a mask matching *!*@*moo.
silence +fishbot
This would silence the nick fishbot.
silence -fishbot
This removes silence of the nick fishbot if its in your silence list.
silence -*
Removes all silences

[[Category:Raw_silence]][[Category:Basic IRC commands]]

News

2006-08-27T12:43:52Z

Doomie:

== mIRC 6.2 is out ==
{{newsWriter|[[User:Cail|Cail]] 14:48, 27 Aug 2006 (CET)}}

mIRC 6.2 was released July 28th 2006, get it at [http://www.mirc.com www.mirc.com]. Take a look at the [[MIRC 6.2|list of changes]] aswell.

== Changes to Scriptwiki ==
{{newsWriter|[[User:Microbe|Microbe]] 00:39, 5 May 2006 (CEST)}}

Scriptwiki has gone through some changes, again. It has been made an official QuakeNet wiki and recruiting new editors has been made easier - the process should now be far faster and more user-friendly. So if you're interested in contributing to this wiki, have a look at the front page's instructions.

== mIRC 6.17 is out ==
{{newsWriter|[[User:Microbe|Microbe]] 00:31, 18 Feb 2006 (CET)}}

mIRC version 6.17 has been released an hour ago. Read more about it and download it at [http://www.mirc.com www.mirc.com].

== Scriptwiki has been globalized ==
{{newsWriter|[[User:Microbe|Microbe]] 04:03, 4 Feb 2006 (CET)}}

Scriptwiki has gone through some changes. The project started as a small one-channel project, but it is now released "to the wild". People interested to contribute to this wiki are encouraged to contact us, especially from other networks than QuakeNet. At the moment this wiki is dedicated more towards QuakeNet users, but we are hoping that this will change in the future. Users from every network should be able to get the information they need from here, especially network-specific raw events.

So if you want to contribute to the only wiki dedicated to mIRC scripting (at least at the moment), see the main page for more information.

== Welcome to Scriptwiki ==
{{newsWriter|[[User:Tovrleaf|Tovrleaf]] 22:53, 15 Sep 2005 (CEST)}}

Hi, and welcome to our new published '''Scriptwiki'''. Scriptwiki (as we call it) is our new lifelong project which won't probably ever be finished. It shall be developed and expanded along with mIRC and new scripting skills.

Special thanks to all users who have helped us to get this to shape and to create a more user friendly wiki and articles.

If you think this wiki is missing some essential articles, there's a page to [[Special:Request|request]] new articles for it. And don't forget to give us [[:Special:SendComment|feedback]], comments, ideas or new suggestions.

== Scriptwiki starting ==
{{newsWriter|[[User:Microbe|Microbe]] 12:53, 24 Aug 2005 (CEST)}}

Scriptwiki starting to get in shape

__NOTOC__

Guidelines

2006-05-05T12:03:47Z

Doomie:

As this wiki is supposed to be very user-friendly, all articles should follow the guidelines listed in here. Please note that we will not accept any articles not following these rules and reserve the right to block your account in case you break these rules repeatedly.

The following syntax is to be used in ALL mIRC help pages. (Parts like "use italic in return values" are to be used in full tutorials & scripts aswell.)

If you wish to add comments to your examples (to the same 'example box') in the article, you can do it either by adding two spaces and a ; (like: echo -a blah ;this is an echo) OR adding the comment to the next line, starting it with a space and a ;. Comments outside the 'example box' shouldn't include the ;.

'''Topic (the name of the page) examples'''
* $variable
* Command
* On_join
* If-Then-Else

'''First line of the text'''
* Short description what it does / what it's good for.
** Example: Returns the Nth token in text. A token is blah blah blah.

'''Second line of the text'''
* The syntax, starting with a space to get a box around it.
** Example: (space)$gettok(text,N,C)

'''Next one/few line(s) of the text'''
* Explanation what the non-trivial parameters mean. The parameter(s) is/are to be inside <nowiki>'' ''</nowiki> to make it italic.
** Example: ''C'' is the [[ascii]] number of the character that is set to separate the tokens blah blah.

'''Next one/few line(s) of the text'''
* Short example(s) how to use the command/identifier/whatever. The (possible) return value is to be inside <nowiki>'' ''</nowiki> to make it italic.
** Example: //echo -a $gettok(this.is.text,2,46) returns ''is''.

'''Sections'''
* If the command/identifier/whatever is complex enough to be needed to demonstrate further, use <nowiki>== Examples ==</nowiki> to start a section with more examples. Remember to add links to other wiki items such as <nowiki>[[var]]</nowiki> for the first occurence in each article. All example lines are to be started with a space and all return values are to be put inside <nowiki>'' ''</nowiki>.

'''Add "See also" and Category'''
* It's good to add a 'see also' section with <nowiki>== See also ==</nowiki> at the end of the article that contains useful links to similar commands/identifiers/whatever. Remember also to add the article to the correct category/categories with adding <nowiki>[[Category:name_of_the_category]] at the end. Like [[Category:Text and Number Identifiers]]</nowiki>.

'''Stubs'''
* If you know your article is incomplete you can add <nowiki>{{Stub}}</nowiki> marking it as incomplete and placing it in the [[:Category:Stubs]] for others/yourself to complete later on. It appears to look the best if you add it at the top of the page. To make sure whoever reads the article knows that it is incomplete.

'''Shared articles'''
* <nowiki>{{Disambling}}</nowiki> is used to split articles into smaller pieces when article holds reference to more than one article and it's '''not''' unambiguous where it should belong.

Feel free to ask any editor if you are unsure about specific subjects. To get an example, just take a look at already added articles.

Guidelines

2006-05-05T11:59:11Z

Doomie:

As this wiki is supposed to be very user-friendly, all articles should follow the guidelines listed in here. Please note that we will not accept any articles not following these rules and reserve the right to block your account in case you break these rules repeatedly.

'''Topic (the name of the page) examples'''
* $variable
* Command
* On_join
* If-Then-Else

'''First line of the text'''
* Short description what it does / what it's good for.
** Example: Returns the Nth token in text. A token is blah blah blah.

'''Second line of the text'''
* The syntax, starting with a space to get a box around it.
** Example: (space)$gettok(text,N,C)

'''Next one/few line(s) of the text'''
* Explanation what the non-trivial parameters mean. The parameter(s) is/are to be inside <nowiki>'' ''</nowiki> to make it italic.
** Example: ''C'' is the [[ascii]] number of the character that is set to separate the tokens blah blah.

'''Next one/few line(s) of the text'''
* Short example(s) how to use the command/identifier/whatever. The (possible) return value is to be inside <nowiki>'' ''</nowiki> to make it italic.
** Example: //echo -a $gettok(this.is.text,2,46) returns ''is''.

'''Sections'''
* If the command/identifier/whatever is complex enough to be needed to demonstrate further, use <nowiki>== Examples ==</nowiki> to start a section with more examples. Remember to add links to other wiki items such as <nowiki>[[var]]</nowiki> for the first occurence in each article. All example lines are to be started with a space and all return values are to be put inside <nowiki>'' ''</nowiki>.

'''Add "See also" and Category'''
* It's good to add a 'see also' section with <nowiki>== See also ==</nowiki> at the end of the article that contains useful links to similar commands/identifiers/whatever. Remember also to add the article to the correct category/categories with adding <nowiki>[[Category:name_of_the_category]] at the end. Like [[Category:Text and Number Identifiers]]</nowiki>.

'''Stubs'''
* If you know your article is incomplete you can add <nowiki>{{Stub}}</nowiki> marking it as incomplete and placing it in the [[:Category:Stubs]] for others/yourself to complete later on. It appears to look the best if you add it at the top of the page. To make sure whoever reads the article knows that it is incomplete.

'''Shared articles'''
* <nowiki>{{Disambling}}</nowiki> is used to split articles into smaller pieces when article holds reference to more than one article and it's '''not''' unambiguous where it should belong.

Feel free to ask any editor if you are unsure about specific subjects. To get an example, just take a look at already added articles.

Guidelines

2006-05-05T11:58:35Z

Doomie:

As this wiki is supposed to be very user-friendly, all articles should follow the guidelines listed in here. Please note that we will not accept any articles not following these rules and reserve the right to block your account in case you break these rules repeatedly.

'''Topic (the name of the page) examples'''
* $variable
* Command
* On_join
* If-Then-Else

'''First line of the text'''
* Short description what it does / what it's good for.
** Example: Returns the Nth token in text. A token is blah blah blah.

'''Second line of the text'''
* The syntax, starting with a space to get a box around it.
** Example: (space)$gettok(text,N,C)

'''Next one/few line(s) of the text'''
* Explanation what the non-trivial parameters mean. The parameter(s) is/are to be inside <nowiki>'' ''</nowiki> to make it italic.
** Example: ''C'' is the [[ascii]] number of the character that is set to separate the tokens blah blah.

'''Next one/few line(s) of the text'''
* Short example(s) how to use the command/identifier/whatever. The (possible) return value is to be inside <nowiki>'' ''</nowiki> to make it italic.
** Example: //echo -a $gettok(this.is.text,2,46) returns ''is''.

'''Sections'''
* If the command/identifier/whatever is complex enough to be needed to demonstrate further, use <nowiki>== Examples ==</nowiki> to start a section with more examples. Remember to add links to other wiki items such as <nowiki>[[var]]</nowiki> for the first occurence in each article. All example lines are to be started with a space and all return values are to be put inside <nowiki>'' ''</nowiki>.

'''Add "See also" and Category'''
* It's good to add a 'see also' section with <nowiki>== See also ==</nowiki> at the end of the article that contains useful links to similar commands/identifiers/whatever. Remember also to add the article to the correct category/categories with adding <nowiki>[[Category:name_of_the_category]] at the end. Like [[Category:Text and Number Identifiers]]</nowiki>.

'''Stubs'''
* If you know your article is incomplete you can add <nowiki>{{Stub}}</nowiki> marking it as incomplete and placing it in the [[:Category:Stubs]] for others/yourself to complete later on. It appears to look the best if you add it at the top of the page. To make sure whoever reads the article knows that it is incomplete.

'''Shared articles'''
* <nowiki>{{Disambling}}</nowiki> is used to split articles into smaller pieces when article holds reference to more than one article and it's '''not''' unambiguous where it should belong.

Feel free to ask any editor if you are unsure about specific subjects. To get examples, just take a look at already added articles.

Guidelines

2006-05-05T11:37:39Z

Doomie: first one to save the sentences

Category:Aliases

2006-04-25T13:04:15Z

Doomie: /* Naming aliases */

== Basic ==
mIRC script allows you to create your own set of commands and identifiers, refered to as aliases. Aliases can be called from the command line, from other aliases, from popup and from remote scripts. An alias in mIRC can not be called recursively. They can be created by either putting them in the <nowiki>"Aliases"</nowiki> section of the mIRC Scripts Editor, by using the /alias command from either the command line or in the <nowiki>"Remote"</nowiki> section of the Scripts Editor. Creating an alias in the command line results in it being placed in the "Aliases" section of the Script Editor.

=== Example ===
; These two work exactly the same way although they are stored in different places

; this is placed in the "Aliases" section
moo { [[echo]] -ag moo }

; this is placed in the "Remote" section
[[alias]] moo { [[echo]] -ag moo }

== Naming aliases ==
You can give an alias virtually any name you want, but keep a few things in mind:

* When you give an alias used as a command the same name as an existing mIRC command, your alias gets preference.
* Some inbuilt commands act differently than the rest, if you have an alias called [[timertest|Timer]], you will not be able to start a timer called test, like this: /timertest 0 1 MyTestFunction in this situation you can prefix the command with an exclamation mark (!) as shown below in the example.
* When you give an alias used as an identifier the same name as an existing mIRC identifier, mIRC's identifier gets preference, unless you prefix your alias with a period.

Example:

; at first we add a new alias called "me". If it is used as "$me", it's supposed to return "AveIT!", else it's the usual
; /me alias sending an action to the active channel
/alias me { [[If-Then-Else|if]] ([[$isid]]) { [[return]] AveIT! } | else { [[describe]] [[$active]] [[$1-]] } }

; this alias will return the amount of milliseconds (ticks) pasted between two callings.
; When called the first time, it will set a variable %timerstart to the current value of $ticks.
; When called the second time, it echo's the difference between the set variable and the current value of ticks.
; This difference is obviously the elapsed time.
/alias timertest { if (!%timerstart) [[set]] %timerstart [[$ticks]] | else { echo -ag [[$calc]]($ticks - %timerstart) ms | unset %timerstart } }

In the following example, both the custom 'me' and the 'timertest' alias will be used:

; call timertest the first time to set the variable %timertest
timertest

; echo $me (that's the default $me alias as it can't be overwritten in the usual way)
; and $.me (that's our custom alias returning 'AveIT!')
echo -ag I am $me but my custom identifer returns $.me

; call timertest a second time to echo the amount of elapsed milliseconds
timertest

Finally, the example above would return:

I am Dana but my custom identifer returns AveIT!
16 ms

'''''Note:''''' If you want to start a timer called test with the alias called timertest, you have to prefix the timer with the ! to use the inbuilt mIRC timer command:
!timertest 1 1 echo -ag This is my test.
It is not encouraged to call an alias starting with timer, or identifers with mircdir, getdir, mididir, or any other alias which can be used with a suffix.

== Aliases: parameters and events ==
mIRC script allows you to pass parameters to your aliases, just like you pass parameters into built-in mIRC commands or identifiers. They can be referred to as [[$0]], $1, $2 ... $N.

=== Parameters ===
[[alias]] moo { echo -ag m $+ [[$str]](o,$$1) }

Assuming you pass a number as parameter this would echo an <nowiki>"m"</nowiki> folowed by a number of <nowiki>"o's"</nowiki>, depending on the number you specified as parameter. This alias can be called in 2 different ways:
/moo 12
$moo(27)
Note that $moo doesn't return anything in this case, it will simply echo the message.

=== Events ===
When calling an alias from an event, the identifiers related to that event will still be available in that alias.
on *:[[On_text|TEXT]]:hi:#: { myAlias }

[[alias]] myAlias { [[msg]] [[$chan]] [[$nick]] said hi! }

This would be exactly the same as:
on *:TEXT:hi:#: { msg $chan $nick said hi! }
This in turn means that you don't have to pass a identifier supplied by an event into your alias as parameter.

== Commands vs identifiers ==
Being that you can use your aliases as both commands and identifiers, the question may rise which you should pick. The general answer is quite simple: if you want your alias to have a return value use identifiers and in any other case use commands.

=== Error handling ===
However, mIRC's built-in error handling cannot be used for your aliases, so for proper error handling you might want to use return values. For example, you could use return value 1 when an action was succesfull and 0 when it was not.
; this identifier returns 1 if it was succesfull in what it would do and 0 if it wasn't
; the (useless) idea of the following identifier is to message "moo" to the currently active channel
; if it is on QuakeNet
alias moo {
if ([[$network]] != QuakeNet) || (!$chan) { return 0 }
else {
msg $chan moo
return 1
}
}

To use this as error handling you could do the following:
%error = $moo
if (!%error) {
; do what you want to do if the command failed
; in this case when there was no channel active
; or the server was not QuakeNet
}
[[elseif]] (%error = 1) {
; do what you want to do if the command succeeded
; in this case when there was an active channel and
; the server was QuakeNet
}
else {
; the script should never reach this place!
}
Although the same identifier could have been run as a command as well, error handling would not have been possible that way. Of course the alias itself has some error handling already, but there are cases in which you want an action to be able to fail.

Another reason to prefer identifiers over comands are parameters. When you call an alias as a command every space will result in a new parameter and there is no way you can get around that. Using an alias as an identifier it is possible to get around the comma and thus have your parameters contain a comma. Here's how to do that:
; calling an identifier with a comma in a parameter
[[alias]] test {
; the while loop will echo every parameter
[[var]] %i = $0
[[while]] (%i) {
[[echo]] -ag $ [ $+ [ %i ] ]
[[dec]] %i
}
}

var %param = abcdef,ghijk
%someVar = $test(%param)
The snippets above would result in having the identifier $test echo only 1 parameter: the data which was set in %param. Would you do the same for a command -- replacing the comma with a space -- it would result in /test getting 2 parameters. Handling parameters is much easier if you are a 100% sure which parameter will contain which data, and an identifier is more reliable in doing so.

=== Forced identifiers ===
To force an alias to be an identifier -- it can't be used as a command -- or vice versa you can use the identifier [[$isid]].
; this alias can only be called as an identifier
[[alias]] qnet {
if ([[$isid]]) {
; the following code only gets executed if the alias was called as an identifier
[[if]] ([[$network]] === QuakeNet) { [[return]] 1 }
[[else]] { [[return]] 0 }
}
}
Calling the alias will result in a return value of either 0 or 1, while calling it as a command will do completely nothing.

== Also See ==
* [[$isid]]
[[Category:mIRC_Help]]

Category:Aliases

2006-04-25T13:01:08Z

Doomie: perhaps like this?

== Basic ==
mIRC script allows you to create your own set of commands and identifiers, refered to as aliases. Aliases can be called from the command line, from other aliases, from popup and from remote scripts. An alias in mIRC can not be called recursively. They can be created by either putting them in the <nowiki>"Aliases"</nowiki> section of the mIRC Scripts Editor, by using the /alias command from either the command line or in the <nowiki>"Remote"</nowiki> section of the Scripts Editor. Creating an alias in the command line results in it being placed in the "Aliases" section of the Script Editor.

=== Example ===
; These two work exactly the same way although they are stored in different places

; this is placed in the "Aliases" section
moo { [[echo]] -ag moo }

; this is placed in the "Remote" section
[[alias]] moo { [[echo]] -ag moo }

== Naming aliases ==
You can give an alias virtually any name you want, but keep a few things in mind:

* When you give an alias used as a command the same name as an existing mIRC command, your alias gets preference.
* Some inbuilt commands act differently than the rest, if you have an alias called [[timertest|Timer]], you will not be able to start a timer called test, like this: /timertest 0 1 MyTestFunction in this situation you can prefix the command with an exclamation mark (!) as shown below in the example.
* When you give an alias used as an identifier the same name as an existing mIRC identifier, mIRC's identifier gets preference, unless you prefix your alias with a period.

Example:

; at first we add a new alias called "me". If it is used as "$me", it's supposed to return "AveIT!", else it's the usual
; /me alias sending an action to the active channel
/alias me { [[If-Then-Else|if]] ([[$isid]]) { [[return]] AveIT! } | else { [[describe]] [[$active]] [[$1-]] } }

; this alias will return the amount of milliseconds (ticks) pasted between two callings.
; When called the first time, it will set a variable %timerstart to the current value of $ticks.
; When called the second time, it echo's the difference between the set variable and the current value of ticks.
; This difference is obviously the elapsed time.
/alias timertest { if (!%timerstart) [[set]] %timerstart [[$ticks]] | else { echo -ag [[$calc]]($ticks - %timerstart) ms | unset %timerstart } }

In the following example, both the custom 'me' and the 'timertest' alias will be used:

; call timertest the first time to set the variable %timertest
timertest

; echo $me (that's the default $me alias as it can't be overwritten in the usual way
; and $.me (that's our custom alias returning 'AveIT!'
echo -ag I am $me but my custom identifer returns $.me

; call timertest a second time to echo the amount of elapsed milliseconds
timertest

Finally, the example above would return:

I am Dana but my custom identifer returns AveIT!
16 ms

'''''Note:''''' If you want to start a timer called test with the alias called timertest, you have to prefix the timer with the ! to use the inbuilt mIRC timer command:
!timertest 1 1 echo -ag This is my test.
It is not encouraged to call an alias starting with timer, or identifers with mircdir, getdir, mididir, or any other alias which can be used with a suffix.

== Aliases: parameters and events ==
mIRC script allows you to pass parameters to your aliases, just like you pass parameters into built-in mIRC commands or identifiers. They can be referred to as [[$0]], $1, $2 ... $N.

=== Parameters ===
[[alias]] moo { echo -ag m $+ [[$str]](o,$$1) }

Assuming you pass a number as parameter this would echo an <nowiki>"m"</nowiki> folowed by a number of <nowiki>"o's"</nowiki>, depending on the number you specified as parameter. This alias can be called in 2 different ways:
/moo 12
$moo(27)
Note that $moo doesn't return anything in this case, it will simply echo the message.

=== Events ===
When calling an alias from an event, the identifiers related to that event will still be available in that alias.
on *:[[On_text|TEXT]]:hi:#: { myAlias }

[[alias]] myAlias { [[msg]] [[$chan]] [[$nick]] said hi! }

This would be exactly the same as:
on *:TEXT:hi:#: { msg $chan $nick said hi! }
This in turn means that you don't have to pass a identifier supplied by an event into your alias as parameter.

== Commands vs identifiers ==
Being that you can use your aliases as both commands and identifiers, the question may rise which you should pick. The general answer is quite simple: if you want your alias to have a return value use identifiers and in any other case use commands.

=== Error handling ===
However, mIRC's built-in error handling cannot be used for your aliases, so for proper error handling you might want to use return values. For example, you could use return value 1 when an action was succesfull and 0 when it was not.
; this identifier returns 1 if it was succesfull in what it would do and 0 if it wasn't
; the (useless) idea of the following identifier is to message "moo" to the currently active channel
; if it is on QuakeNet
alias moo {
if ([[$network]] != QuakeNet) || (!$chan) { return 0 }
else {
msg $chan moo
return 1
}
}

To use this as error handling you could do the following:
%error = $moo
if (!%error) {
; do what you want to do if the command failed
; in this case when there was no channel active
; or the server was not QuakeNet
}
[[elseif]] (%error = 1) {
; do what you want to do if the command succeeded
; in this case when there was an active channel and
; the server was QuakeNet
}
else {
; the script should never reach this place!
}
Although the same identifier could have been run as a command as well, error handling would not have been possible that way. Of course the alias itself has some error handling already, but there are cases in which you want an action to be able to fail.

Another reason to prefer identifiers over comands are parameters. When you call an alias as a command every space will result in a new parameter and there is no way you can get around that. Using an alias as an identifier it is possible to get around the comma and thus have your parameters contain a comma. Here's how to do that:
; calling an identifier with a comma in a parameter
[[alias]] test {
; the while loop will echo every parameter
[[var]] %i = $0
[[while]] (%i) {
[[echo]] -ag $ [ $+ [ %i ] ]
[[dec]] %i
}
}

var %param = abcdef,ghijk
%someVar = $test(%param)
The snippets above would result in having the identifier $test echo only 1 parameter: the data which was set in %param. Would you do the same for a command -- replacing the comma with a space -- it would result in /test getting 2 parameters. Handling parameters is much easier if you are a 100% sure which parameter will contain which data, and an identifier is more reliable in doing so.

=== Forced identifiers ===
To force an alias to be an identifier -- it can't be used as a command -- or vice versa you can use the identifier [[$isid]].
; this alias can only be called as an identifier
[[alias]] qnet {
if ([[$isid]]) {
; the following code only gets executed if the alias was called as an identifier
[[if]] ([[$network]] === QuakeNet) { [[return]] 1 }
[[else]] { [[return]] 0 }
}
}
Calling the alias will result in a return value of either 0 or 1, while calling it as a command will do completely nothing.

== Also See ==
* [[$isid]]
[[Category:mIRC_Help]]

Unsetall

2006-04-25T12:06:57Z

Doomie:

Unsets and removes all variables from the variable list.
/unsetall

== See Also ==
[[Set|/set]] sets a variable.<br />
[[Var|/var]] sets a local variable.<br />
[[Unset|/unset]] unsets a variable.

[[Category:Commands]]
[[Category:Variables]]

Unset

2006-04-25T12:05:58Z

Doomie: added it to category:variables

Unsets and removes a variable from the variable list.
/unset [-s] <%var>
The -s switch gives an output: * Unset %var

'''Note''' that you can specify a variable with [[Wildcard|wildcard]] characters.

== Example ==
/unset %moo
This will unset and remove the variable %moo.
/unset %test*
This will unset and remove all variables that begin with %test.

== See Also ==
[[Set|/set]] sets a variable.<br />
[[Var|/var]] sets a local variable.<br />
[[Unsetall|/unsetall]] unsets all variables.

[[Category:Commands]]
[[Category:Variables]]

How to start

2006-04-20T18:07:07Z

Doomie:

This tutorial is supposed to give an introduction into scripting in mIRC. It will explain the so-called ''Scripts-Editor'' and it's functions, followed by a little example. At the end it will give some hints about how to debug a script.

== The Remote Editor ==

If you want to begin to script in mIRC, you need to open the Script-Editor. You can do it in two ways: pressing "Alt + R" or with mIRC's menubar (Tools -> Scripts Editor).

If you are using a premade script (for example nnscript), you will probably see a lot of code. Note that it is difficult to implement own scripts in such a premade one, as functions could interfere (if you want to change mIRC's default output for example).

At first, you should open a '''new remote file'''. To do it, click on File -> New (see picture below).

[[Image:Newfile.png]]

Note that your script files will be saved '''automatically'''; all you need to do is pressing 'Ok'.

The next part is about the five different tabs of mIRC's Scripts Editor:

[[Image:Scriptseditortabs.png]]

=== Aliases-Tab ===

Basically, you do not need to use aliases.ini (that you can edit using this tab). Usually, if you want to add a new alias, it would look like:

[[alias]] moo { [[return]] moo }

in your 'Remote-Section' of the editor (the one that's active after pressing Alt + R). You can add the same alias in your Aliases-Section:

moo { return moo }

Notice that you don't need to write 'alias' infront of the new alias. Note that you cannot add events in this section.

=== Popups-Tab ===

Again you do not need to use this section. It's the same as using the [[menu]] alias in the remote section. Usually, there will be some menus added in this section (for example your nicklist-menu).

[[Image:popupsview.png]]

=== Remote-Tab ===

This is the "maintab". Every script is supposed to be saved in here.

'''Note''' that you should not have two same events in one file, as only the first matching one will be triggered. Example:

; will be triggered
on *:Text:*:*: { echo moo }

; will never be triggered
on 10:Text:*:*: { echo maa }

; will be trigger for level 10
on 10:Text:*:*: { echo maa }

; will be triggered for all but level 10
on *:Text:*:*: { echo moo }

So if you aren't sure whether it will work or not, just use another (a new) file (look above to see how to make a new file).

The following script will trigger on every "!moo" in every channel and response with "moo00oo00":

[[On_text|on *:TEXT]]:!moo:#: {
[[msg]] [[$chan]] moo00oo00
}

This would look like:

[[Image:firstscript.png]]

If you are scripting something more complex, you want to use the "{}"-button in the upper right corner (see below).

[[Image:bracket-button.png]]

If you've pressed it and nothing happended, everything is ok (note that it doesn't mean that your scripts will work, just that there is no obvious bracket mistake (mIRC just counts the open and closed brackets)). If something's wrong, you will get the following popup:

[[Image:bracketerror.png]]

=== Users-Tab ===

In this file your userlist is saved. You don't need to edit it manually, as there are aliases to do so. See [[auser]], [[guser]] and [[ruser]].

=== Variables-Tab ===

All your global variables are saved in here. Again, you don't need to edit it manually, as you can use [[set]], [[unset]] or [[unsetall]].

== How to debug ==

After you've written some lines and you've tested it, you will most likely notice, that it doesn't do what you expect it to do. The next step is to '''debug''' your script. At first take a look at your Status Window and check for error messages. If there are any, search for these errors in your script and correct them. If they aren't any, you should add [[echo]]'s in your script to see where it stops to work. For example:

on *:TEXT:*:*: {
if (%moo) { echo -a we are here }
elseif (%moo2) { echo -a we are here 2 }
echo -a after the if clauses
}

With this method, you can exactly see where it stops to work and correct this part.

[[Category:Tutorials]]

How to query a CS Server

2006-04-14T14:03:37Z

Doomie:

If you want to e.g. get the umber and names of all player who are currently playing on a CS-server, you have to send a so-called "query" to this server (using UDP) and handle everything the server sends back to you. This isn't as easy as it sounds. At first, you would have to 'learn', or, at least, understand the protocol a CS-server uses (e.g. what do I have to send to the server to get a 'good' reply and what's the structure of this reply). If you want to learn more about these protocols, take a look at http://dev.kquery.com/ or http://www.valve-erc.com/srcsdk/Code/Networking/serverqueries.html.

The following script '''echo'''s the output to your active window. You will have to modify it to be able to use it as 'bot'. It's a more complex script and you don't need to understand it (completly) to be able to use it.

; HL server query snippet by Saturn
;
; usage:
; /hlinfo <ip> <port>
; /hlplay <ip> <port>

; the alias that opens a new socket if you want to get general information about a running CS-server
[[alias]] hlinfo {
; using a dynamic socket name so we can use multiple instances at once
[[var]] %sock = $+(hlinfo-,$ticks)
; actually open the socket
[[sockudp]] -k %sock [[$1]]-2 [[$str]]([[$chr]](255),4) [[DollarPlus|$+]] TSource Engine Query
; closing the socket after 60seconds if there is no response (else it will be closed by another event (see below))
.[[timer]] $+ %sock 1 60 [[sockclose]] %sock
}

; this event will get all data send back from the server
on *:udpread:hlinfo-*:{
; save it in a binary variable
[[sockread]] -f &reply

; set some local variables that we will use below
var %offset, %name, %map, %game, %num, %max, %ip, %dir

; following the protocol, this "m" shows us that we did query a Half-Life 1 server
if ($chr($bvar(&reply,5)) == m) {
; Half-Life 1 info reply

%offset = 6

; saving the ip
%ip = $bvar(&reply,%offset,128).text
inc %offset $calc($len(%ip) + 1)

; the same
%name = $bvar(&reply,%offset,128).text
inc %offset $calc($len(%name) + 1)

; the current map
%map = $bvar(&reply,%offset,128).text
inc %offset $calc($len(%map) + 1)

; the game directory
%dir = $bvar(&reply,%offset,128).text
inc %offset $calc($len(%dir) + 1)

; the name of the game
%game = $bvar(&reply,%offset,128).text
inc %offset $calc($len(%game) + 1)

; current and maximum players
%num = $bvar(&reply,%offset)
%max = $bvar(&reply,$calc(%offset + 1))
}
; else we get data for a CS:Source game
else {
; Source info reply
; we do the same as above
%offset = 7

%name = $bvar(&reply,%offset,128).text
inc %offset $calc($len(%name) + 1)

%map = $bvar(&reply,%offset,128).text
inc %offset $calc($len(%map) + 1)

%dir = $bvar(&reply,%offset,128).text
inc %offset $calc($len(%dir) + 1)

%game = $bvar(&reply,%offset,128).text
inc %offset $calc($len(%game) + 1)

%num = $bvar(&reply,$calc(%offset + 2))
%max = $bvar(&reply,$calc(%offset + 3))
}

; now we echo all stored details to the active window
echo -a Info for $sock($sockname).saddr $+ : $+ $sock($sockname).sport
echo -a Name: %name
echo -a Map: %map
echo -a Game: %game
echo -a Players: %num $+ / $+ %max

; and turn the timer to close the socket off
.timer $+ $sockname off
; as we can close it manually now
sockclose $sockname
}

; this is the alias that will be called from hlplay to open the socket
alias hlchal {
; $1 = ip, $2 = port, $3- = what to call when received
; use dynamic socket name as above
var %sock = $+(hlchal-,$ticks)
; open the socket
sockudp -k %sock $1-2 $str($chr(255),4) $+ W
; mark it with the ip and port (and the query we want to call when we've received something from the server
sockmark %sock $3- $1-2
; and make a new timer to close it after 60 seconds
.timer $+ %sock 1 60 sockclose %sock
}

; read everything that comes back from the hlchal-* query
on *:UDPREAD:hlchal-*:{
; and save it in the binary variable called &reply
sockread -f &reply
; actually call the alias saved in the sockmark (hlplay_query)
$sock($sockname).mark $bvar(&reply,6,4)
; and turn the timer off because we can close it manually
.timer $+ $sockname off
sockclose $sockname
}

; the alias we can call to make everything easier
; it will call other aliases to open sockets etc.
alias hlplay {
hlchal $1-2 hlplay_query
}

; the alias that opens the _real_ socket to receive data (everything before was just to challenge the server (read the website mentioned above)
alias hlplay_query {
; set a binary variable
bset &query 1 255 255 255 255 85 $3-
; use dynamic socket names again
var %sock = $+(hlplay-,$ticks)
; open the socket
sockudp -k %sock $1-2 &query
; and turn the alias to close the socket after 60seconds on
.timer $+ %sock 1 60 sockclose %sock
}

; this event will receive all data from the server as response to out query
on *:UDPREAD:hlplay-*:{
; we save it in &reply
sockread -f &reply

; set some local variables we will use later
var %i = 1, %num = $bvar(&reply,6), %offset = 7
var %count = 0, %name, %kills

; and echo the number of players
echo -a Players on $sock($sockname).saddr $+ : $+ $sock($sockname).sport

; now we can loop through all player and save some details about them
while (%i <= %num) {
inc %offset

; the name
%name = $bvar(&reply,%offset,128).text
inc %offset $calc($len(%name) + 1)

; the kills
%kills = $bvar(&reply,%offset).long
if ($isbit(%kills,32)) dec %kills $calc(2^32)
inc %offset 8

; and if there was a player
if (%name != $null) {
; increase the variable that shows us the number of the player
inc %count
; and echo it to the active window with the kills saved above
echo -a %count $+ . %name - %kills
}

; increase %i so we go on with the next player
inc %i
}

; if there are no players online, echo is aswell
if (%count == 0) echo -a No players found!

; turn off the timer
.timer $+ $sockname off
; and close the socket manually
sockclose $sockname
}

How to query a CS Server

2006-04-14T12:27:34Z

Doomie: doesnt work + weird text - needs rewriting perhaps

{{stub}}

If you want to e.g. get the umber and names of all player who are currently playing on a CS-server, you have to send a so-called "query" to this server (using UDP) and handle everything the server sends back to you. This isn't as easy as it sounds. At first, you would have to 'learn', or, at least, understand the protocol a CS-server uses (e.g. what do I have to send to the server to get a 'good' reply and what's the structure of this reply). If you want to learn more about these protocols, take a look at http://dev.kquery.com/.

The following script '''echo'''s the output to your active window. You will have to modify it to be able to use it as 'bot'. It's a more complex script and you don't need to understand it (completly) to be able to use it.

; this is a handy alias to call the script. It will call the "hlx" alias with an ip and a port as argument
; you can add more aliases like this one.
; if you want to all "hlq" directly, you can use something like: "/hlq <ip> <port>"
[[alias]] hlx { hlq <ip> <port> }

; the main alias to open a new socket connections
; syntax: /hlq <ip> <port>
alias hlq {
[[sockudp]] -k hlq [[$1]]-2 [[DollarPlus|$+]]([[$str]]($chr(255),4),players)
}

; this event will read every data from the cs server
on *:udpread:hlq*:{
; we put it in a binary variable
[[sockread]] -f &data

; the sixth byte is the number of players, so we set it to a variable
[[var]] %players = $bvar(&data, 6, 1)
var %offset = 7

; that's a variable for the while loop some lines below
var %d = 1

; return a line seperator (usually "-")
[[linesep]]
; echo the number of players
[[echo]] -a %players Players

; now we are looping through all players to get some stats about them
[[while]] (%d <= %players) {
; the following lines are getting these stats. If you want to learn more about this, take a look
; at http://dev.kquery.com/

; we get the playernumber
var %playernum = $bvar(&data, %offset, 1)
[[inc]] %offset

; the name of the player
var %name = $bvar(&data, %offset, 200).text
inc %offset $calc($len(%name) + 1)

; the current score
var %score = $bvar(&data, %offset, 4)
inc %offset 4

inc %offset 4

; and echo everything
echo -a %playernum - name: %name - score: $be2le(%score)

; increase the variable for the while loop to get stats about the next player
inc %d
}

; at the end, we are closing the socket to be able to open a new one later
sockclose $sockname
}
; this alias converts 'big endians' into 'little endians'
alias be2le {
tokenize 32 $1 | return $calc($1 + $2 * 2^8 + $4 * 2^16 + $3 * 2^24)
}

How to start

2006-04-11T17:43:16Z

Doomie: /* Remote-Tab */

How to start

2006-04-11T17:40:50Z

Doomie: /* How to debug */

This tutorial is supposed to give an introduction into scripting in mIRC. It will explain the so-called ''Scripts-Editor'' and it's functions, followed by a little example. At the end it will give some hints about how to debug a script.

== The Remote Editor ==

If you want to begin to script in mIRC, you need to open the Script-Editor. You can do it in two ways: pressing "Alt + R" or with mIRC's menubar (Tools -> Scripts Editor).

If you are using a premade script (for example nnscript), you will probably see a lot of code. Note that it is difficult to implement own scripts in such a premade one, as functions could interfere (if you want to change mIRC's default output for example).

At first, you should open a '''new remote file'''. To do it, click on File -> New (see picture below).

[[Image:Newfile.png]]

Note that your script files will be saved '''automatically'''; all you need to do is pressing 'Ok'.

The next part is about the five different tabs of mIRC's Scripts Editor:

[[Image:Scriptseditortabs.png]]

=== Aliases-Tab ===

Basically, you do not need to use aliases.ini (that you can edit using this tab). Usually, if you want to add a new alias, it would look like:

[[alias]] moo { [[return]] moo }

in your 'Remote-Section' of the editor (the one that's active after pressing Alt + R). You can add the same alias in your Aliases-Section:

moo { return moo }

Notice that you don't need to write 'alias' infront of the new alias. Note that you cannot add events in this section.

=== Popups-Tab ===

Again you do not need to use this section. It's the same as using the [[menu]] alias in the remote section. Usually, there will be some menus added in this section (for example your nicklist-menu).

[[Image:popupsview.png]]

=== Remote-Tab ===

This is the "maintab". Every script is supposed to be saved in here.

'''Note''' that you '''cannot''' have two same events in one file, as only the first matching one will be triggered. Example:

; will be triggered
on *:Text:*:*: { echo moo }

; will never be triggered
on 10:Text:*:*: { echo maa }

; will be trigger for level 10
on 10:Text:*:*: { echo maa }

; will be triggered for all but level 10
on *:Text:*:*: { echo moo }

So if you aren't sure whether it will work or not, just use another (a new) file (look above to see how to make a new file).

The following script will trigger on every "!moo" in every channel and response with "moo00oo00":

[[On_text|on *:TEXT]]:!moo:#: {
[[msg]] [[$chan]] moo00oo00
}

This would look like:

[[Image:firstscript.png]]

If you are scripting something more complex, you want to use the "{}"-button in the upper right corner (see below).

[[Image:bracket-button.png]]

If you've pressed it and nothing happended, everything is ok (note that it doesn't mean that your scripts will work, just that there is no obvious bracket mistake (mIRC just counts the open and closed brackets)). If something's wrong, you will get the following popup:

[[Image:bracketerror.png]]

=== Users-Tab ===

In this file your userlist is saved. You don't need to edit it manually, as there are aliases to do so. See [[auser]], [[guser]] and [[ruser]].

=== Variables-Tab ===

All your global variables are saved in here. Again, you don't need to edit it manually, as you can use [[set]], [[unset]] or [[unsetall]].

== How to debug ==

After you've written some lines and you've tested it, you will most likely notice, that it doesn't do what you expect it to do. The next step is to '''debug''' your script. At first take a look at your Status Window and check for error messages. If there are any, search for these errors in your script and correct them. If they aren't any, you should add [[echo]]'s in your script to see where it stops to work. For example:

on *:TEXT:*:*: {
if (%moo) { echo -a we are here }
elseif (%moo2) { echo -a we are here 2 }
echo -a after the if clauses
}

With this method, you can exactly see where it stops to work and correct this part.

How to start

2006-04-11T17:40:34Z

Doomie: /* Remote-Tab */

This tutorial is supposed to give an introduction into scripting in mIRC. It will explain the so-called ''Scripts-Editor'' and it's functions, followed by a little example. At the end it will give some hints about how to debug a script.

== The Remote Editor ==

If you want to begin to script in mIRC, you need to open the Script-Editor. You can do it in two ways: pressing "Alt + R" or with mIRC's menubar (Tools -> Scripts Editor).

If you are using a premade script (for example nnscript), you will probably see a lot of code. Note that it is difficult to implement own scripts in such a premade one, as functions could interfere (if you want to change mIRC's default output for example).

At first, you should open a '''new remote file'''. To do it, click on File -> New (see picture below).

[[Image:Newfile.png]]

Note that your script files will be saved '''automatically'''; all you need to do is pressing 'Ok'.

The next part is about the five different tabs of mIRC's Scripts Editor:

[[Image:Scriptseditortabs.png]]

=== Aliases-Tab ===

Basically, you do not need to use aliases.ini (that you can edit using this tab). Usually, if you want to add a new alias, it would look like:

[[alias]] moo { [[return]] moo }

in your 'Remote-Section' of the editor (the one that's active after pressing Alt + R). You can add the same alias in your Aliases-Section:

moo { return moo }

Notice that you don't need to write 'alias' infront of the new alias. Note that you cannot add events in this section.

=== Popups-Tab ===

Again you do not need to use this section. It's the same as using the [[menu]] alias in the remote section. Usually, there will be some menus added in this section (for example your nicklist-menu).

[[Image:popupsview.png]]

=== Remote-Tab ===

This is the "maintab". Every script is supposed to be saved in here.

'''Note''' that you '''cannot''' have two same events in one file, as only the first matching one will be triggered. Example:

; will be triggered
on *:Text:*:*: { echo moo }

; will never be triggered
on 10:Text:*:*: { echo maa }

; will be trigger for level 10
on 10:Text:*:*: { echo maa }

; will be triggered for all but level 10
on *:Text:*:*: { echo moo }

So if you aren't sure whether it will work or not, just use another (a new) file (look above to see how to make a new file).

The following script will trigger on every "!moo" in every channel and response with "moo00oo00":

[[On_text|on *:TEXT]]:!moo:#: {
[[msg]] [[$chan]] moo00oo00
}

This would look like:

[[Image:firstscript.png]]

If you are scripting something more complex, you want to use the "{}"-button in the upper right corner (see below).

[[Image:bracket-button.png]]

If you've pressed it and nothing happended, everything is ok (note that it doesn't mean that your scripts will work, just that there is no obvious bracket mistake (mIRC just counts the open and closed brackets)). If something's wrong, you will get the following popup:

[[Image:bracketerror.png]]

=== Users-Tab ===

In this file your userlist is saved. You don't need to edit it manually, as there are aliases to do so. See [[auser]], [[guser]] and [[ruser]].

=== Variables-Tab ===

All your global variables are saved in here. Again, you don't need to edit it manually, as you can use [[set]], [[unset]] or [[unsetall]].

== How to debug ==

After you've written some lines and you've tested it, you will most likely notice, that it doesn't do what you expect it to do. The next step is to '''debug''' your script. At fist take a look at your Status Window and check for error messages. If there are any, search for these errors in your script and correct them. If they aren't any, you should add [[echo]]'s in your script to see where it stops to work. For example:

on *:TEXT:*:*: {
if (%moo) { echo -a we are here }
elseif (%moo2) { echo -a we are here 2 }
echo -a after the if clauses
}

With this method, you can exactly see where it stops to work and correct this part.

How to start

2006-04-11T14:09:15Z

Doomie: save #2

This tutorial is supposed to give an introduction into scripting in mIRC. It will explain the so-called ''Scripts-Editor'' and it's functions, followed by a little example. At the end it will give some hints about how to debug a script.

== The Remote Editor ==

If you want to begin to script in mIRC, you need to open the Script-Editor. You can do it in two ways: pressing "Alt + R" or with mIRC's menubar (Tools -> Scripts Editor).

If you are using a premade script (for example nnscript), you will probably see a lot of code. Note that it is difficult to implement own scripts in such a premade one, as functions could interfere (if you want to change mIRC's default output for example).

At first, you should open a '''new remote file'''. To do it, click on File -> New (see picture below).

[[Image:Newfile.png]]

Note that your script files will be saved '''automatically'''; all you need to do is pressing 'Ok'.

The next part is about the five different tabs of mIRC's Scripts Editor:

[[Image:Scriptseditortabs.png]]

=== Aliases-Tab ===

Basically, you do not need to use aliases.ini (that you can edit using this tab). Usually, if you want to add a new alias, it would look like:

[[alias]] moo { [[return]] moo }

in your 'Remote-Section' of the editor (the one that's active after pressing Alt + R). You can add the same alias in your Aliases-Section:

moo { return moo }

Notice that you don't need to write 'alias' infront of the new alias. Note that you cannot add events in this section.

=== Popups-Tab ===

Again you do not need to use this section. It's the same as using the [[menu]] alias in the remote section. Usually, there will be some menus added in this section (for example your nicklist-menu).

[[Image:popupsview.png]]

=== Remote-Tab ===

This is the "maintab". Every script is supposed to be saved in here.

'''Note''' that you '''cannot''' have two same events in one file. So if you aren't sure whether it will work or not, just use another (a new) file (look above to see how to make a new file).

The following script will trigger on every "!moo" in every channel and response with "moo00oo00":

[[On_text|on *:TEXT]]:!moo:#: {
[[msg]] [[$chan]] moo00oo00
}

This would look like:

[[Image:firstscript.png]]

If you are scripting something more complex, you want to use the "{}"-button in the upper right corner (see below)

[[Image:bracket-button.png]]

If you've pressed it and nothing happended, everything is ok (note that it doesn't mean that your scripts will work, just that there is no obvious bracket mistake (mIRC just counts the open and closed brackets)). If something's wrong, you will get the following popup:

[[Image:bracketerror.png]]

=== Users-Tab ===

In this file your userlist is saved. You don't need to edit it manually, as there are aliases to do so. See [[auser]], [[guser]] and [[ruser]].

=== Variables-Tab ===

All your global variables are saved in here. Again, you don't need to edit it manually, as you can use [[set]], [[unset]] or [[unsetall]].

== How to debug ==

After you've written some lines and you've tested it, you will most likely notice, that it doesn't do what you expect it to do. The next step is to '''debug''' your script. At fist take a look at your Status Window and check for error messages. If there are any, search for these errors in your script and correct them. If they aren't any, you should add [[echo]]'s in your script to see where it stops to work. For example:

on *:TEXT:*:*: {
if (%moo) { echo -a we are here }
elseif (%moo2) { echo -a we are here 2 }
echo -a after the if clauses
}

With this method, you can exactly see where it stops to work and correct this part.

File:Bracket-button.png

2006-04-11T13:59:09Z

Doomie:

File:Firstscript.png

2006-04-11T13:57:15Z

Doomie:

File:Bracketerror.png

2006-04-11T13:56:48Z

Doomie:

How to start

2006-04-11T13:21:17Z

Doomie: just to save it

File:Popupsview.png

2006-04-11T13:20:33Z

Doomie:

File:Scriptseditortabs.png

2006-04-11T13:14:07Z

Doomie:

File:Newfile.png

2006-04-11T13:08:55Z

Doomie:

Category:Aliases

2006-04-10T19:55:46Z

Doomie: so that it's on one line for better reading ;)

== Basic ==
mIRC script allows you to create your own set of commands and identifiers, refered to as aliases. Aliases can be called from the command line, from other aliases, from popup and from remote scripts. An alias in mIRC can not be called recursively. They can be created by either putting them in the <nowiki>"Aliases"</nowiki> section of the mIRC Scripts Editor, by using the /alias command from either the command line or in the <nowiki>"Remote"</nowiki> section of the Scripts Editor. Creating an alias in the command line results in it being placed in the "Aliases" section of the Script Editor.

=== Example ===
; this is placed in the "Aliases" section
moo { [[echo]] -ag moo }

; this is placed in the "Remote" section
[[alias]] moo { [[echo]] -ag moo }

== Naming aliases ==
You can give an alias virtualy any name you want, but keep a few things in mind:

* When you give an alias used as a command the same name as an existing mIRC command, your alias gets preference.
* When you give an alias used as an identifier the same name as an existing mIRC identifier, mIRC's identifier gets preference.

== Aliases: parameters and events ==
mIRC script allows you to pass parameters to your aliases, just like you pass parameters into built-in mIRC commands or identifiers. They can be referred to as $1, $2 ... $N.

=== Parameters ===
[[alias]] moo { echo -ag m $+ [[$str]](o,$$1)

Assuming you pass a number as parameter this would echo an <nowiki>"m"</nowiki> folowed by a number of <nowiki>"o's"</nowiki>, depending on the number you specified as parameter. This alias can be called in 2 different ways:
/moo 12
$moo(27)
Note that $moo doesn't return anything in this case, it will simply echo the message.

=== Events ===
When calling an alias from an event, the identifiers related to that event will still be available in that alias.
on *:TEXT:hi:#: { myAlias }

[[alias]] myAlias { [[msg]] [[$chan]] [[$nick]] said hi!

This would be exactly the same as:
on *:TEXT:hi:#: { [[msg]] [[$chan]] [[$nick]] said hi!
This in turn means that you don't have to pass a identifier supplied by an event into your alias as parameter.

== Commands vs identifiers ==
Being that you can use your aliases as both commands as identifiers, the question may rise which you should pick. The general answer is quite simple: if you want your alias to have a return value use identifiers and in any other case use commands.

=== Error handling ===
However, mIRC's built-in error handling cannot be used for your aliases, so for proper error handling you might want to use return values. For example, you could use return value 1 when an action was succesfull and 0 when it was not.
; this identifier returns 1 if it was succesfull in what it would do and 0 if it wasn't
; the (useless) idea of the following identifier is to message "moo" to the currently active channel
; if it is on QuakeNet
[[alias]] moo {
[[if]] ([[$network]] != QuakeNet) || (![[$chan]]) { [[return]] 0 }
[[else]] {
[[msg]] [[$chan]] moo
[[return]] 1
}
}

To use this as error handling you could do the following:
%error = $moo
[[if]] (!%error) {
; do what you want to do if the command failed
; in this case when there was no channel active
; or the server was not QuakeNet
}
[[elseif]] (%error = 1) {
; do what you want to do if the command succeeded
; in this case when there was an active channel and
; the server was QuakeNet
}
[[else]] {
; the script should never reach this place!
}
Although the same identifier could have been run as a command as well, error handling would not have been possible that way. Of course the alias itself has some error handling already, but there are cases in which you want an action to be able to fail.

Another reason to prefer identifiers over comands are parameters. When you call an alias as a command every space will result in a new parameter and there is no way you can get around that. Using an alias as an identifier it is possible to get around the comma and thus have your parameters contain a comma. Here's how to do that:
; calling an identifier with a comma in a parameter
[[alias]] test {
; the while loop will echo every parameter
[[var]] %i = $0
[[while]] (%i)
[[echo]] -ag $ [ $+ [ %i ] ]
[[dec]] %i
}
}

var %param = abcdef,ghijk
%someVar = $test(%param)
The snippets above would result in having the identifier $test echo only 1 parameter: the data which was set in %param. Would you do the same for a command -- replacing the comma with a space -- it would result in /test getting 2 parameters. Handling parameters is much easier if you are a 100% sure which parameter will contain which data, and an identifier is more reliable in doing so.

=== Forced identifiers ===
To force an alias to be an identifier -- it can't be used as a command -- or vice versa you can use the identifier [[$isid]].
; this alias can only be called as an identifier
[[alias]] qnet {
if ([[$isid]]) {
; the following code only gets executed if the alias was called as an identifier
[[if]] ([[$network]] === QuakeNet) { [[return]] 1 }
[[else]] { [[return]] 0 }
}
}
Calling the alias will result in a return value of either 0 or 1, while calling it as a command will do completely nothing.
[[Category:mIRC_Help]]

$chr

2006-04-02T15:55:00Z

Doomie: added link to ascii table

Returns the character with ascii number N.
$chr(N)

To get a list of all ascii chars and ascii numbers, take a look at http://www.lookuptables.com/.

== Example ==
[[echo]] -a $chr(65)
This example would return the character with the ASCII-code 65. That is an 'A'.

== See Also ==
[[$asc]] returns the ascii number of a character.

[[Category:Text_and_Number_Identifiers]]

$asc

2006-04-02T15:42:47Z

Doomie: just a little explanation

Returns the ascii number of the character C.
$asc(C)

== Example ==
echo -a $asc(A) ; returns ''65''.

To get the ascii value of a character, just type:
//echo -a $asc([[$?]])
Type the character you want the ascii value of in the prompt and press enter. This is necessary as you can't use something like 'echo -a $asc(,)', as mIRC would think the comma is seperating parameters and so return '* Too many parameters: $asc'.

== See Also ==
[[$chr]] returns the character of an ascii number.

[[Category:Text_and_Number_Identifiers]]

$chr

2006-04-02T15:41:28Z

Doomie: wouldnt know what to say

Returns the character with ascii number N.
$chr(N)

== Example ==
[[echo]] -a $chr(65)
This example would return the character with the ASCII-code 65. That is an 'A'.

== See Also ==
[[$asc]] returns the ascii number of a character.

[[Category:Text_and_Number_Identifiers]]

How to press a key using an alias

2006-04-02T15:38:28Z

Doomie: perhaps like this

With this alias, you are able to "send keys" to the active window, which doesnt have to be mIRC.
For descriptions of all the keys, see: http://msdn.microsoft.com/library/default.asp?url=/library/en-us/script56/html/wsmthsendkeys.asp

You will have to paste this script into the 'Remote' section of mIRC's script editor.

alias sendkey {
[[set]] -l %name sendkeys $+ [[$ticks]]
.[[comopen]] %name WScript.Shell
.[[comclose]] %name [[$com]](%name,SendKeys,3,bstr,[[$1-]])
}

== Example ==

sendkey {TAB}

This sends the "Tab"-Key to the active window (using the alias specified above). It is the same as if you'd press the "Tab"-Key on your keyboard.

sendkey +(ab)c
This would send "ABc" to the active window, as +(ab) means 'shift' and 'a' and 'b' and a lone 'c' after that.

[[Category:Script Archive]]

Raw 484

2006-04-02T14:23:49Z

Doomie: added a newline

<table>
<tr>
<td>Name:</td><td>ERR_ISCHANSERVICE</td>
</tr>
<tr>
<td>Format:</td><td>
<source> 484 <target> <nick> <channel> :Cannot [[Kill|kill]], [[Kick|kick]] or [[Mode|deop]] an [[IRC]] operator<br />
<source> 484 <target> KILL <nick> :Cannot kill, kick or deop an IRC operator
</td>
</tr>
<tr>
<td>Info:</td><td> This is returned when trying to kill, kick or deop an IRC Operator with usermode [[Mode|+k]] set</td>
</tr>
<tr>
<td>Example:</td><td>
irc.quakenet.org 484 [[Dana]] Dana #help.script :Cannot kill, kick or deop an IRC operator

irc.quakenet.org 484 Dana KILL Dana :Cannot kill, kick or deop an IRC operator
</td>
</tr>
</table>

[[Category:Raws]][[Category:Raw_kick]][[Category:Raw_kill]][[Category:Raw_mode]]

Category:Raws

2006-03-30T10:42:58Z

Doomie: added $ support in the syntax (regex-based matchtext)

== Raws ==
When the IRC server send you information it contains either a command or a RAW numeric. The numerics are a supplement to the normal events (NOTICE/PRIVMSG/MODE/etc.) not a replacement. Because raw events receive the information from the server in its native form, they give you maximum flexibility in regards to how you choose to use it or present it to the user of your script.

To read more about the IRC RFC, look here: RFC 1459

== Syntax==
To actually react on numeric-raws, you have to use:
raw [$]<numeric>:<matchtext>:{ commands }

'''Note''' that raw-events are just like "normal" events, like [[On_text|On Text]] or [[On_notice|On Notice]]. That means that you '''can't''' use them in an alias or in another event. If you are using ''$'' infront of the numeric, you have to use a regex-based matchtext.

== Example ==
For example you get several numeric raws when you join a channel:
*[[Raw_332|332]] - containing the topic of the channel (like when using [[Topic|/topic]])
*[[Raw_333|333]] - containing the one who has set the topic and when it was set
*[[Raw_353|353]] - containing the names on the channel (like when using [[Names|/names]])
*[[Raw_366|366]] - containing the message that the list of names has ended
*[[Raw_324|324]] - containing the modes that are currently set (like when using [[Mode|/mode]])
*[[Raw_329|329]] - containing the creation date of the channel

If you e.g. want to echo the creation date of the channel to your status window, you would have to use:
; raw 329 returns: <yournick> <#channel> <creation time in unix format>
raw 329:*: {
[[echo]] -a $2 was created at: [[$asctime]]($3)
}

If you want to halt mIRC's default output in connection with a raw-event, you can use [[Haltdef|/haltdef]]. For example:
raw 332:*: {
haltdef
}
This example would make mIRC not show the topic of a channel you have joined.

[[Category:IRC]]

$status

2006-03-29T21:33:16Z

Doomie:

Returns server connection status.

$status

This identifier can return several values:
* connected - if your mIRC is connected (this includes the [[On_connect|On connect event]])
* disconnected - if your mIRC is not connected
* connecting - during connection process (between ''Connecting to ...'' and ''Looking up hostname'')
* disconnecting - during disconnect (between [[quit|/quit]] and ''* Disconnected'')
* closing - in an [[On_disconnect|On disconnect event]]

[[Category:Other Identifiers]]

$modespl

2006-03-29T16:03:35Z

Doomie: i did decide against an example as it would prolly be massmode support.. welcome for other ideas ;)

Returns the maximum number of modes allowed per [[mode|/mode]].
$modespl

On QuakeNet, this identifier would return "6", as you can set 6 modes at once (e.g. /mode <channel> +oooooo <nick> <nick> ...)

[[Category:Other_Identifiers]]

Else

2006-03-29T15:43:44Z

Doomie:

#redirect [[if-then-else]]

On disconnect

2006-03-29T15:36:32Z

Doomie:

The on DISCONNECT event triggers when you quit or are disconnected from an IRC Server.

on <level>:DISCONNECT:<commands>

You can use this event to unset variables or delete / free hashtables.
== Example ==

The following example will unset all variables beginning with "moo" whenever you close mIRC or are disconnected.

on *:DISCONNECT: {
[[unset]] %moo*
}

== See Also ==
* [[on_connect|on connect]] triggers when you connect to an IRC Server
* [[on_quit|on quit]] triggers whenever someone quits from IRC

[[Category:Events]]

Unbannick

2006-03-29T15:30:06Z

Doomie: first try, needs testing + comments + perhaps nicer text..

{{Stub}}
This script provides an alias to unban a "nick" (respectivly his address) even if this user isn't on the channel. Therefor, it uses the [[who|/who]] command to get the current address of a nickname.

The syntax is: /unbannick <channel> <nickname>

Additionally, it will drop the one unbanning this nick a message and the one that got unbanned a notice. The part about uhexec will be without further comments.

; on disconnect we clear the hashtable uhexec has used.
[[On_disconnect|on *:DISCONNECT]]:[[hdel]] -w uhexec $cid $+ .*
[[alias]] -l uhq [[return]] [[$iif]]([[$hget]](uhexec,$+($cid,.,[[$1]])),$v1,$iif($1 !isnum,0))
alias -l uhnext {
$iif($0 > 1,hadd -m,hdel) uhexec $+($cid,.,$uhq($1) $2-)
[[hadd]] uhexec $+($cid,.,$1) $iif($uhq($1) < 64,$calc($v1 + 1),0)
}
alias -l uhexec {
[[if]] ([[$status]] == connected) || ([[$ial]]($1).addr != [[$null]]) {
uhnext head $1-
[[userhost]] $1
}
[[else]] $2- $ial($1).addr
}
[[Raw_302|raw $302]]:/^\S+( (\S+?)\*?=[+-](\S+)|) ?$/:{
[[tokenize]] 32 $uhq($uhq(tail))
if ($0) && (([[$regml]](0) < 2) || ($1 == $regml(2))) {
uhnext tail
$2- $regml(3)
[[halt]]
}
}
alias -l uncb {
; <chan> <nick> [host]
if ($3 == $null) return
[[var]] %i = 1, %b, %a = $+($2,!,$3)
[[while]] ($ibl($1,%i) != $null) {
if ($v1 iswm %a) {
%b = %b $v1
if ([[$numtok]](%b,32) == [[$modespl]]) {
[[mode]] $1 - $+ [[$str]](b,$numtok(%b,32)) %b
%b =
}
}
[[inc]] %i
}
if (%b != $null) mode $1 - $+ $str(b,$numtok(%b,32)) %b
[[msg]] $1 Unbanned $2 upon request
[[notice]] $2 You're now unbanned on $1
}
; actually provide the alias (Syntax: /unbannick <chan> <nick>)
alias unbannick uhexec $2 uncb $1-2

[[Category:Script Archive]]

User:Doomie

2006-03-13T08:20:55Z

Doomie: yearly update

{{Babel-2|de|en-3}}
<table border="0">
<tr>

<td>
<table border="0">
<tr><td><b>Name</b></td><td>Philipp Krone</td></tr>
<tr><td><b>Age</b></td><td>19</td></tr>
<tr valign="top" height="40"><td><b>Country</b></td><td>Chemnitz, Germany</td></tr>

<tr><td><b>Words of wisdom</b></td><td>Mhh, moo!</td></tr>
</table>
</td>
</tr>
</table>
[[Category:Members]]

Weekday

2006-03-13T08:08:56Z

Doomie: typos.. changed "," to "."

The following alias returns the name of a date you have specified. Only after 01.01.0001. If no date is specified, it returns the name of the current day.

; format: $day2 or $day2(day,month,year) or $day2(day.month.year)
[[alias]] day2 {
; if there are no parameter, just return the name of the current day
[[if]] (!$1) { [[return]] $day }
; we get parameters
else {
; lets check if we get $day2(day.month.year), then tokenize it
if (($1) && (!$2) && ($numtok($1,46) == 3)) { [[tokenize]] 46 $1 }
; lets first check if we got 3 correct ones
if (($1 !isnum 1-31) || ($2 !isnum 1-12) || (!$3)) { return $false }
; there are no 5.10.1582 -> 14.10.1582 due to the change of calendar
if (($3 == 1582) && ($2 == 10) && ($1 > 4) && ($1 < 15)) { return $false }
; we need the days of months
[[var]] %month = 31,28,31,30,31,30,31,31,30,31,30,31
; lets calc all days of all complete years and days in the current month
var %days = [[$calc]]((($3 - 1)*365) + ($1 - 1))
; now lets include all complete month in the current year (we need to loop through all)
var %i = 0
[[while]] (%i < $calc($2 - 1)) {
%days = $calc(%days + [[$gettok]](%month,$calc(%i + 1),44))
[[inc]] %i
}
; decrease days by ten due to change of calendar
if (($3 > 1582) || (($3 == 1582) && (($2 > 10) || (($2 == 10) && ($1 > 4))))) {
%days = $calc(%days - 10)
}
; leapyears til 1599: all years divided by 4
; after 1600: all years divided by 4 but not at full centurys, only if they are dividable by 400
var %leapyears = $floor($calc($3 / 4))
if (($calc($3 % 4) == 0) && ($2 < 3)) { [[dec]] %leapyears }
if ($3 >= 1600) {
%leapyears = $calc(%leapyears - [[$floor]]($calc(($3 - 1600) / 100)))
%leapyears = $calc(%leapyears + $floor($calc(($3 - 1600) / 400)))
if (($calc($3 % 100) == 0) && ($2 < 3)) {
inc %leapyears
if ($calc($3 % 400) == 0) { dec %leapyears }
}
}
%days = $calc(%days + %leapyears)
; lets show the result
var %week = Saturday,Sunday,Monday,Tuesday,Wednesday,Thursday,Friday
var %erg = $gettok(%week,$calc((%days % 7) + 1),44)
return %erg
}
}

[[Category:Script Archive]]

On usermode

2006-01-21T20:21:55Z

Doomie:

The on USERMODE event triggers triggers when you change your usermode.
on <level>:USERMODE:<commands>

Read [[Access_Levels|access levels]] to get more info about the <level> field.

'''Note''' that $1- refers to the changed usermode.
== Example ==
on *:USERMODE: {
[[echo]] -a Changed usermode: $1-
}
This event would trigger when you get the confirmation of a usermode changing and echo's it to the active window.

To check if you e.g. have set +x is more complicated as $1- could e.g. be "-w+x", so you have to loop through $1-.
on *:USERMODE: {
; set looping variable and %m as variable holding whether the current mode we are looking at
; was set or unset
[[var]] %i = 1, %m
; begin to loop through $1-
[[while]] (%i <= [[$len]]($1-)) {
; check if the current char is "-" and set %m to it (all modes will be unset after "-")
if ([[$mid]]($1-,%i,1) == -) { %m = - }
; check if the current char is "+" and set %m to it (all modes will be set after "+")
if ($mid($1-,%i,1) == +) { %m = + }
; if the char we are looking at is "x"
if ($mid($1-,%i,1) == x) {
; we need to check whether %m is "+" (so x is set, not unset) and echo it
if (%m == +) { echo -a Mode +x was just set. }
}
}

== See Also ==
To react on channelmode changes, take a look at the [[On_mode|On Mode event]].

[[Category:Events]]

WHO usage and numeric events

2005-12-26T17:54:26Z

Doomie: changed link + removed author tag

This script is supposed to show everyone how easy it is to get someones Q-authname, save it in a variable and/or return it.

Covers the usage of raw events and the /who command.

; A simple little alias that returns the time interval for the flood protection (in seconds).
; We make this [[:Category:Aliases|alias]] local (-l switch), since we wont need it outside this script.

alias -l authflood {
[[return]] 3
}

; Basic [[On_text|On Text]] [[Events|event]] to trigger the script.

on *:Text:!auth *:#: {

; Flood protection so that noone can abuse the command and flood you off the server.
; If the variable %authflood doesnt exist, the script continues.

[[If-Then-Else|if]] (!%authflood) {

; Check if there really is a nick to get the auth of, by making sure $2 exists.

if ($2) {

; At first, we will save $2 in a variable, since we need it later on.

[[set]] %nickname $2

; Perform a /who request of the nick with the appropriate flags (n%nat). For more info on /who command, read:
; http://www.mircscripts.org/showdoc.php?type=tutorial&id=2412
; the t flag is to identify the reply, which we assign a random number, in this case 465 (later on being used in the "raw 354"-event)

[[who]] $2 n%nat,465

; Assign %authchan the value of $chan so we can access it later

set %authchan $chan

}

; if there is no $2, show the syntax

else {
msg $chan To use it correctly, type !auth <nickname>
}

; Set the %authflood variable (in order to prevent abuse of the command) to $authflood seconds using the -u switch.

set -u [ $+ [ $authflood ] ] %authflood 1
}
}

; Raw numeric 354 is the servers reply of the /who request. We check if "465" is in the reply
; to be sure its the reply we are looking for.
;
; (To read more about raws, have a look at: [[:Category:Raws|Raws]]

[[Raw_354|raw 354]]:& 465 & *: {

; syntax of raw 354 (with our flags): "me 465 nick authname" for authed people or
; "me 465 nick 0" for non-authed ones.
; but for now we will just assign %authname the value of $4 without checking if is 0 or not

set %authname $4

}

; Raw numeric 315 notifies us that the /who request is over. Now is the time to
; process whatever data we have.

[[Raw_315|raw 315]]:*: {

; syntax of raw 315: "me nick End of /WHO list."
;
; We check if its really our reply by comparing the nickname ($2) against requested nickname (%nickname)

if ($2 == %nickname) {

; At this stage %nickname should contain the nick of the requested nick, %authname the authname of %authnick
; and %authchan the channel to which we should send the information.
;
; We have to check if %authname isnt 0, since "!%authname" would return $true if %authname is 0

if (!%authname) && (%authname != 0) {
[[msg]] %authchan There is noone with the nick %nickname $+ .
}

; if %authname is set to 0 the nick isnt authed.

elseif (%authname == 0) {
msg %authchan %nickname is currently not authed.
}

; else we assume the user is authed and print the authname

else {
msg %authchan %nickname is authed as %authname $+ .

}

; Unset the used variables

[[unset]] %authname
unset %authchan
unset %nickname

}
}

[[Category:Script Archive]]