Scriptwiki - User contributions [en]

Challenge auth

2015-07-18T13:17:32Z

NaNg: version link.

; Original by doomie @ QuakeNet
; Modified by NaNg @ QuakeNet
; Version 1.2
; Written and tested on mIRC 6.34
; Also tested on mIRC 7.22
;
; What does this script contains?
;
; * ChallengeAuth script based on hmac-sha1 (no addon dll needed for mIRC on tested version).
;
; What is ChallengeAuth?
;
; ChallengeAuth is a safe way to auth to your Q account, without sending your password in plain
; text over the network. For more information, please read the following link:
; http://www.quakenet.org/development/challengeauth/
;
; *****************************************************
; What do I need to configure before using this script?
; *****************************************************
;
; You don't need to configure ANYTHING! The scripts can work as is, by executing /ChallengeAuth.
; If you'd like for it to auto-auth on connect, use /ChallengeAuth.AutoAuth 1.
; The script will pop up windows asking your username (first time only) and password (every time).
;
; If you don't want it to pop the password window every time, follow these instructions:
;
; The ChallengeAuth.Username and ChallengeAuth.Password right under this documentation needs to
; be edited for your username and hashed password.
; To get the hashed password, after loading this script, use:
; /ChallengeAuth.CreateHash <User> <Pass>
; where User is your Q account name and Pass is your Q password, and you will be given the hashed
; password that corresponds to the given user which you should insert in the alias below, e.g:
; alias -l ChallengeAuth.Password { return <Hashed_Password> }
;
; Available commands:
;
; * ChallengeAuth
; To auth to the pre-set user and password using the challengeauth.
; * ChallengeAuth.AutoAuth [1|0]
; Set 1 to enable to auto-auth on connect or 0 to disable.
; * ChallengeAuth.CreateHash [<Authname>] [<Pass>]
; Creates a hashed request according to the given Q user and pass.

; CONFIGURE

[[alias]] -l ChallengeAuth.Username {
[[If-Then-Else|if]] (!%ChallengeAuth.User) {
![[set]] %ChallengeAuth.User $?="Q account name?"
}

[[return]] %ChallengeAuth.User
}

[[alias]] -l ChallengeAuth.Password {
[[return]] $ChallengeAuth.CreateHash($ChallengeAuth.Username, $?*="Password for Q account name: $ChallengeAuth.Username ")
}

; DONT CHANGE ANYTHING UNDER THIS LINE UNLESS YOU KNOW WHAT YOU ARE DOING

[[alias]] -l ChallengeAuth.Q { [[return]] Q@CServe.quakenet.org }

; id = whether autoauth is on or not.
; $1 = 1 for autoauth or 0 for not.
[[alias]] ChallengeAuth.AutoAuth {
[[If-Then-Else|if]] ([[$isid]]) [[return]] %ChallengeAuth.AutoAuth

[[If-Then-Else|if]] ([[$1-|$1]] == [[$null]]) {
[[echo]] -at ChallengeAuth: Not enough parameters.
[[return]]
}

[[If-Then-Else|if]] ([[$1-|$1]] !isin 01) {
[[echo]] -at ChallengeAuth: Invalid parameter. Please enter 1 to enable or 0 to disable.
[[return]]
}

[[set]] %ChallengeAuth.AutoAuth [[$1-|$1]]
[[echo]] -at ChallengeAuth: Automatic authentication is now [[$iif]](%ChallengeAuth.AutoAuth, ON, OFF)
}

; $1 = key, $2 = message
[[alias]] hmac-sha1 {
[[Local_Variables|var]] %i = 1
[[while]] (%i <= 64) {
[[Local_Variables|var]] %k = [[$iif]]([[$asc]]([[$mid]]([[$1-|$1]],%i,1)),[[$v1]],0)
[[Local_Variables|var]] %opad = %opad [[$xor]](92,%k)
[[Local_Variables|var]] %ipad = %ipad [[$xor]](54,%k)
[[inc]] %i
}

[[bset]] &ipad 1 %ipad [[$regsubex]]([[$1-|$2]],/(.)/g,[[$asc]](\t) [[DollarPlus|$+]] [[$chr]](32))
[[bset]] &opad 1 %opad [[$regsubex]]([[$sha1]](&ipad,1),/(..)/g,[[$base]](\t,16,10) [[DollarPlus|$+]] [[$chr]](32))
[[Local_Variables|var]] %res = [[$sha1]](&opad,1)
[[bunset]] &ipad &opad
[[return]] %res
}

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

; $1 = Authname, $2 = Password
[[alias]] ChallengeAuth.CreateHash {
[[If-Then-Else|if]] (![[$1-|$2]]) {
[[echo]] -ta ChallengeAuth: Not enough values given.
[[return]]
}

![[Local_Variables|var]] %ChallengeAuth.Hash = [[$sha1]]([[DollarPlus|$+]]($ChallengeAuth.IRCToLower([[$1-|$1]]),:,[[$sha1]]([[$left]]([[$1-|$2]],10))))

[[If-Then-Else|if]] ([[$isid]]) [[return]] %ChallengeAuth.Hash

![[echo]] -atg ChallengeAuth: Hashed user/pass: %ChallengeAuth.Hash
}

; Unsets challengeauth vars
[[alias]] -l ChallengeAuth.Clear {
![[Unset|unset]] %ChallengeAuth.Active
![[Unset|unset]] %ChallengeAuth.Pass
}

; $1 = Challenge
[[alias]] -l ChallengeAuth.Auth {
!.[[msg]] $ChallengeAuth.Q CHALLENGEAUTH %ChallengeAuth.User $hmac-sha1(%ChallengeAuth.Pass, [[$1-|$1]]) HMAC-SHA-1
}

[[alias]] ChallengeAuth {
; If username and password weren't supplied, use the defaults.
[[If-Then-Else|if]] (![[$1-|$1]]) {
[[tokenize]] 32 $ChallengeAuth.Username $ChallengeAuth.Password
}

[[If-Then-Else|if]] (![[$1-|$2]]) {
[[echo]] -at ChallengeAuth: No Password specified.
[[return]]
}

![[set]] %ChallengeAuth.Active [[$true]]
![[set]] %ChallengeAuth.User [[$1-|$1]]
![[set]] %ChallengeAuth.Pass [[$1-|$2]]

[[echo]] -at ChallengeAuth: ChallengeAuth is beginning.
!.[[msg]] $ChallengeAuth.Q challenge
}

on *:CONNECT: {
[[If-Then-Else|if]] (($ChallengeAuth.AutoAuth) && ([[$network]] == QuakeNet) && ([[$right]]([[$server]], 13) === .quakenet.org)) {
ChallengeAuth $ChallengeAuth.Username $ChallengeAuth.Password
}
}

on ^*:NOTICE:*:?: {
ChallengeAuth.ExecuteInput [[$1-|$1-]]
}

on ^*:TEXT:*:?: {
ChallengeAuth.ExecuteInput [[$1-|$1-]]
}

[[alias]] -l ChallengeAuth.ExecuteInput {

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

raw 401:*: {
[[If-Then-Else|if]] ([[$1-|$1-]] == [[$me]] $ChallengeAuth.Q No such nick) && (%ChallengeAuth.Active) {
[[echo]] -ts ChallengeAuth: Q is currently not reachable. Please try again later.
ChallengeAuth.Clear
[[haltdef]]
}
}

== See also ==

* [[ChallengeAuth]] (the new script working on versions 7.42 or higher).
* [[Joining channels after hiding your address]]

ChallengeAuth

2015-07-18T13:16:58Z

NaNg: old script reference.

; Original by doomie @ QuakeNet
; Modified by NaNg @ QuakeNet
; Version 2.0
; Written and tested on mIRC 7.42
;
; What does this script contains?
;
; * ChallengeAuth script based on $hmac and $sha256 which are available from mIRC v7.42.
; * No addon dll needed for mIRC on tested version.
;
; What is ChallengeAuth?
;
; ChallengeAuth is a safe way to auth to your Q account, without sending your password in plain
; text over the network. For more information, please read the following link:
; http://www.quakenet.org/development/challengeauth/
;
; *****************************************************
; What do I need to configure before using this script?
; *****************************************************
;
; You don't need to configure ANYTHING! The scripts can work as is, by executing /ChallengeAuth.
; If you'd like for it to auto-auth on connect, use /ChallengeAuth.AutoAuth 1.
; The script will pop up windows asking your username (first time only) and password (every time).
;
; If you don't want it to pop the password window every time, follow these instructions:
;
; The ChallengeAuth.Username and ChallengeAuth.Password right under this documentation needs to
; be edited for your username and hashed password.
; To get the hashed password, after loading this script, use:
; /ChallengeAuth.CreateHash <User> <Pass>
; where User is your Q account name and Pass is your Q password, and you will be given the hashed
; password that corresponds to the given user which you should insert in the alias below, e.g:
; alias -l ChallengeAuth.Password { return <Hashed_Password> }
;
; Available commands:
;
; * ChallengeAuth
; To auth to the pre-set user and password using the challengeauth.
; * ChallengeAuth.AutoAuth [1|0]
; Set 1 to enable to auto-auth on connect or 0 to disable.
; * ChallengeAuth.CreateHash [<Authname>] [<Pass>]
; Creates a hashed request according to the given Q user and pass.

; CONFIGURE

[[alias]] -l ChallengeAuth.Username {
[[If-Then-Else|if]] (!%ChallengeAuth.User) {
![[set]] %ChallengeAuth.User $?="Q account name?"
}

[[return]] %ChallengeAuth.User
}

[[alias]] -l ChallengeAuth.Password {
[[return]] $ChallengeAuth.CreateHash($ChallengeAuth.Username, $?*="Password for Q account name: $ChallengeAuth.Username ")
}

; DONT CHANGE ANYTHING UNDER THIS LINE UNLESS YOU KNOW WHAT YOU ARE DOING

[[alias]] -l ChallengeAuth.Q { [[return]] Q@CServe.quakenet.org }

; id = whether autoauth is on or not.
; $1 = 1 for autoauth or 0 for not.
[[alias]] ChallengeAuth.AutoAuth {
[[If-Then-Else|if]] ([[$isid]]) [[return]] %ChallengeAuth.AutoAuth

[[If-Then-Else|if]] ([[$1-|$1]] == [[$null]]) {
[[echo]] -at ChallengeAuth: Not enough parameters.
[[return]]
}

[[If-Then-Else|if]] ([[$1-|$1]] !isin 01) {
[[echo]] -at ChallengeAuth: Invalid parameter. Please enter 1 to enable or 0 to disable.
[[return]]
}

[[set]] %ChallengeAuth.AutoAuth [[$1-|$1]]
[[echo]] -at ChallengeAuth: Automatic authentication is now [[$iif]](%ChallengeAuth.AutoAuth, ON, OFF)
}

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

; $1 = Authname, $2 = Password
[[alias]] ChallengeAuth.CreateHash {
[[If-Then-Else|if]] (![[$1-|$2]]) {
[[echo]] -ta ChallengeAuth: Not enough values given.
[[return]]
}

![[Local_Variables|var]] %ChallengeAuth.Hash = [[$sha256]]([[DollarPlus|$+]]($ChallengeAuth.IRCToLower([[$1-|$1]]),:,[[$sha256]]([[$left]]([[$1-|$2]],10))))

[[If-Then-Else|if]] ([[$isid]]) [[return]] %ChallengeAuth.Hash

![[echo]] -atg ChallengeAuth: Hashed user/pass: %ChallengeAuth.Hash
}

; Unsets challengeauth vars
[[alias]] -l ChallengeAuth.Clear {
![[Unset|unset]] %ChallengeAuth.Active
![[Unset|unset]] %ChallengeAuth.Pass
}

; $1 = Challenge
[[alias]] -l ChallengeAuth.Auth {
!.[[msg]] $ChallengeAuth.Q CHALLENGEAUTH %ChallengeAuth.User [[$hmac]]([[$1-|$1]], %ChallengeAuth.Pass, sha256) HMAC-SHA-256
}

[[alias]] ChallengeAuth {
; If username and password weren't supplied, use the defaults.
[[If-Then-Else|if]] (![[$1-|$1]]) {
[[tokenize]] 32 $ChallengeAuth.Username $ChallengeAuth.Password
}

[[If-Then-Else|if]] (![[$1-|$2]]) {
[[echo]] -at ChallengeAuth: No Password specified.
[[return]]
}

![[set]] %ChallengeAuth.Active [[$true]]
![[set]] %ChallengeAuth.User [[$1-|$1]]
![[set]] %ChallengeAuth.Pass [[$1-|$2]]

[[echo]] -at ChallengeAuth: ChallengeAuth is beginning.
!.[[msg]] $ChallengeAuth.Q challenge
}

on *:CONNECT: {
[[If-Then-Else|if]] (($ChallengeAuth.AutoAuth) && ([[$network]] == QuakeNet) && ([[$right]]([[$server]], 13) === .quakenet.org)) {
ChallengeAuth $ChallengeAuth.Username $ChallengeAuth.Password
}
}

on ^*:NOTICE:*:?: {
ChallengeAuth.ExecuteInput [[$1-|$1-]]
}

on ^*:TEXT:*:?: {
ChallengeAuth.ExecuteInput [[$1-|$1-]]
}

[[alias]] -l ChallengeAuth.ExecuteInput {

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

raw 401:*: {
[[If-Then-Else|if]] ([[$1-|$1-]] == [[$me]] $ChallengeAuth.Q No such nick) && (%ChallengeAuth.Active) {
[[echo]] -ts ChallengeAuth: Q is currently not reachable. Please try again later.
ChallengeAuth.Clear
[[haltdef]]
}
}

== See also ==

* [[Challenge auth]] (the old script, works on versions older than v7.42)
* [[Joining channels after hiding your address]]

$hmac

2015-07-18T13:13:29Z

NaNg: new $hmac identifier.

Returns HMAC hash value for the specified data using the given key, where hash can be md5, sha1 (default), sha256, sha384 or sha512 and N = 0 for plain text (default), 1 for &binvar, 2 for filename.
$hmac(text|&binvar|filename,key,hash,[N])

== Example ==

$hmac(text string, hmackey, sha256)
Returns the HMAC-SHA-256 hash value of ''text string'' with key ''hmackey'' (19df3338494ee69e5a1648f9456677355878af1ffed0f74a6fc0effee8551089)

//bset -t &bvar 1 text string | echo -ag $hmac(&bvar,hmackey,sha256,1)
Echoes the same as the last value, this time using a binary variable.

$hmac(mirc.ini,hmackey,sha1,2)
Returns the HMAC-SHA-1 hash value of the file ''mirc.ini''.

== See Also ==

* [[$md5]]
* [[$sha1]]
* [https://en.wikipedia.org/wiki/Hash-based_message_authentication_code HMAC on wikipedia]

$sha512

2015-07-18T13:08:03Z

NaNg: Redirected page to $sha1

#REDIRECT [[$sha1]]

$sha384

2015-07-18T13:07:48Z

NaNg: Redirected page to $sha1

#REDIRECT [[$sha1]]

$sha256

2015-07-18T13:07:33Z

NaNg: Redirected page to $sha1

#REDIRECT [[$sha1]]

$sha1

2015-07-18T13:06:27Z

NaNg: add examples.

Returns SHA-1 hash value for the specified data, where N = 0 for plain text (default), 1 for &binvar, 2 for filename.
$sha1(text|&binvar|filename,[N])

Also available are $sha256, $sha384 and $sha512 with the same format for SHA-256, SHA-384 and SHA-512.
$sha256(text|&binvar|filename,[N])
$sha384(text|&binvar|filename,[N])
$sha512(text|&binvar|filename,[N])

== Example ==

$sha1(text string)
Returns the SHA-1 hash value of ''text string'' (384270d144eede06a0254452cc26d06f2b0005d6)

//bset -t &bvar 1 text string | echo -ag $sha1(&bvar,1)
Echoes the same as the last value, this time using a binary variable.

$sha1(mirc.ini,2)
Returns the SHA-1 hash value of the file ''mirc.ini''.

$sha256(text string)
Returns the SHA-256 hash value of ''text string'' (f8ddf8b97330b28452da0971b6b78c19fd769378bd26d29d7bf790fbba051710)

== See Also ==

* [[$md5]]

[[Category:Other Identifiers]]

$sha1

2015-07-18T13:06:05Z

NaNg: add other hashes.

Returns SHA-1 hash value for the specified data, where N = 0 for plain text (default), 1 for &binvar, 2 for filename.
$sha1(text|&binvar|filename,[N])

Also available are $sha256, $sha384 and $sha512 with the same format for SHA-256, SHA-384 and SHA-512.
$sha256(text|&binvar|filename,[N])

== Example ==

$sha1(text string)
Returns the SHA-1 hash value of ''text string'' (384270d144eede06a0254452cc26d06f2b0005d6)

//bset -t &bvar 1 text string | echo -ag $sha1(&bvar,1)
Echoes the same as the last value, this time using a binary variable.

$sha1(mirc.ini,2)
Returns the SHA-1 hash value of the file ''mirc.ini''.

$sha256(text string)
Returns the SHA-256 hash value of ''text string'' (f8ddf8b97330b28452da0971b6b78c19fd769378bd26d29d7bf790fbba051710)

== See Also ==

* [[$md5]]

[[Category:Other Identifiers]]

Wikify

2015-07-18T13:04:10Z

NaNg: Add new identifiers.

Script to add links to a script for this wiki.

; $1 = file
[[alias]] wikify {
[[If-Then-Else|if]] ($fopen(in)) { .[[fclose]] in }
[[If-Then-Else|if]] ($fopen(out)) { .[[fclose]] out }
.[[fopen]] in [[$1-|$1]]
[[If-Then-Else|if]] ($ferr) { [[echo]] -ag Couldn't open [[$1-|$1]] | [[return]] }
.[[fopen]] -no out wiki.txt
[[If-Then-Else|if]] ($ferr) { [[echo]] -ag Couldn't open wiki.txt | [[return]] }
[[Local_Variables|var]] %comment
[[while]] (!$fopen(in).eof) {
[[bunset]] &line
[[set]] -l %r $fread(in)
[[If-Then-Else|if]] ([[$len]](%r)) {
[[If-Then-Else|if]] ([[$left]]([[$strip]](%r),2) == /*) { [[Local_Variables|var]] %comment = 1 }
[[If-Then-Else|elseif]] ([[$left]]([[$strip]](%r),2) == */) { [[Local_Variables|var]] %comment = 0 }
[[If-Then-Else|if]] ([[$left]]([[$strip]](%r),1) != ;) && (!%comment) {
[[set]] -l %r [[$regsubex]](two,[[$regsubex]](one,%r,/((?:^\s*|\x7B\s+|\x7C\s+)[.!]*(?:while|(?:else\s*)?if)\s+)($(?>[^()]|(?2))*$)(\s+)(\S+)/g,\1\2\3 [[DollarPlus|$+]] $makelink(\4)),/(^\s*|\x7B\s+|\x7C\s+)((?:[.!]*else\s+|[.!]*timer\S*\s+(?:-\w+\s+)?(?:\d\d?:\d\d(?::\d\d)?\s+)?\d+\s+\d+\s+)?[^\s\x7B]+)/g,\1 [[DollarPlus|$+]] $makelink(\2))
[[set]] -l %r [[$regsubex]](%r,/(?<=^|\s|\x28|!|\x2C)(\$[^\s\x2C]+\x28?|\$\x28)/g,$makelink2(\1))
}
[[bset]] &line 2 [[$regsubex]](%r,/(.)/g,[[$asc]](\1) [[DollarPlus|$+]] [[$chr]](32))
}
[[bset]] &line 1 32
.[[fwrite]] -bn out &line
}
.[[fclose]] in
.[[fclose]] out
[[run]] wiki.txt
}

; $1 = command
[[alias]] -l makelink {
[[Local_Variables|var]] %c = [[$regsubex]]([[$1-|$1]],/^([.!]+)(.+),\2) , %dot = [[$regml]](1)
[[If-Then-Else|if]] ([[$read]](commands.txt,nw,%c *)) { [[return]] [[DollarPlus|$+]](%dot,[[$chr]](91),[[$chr]](91),[[$iif]]([[$gettok]]([[$v1]],2,32) == %c,%c,[[DollarPlus|$+]]([[$v1]],[[$chr]](124),%c)),[[$chr]](93),[[$chr]](93)) }
[[return]] [[$1-|$1]]
}

; $1 = $identifier(
[[alias]] -l makelink2 {
; echo -ag id: $1
; check for $!bla and $$bla and $$!bla
[[Local_Variables|var]] %id = [[$1-|$1]] , %ex , %dbl , %br , %ret , %link , %n
[[If-Then-Else|if]] ([[$mid]](%id,2,1) == $) { [[Local_Variables|var]] %id = $ [[DollarPlus|$+]] [[$right]](%id,-2) , %dbl = 1 }
[[If-Then-Else|if]] ([[$mid]](%id,2,1) == !) { [[Local_Variables|var]] %id = $ [[DollarPlus|$+]] [[$right]](%id,-2) , %ex = 1 }
[[If-Then-Else|if]] ([[$mid]](%id,2,1) isnum 1-) { [[Local_Variables|var]] %n = %id , %id = [[$!]][[$1-|1]] }
[[If-Then-Else|if]] ([[$read]](identifiers.txt,nw,%id *)) { [[Local_Variables|var]] %link = [[$gettok]]([[$v1]],2,32) }
[[If-Then-Else|elseif]] ([[$right]](%id,1) == [[$chr]](40)) {
[[Local_Variables|var]] %id = [[$left]](%id,-1) , %br = 1
[[If-Then-Else|if]] ([[$read]](identifiers.txt,nw,%id *)) { [[Local_Variables|var]] %link = [[$gettok]]([[$v1]],2,32) }
[[If-Then-Else|elseif]] ([[$read]](identifiers.txt,nw,%id [[DollarPlus|$+]] *)) { [[Local_Variables|var]] %link = [[$gettok]]([[$v1]],2,32) }
}
[[If-Then-Else|elseif]] ([[$read]](identifiers.txt,nw,%id [[DollarPlus|$+]] *)) { [[Local_Variables|var]] %link = [[$gettok]]([[$v1]],2,32) }
[[If-Then-Else|if]] (%link == [[$null]]) { [[return]] [[$1-|$1]] }
[[Local_Variables|var]] %link = [[$iif]]((%link != %id) || (%n),%link [[DollarPlus|$+]] [[$chr]](124)) , %id = [[$iif]](%n,%n,%id)
[[If-Then-Else|if]] (%dbl) { [[Local_Variables|var]] %ret = [[DollarPlus|$+]]([[$chr]](91),[[$chr]](91),[[$$]],[[$chr]](93),[[$chr]](93),[[$iif]](%ex,[[DollarPlus|$+]]([[$chr]](91),[[$chr]](91),!,[[$chr]](93),[[$chr]](93)))) }
[[If-Then-Else|elseif]] (%ex) { [[Local_Variables|var]] %ret = [[DollarPlus|$+]]([[$chr]](91),[[$chr]](91),$,!,[[$chr]](93),[[$chr]](93)) }
; echo -ag return: $+(%ret,$chr(91),$chr(91),%link,$iif(%dbl || %ex,$right(%id,-1),%id),$chr(93),$chr(93),$iif(%br,$chr(40)))
[[return]] [[DollarPlus|$+]](%ret,[[$chr]](91),[[$chr]](91),%link,[[$iif]](%dbl || %ex,[[$right]](%id,-1),%id),[[$chr]](93),[[$chr]](93),[[$iif]](%br,[[$chr]](40)))
}

commands.txt
Abook Abook
Ajinvite Ajinvite
Alias Alias
Aline Aline
Ame Ame
Amsg Amsg
Anick Anick
Aop Aop
Auser Auser
Autojoin Autojoin
Avoice Avoice
Background Background
Ban Ban
Bcopy Bcopy
Beep Beep
Bread Bread
Break Break
Breplace Breplace
Bset Bset
Btrunc Btrunc
Bunset Bunset
Bwrite Bwrite
Channel Channel
Clear Clear
Clearall Clearall
Clipboard Clipboard
Close Close
Cnick Cnick
Color Color
Continue Continue
Copy Copy
Ctcp Ctcp
Ctcpreply Ctcpreply
Ctcps Ctcps
Dde Dde
Ddeserver Ddeserver
Debug Debug
Dec Dec
Describe Describe
Did Did
Disconnect Disconnect
Dlevel Dlevel
Dns Dns
Dqwindow Dqwindow
Ebeeps Ebeeps
Echo Echo
Editbox Editbox
Else If-Then-Else
Elseif If-Then-Else
Emailaddr Emailaddr
Enable Enable
Events Events
Exit Exit
Fclose Fclose
Filter Filter
Findtext Findtext
Firewall Firewall
Flash Flash
Flist Flist
Flood Flood
Flush Flush
Flushini Flushini
Fopen Fopen
Fseek Fseek
Fullname Fullname
Fwrite Fwrite
Goto Goto
Groups Groups
Guser Guser
Hadd Hadd
Haltdef Haltdef
Hdec Hdec
Hdel Hdel
Help Help
Hfree Hfree
Hinc Hinc
Hload Hload
Hmake Hmake
Hop Hop
Hsave Hsave
Ial Ial
Ialclear Ialclear
Ialmark Ialmark
If If-Then-Else
Ignore Ignore
Inc Inc
Iuser Iuser
Join Join
Linesep Linesep
Load Load
Loadbuf Loadbuf
Localinfo Localinfo
Log Log
Menubar Menubar
Mkdir Mkdir
Mnick Mnick
Msg Msg
Noop Noop
Notify Notify
Omsg Omsg
Onotice Onotice
Partall Partall
Play Play
Pop Pop
Protect Protect
Pvoice Pvoice
Qme Qme
Qmsg Qmsg
Query Query
Queryrn Queryrn
Remini Remini
Remote Remote
Remove Remove
Rename Rename
Resetidle Resetidle
Return Return
Rlevel Rlevel
Rmdir Rmdir
Run Run
Ruser Ruser
Save Save
Saveini Saveini
Say Say
Server Server
Set Set
Setlayer Setlayer
Signal Signal
Sockaccept Sockaccept
Sockclose Sockclose
Socklist Socklist
Socklisten Socklisten
Sockmark Sockmark
Sockopen Sockopen
Sockread Sockread
Sockrename Sockrename
Sockudp Sockudp
Sockwrite Sockwrite
Speak Speak
Switchbar Switchbar
Timer Timer
Timers Timers
Timestamp Timestamp
Titlebar Titlebar
Tnick Tnick
Tokenize Tokenize
Toolbar Toolbar
Treebar Treebar
Ulist Ulist
Unset Unset
Unsetall Unsetall
Updatenl Updatenl
Userhost Userhost
Uwho Uwho
Var Local_Variables
Vol Vol
While While loops
Winhelp Winhelp
Write Write
Writeini Writeini

identifiers.txt
$$ $$
$& $&
$* $*
$0 $0
$1 $1-
$abook $abook
$abs $abs
$acos $acos
$active $active
$activecid $activecid
$activewid $activewid
$adate $adate
$address( $address_(nick)
$address $address_(remote)
$addtok $addtok
$addtokcs $addtokcs
$agent $agent
$agentname $agentname
$agentstat $agentstat
$agentver $agentver
$alias $alias
$and $and
$anick $anick
$aop $aop
$appactive $appactive
$appstate $appstate
$asc $asc
$asctime $asctime
$asin $asin
$atan $atan
$avoice $avoice
$away $away
$awaymsg $awaymsg
$awaytime $awaytime
$base $base
$beta $beta
$bfind $bfind
$bitoff $bitoff
$biton $biton
$bits $bits
$bvar $bvar
$bytes $bytes
$calc $calc
$cb $cb
$cd $cd
$ceil $ceil
$chan( $chan_(window)
$chan $chan_(remote)
$chanmodes $chanmodes
$chantypes $chantypes
$chat $chat
$chr $chr
$cid $cid
$clevel $clevel
$click $click
$cmdbox $cmdbox
$cmdline $cmdline
$cnick $cnick
$color $color
$comchan $comchan
$compact $compact
$cos $cos
$count $count
$cr $cr
$crc $crc
$crlf $crlf
$ctime $ctime
$ctrlenter $ctrlenter
$date $date
$day $day
$daylight $daylight
$dde $dde
$ddename $ddename
$decode $decode
$deltok $deltok
$devent $devent
$dialog $dialog
$did $did
$disk $disk
$dlevel $dlevel
$dname $dname
$duration $duration
$ebeeps $ebeeps
$editbox $editbox
$encode $encode
$error $error
$eval $eval
$evalnext $evalnext
$exists $exists
$file $file
$filename $filename
$filtered $filtered
$finddir $finddir
$finddirn $finddirn
$findfile $findfile
$findfilen $findfilen
$findtok $findtok
$findtokcs $findtokcs
$fline $fline
$floor $floor
$fserve $fserve
$fulldate $fulldate
$fullname $fullname
$fullscreen $fullscreen
$getdir $getdir
$getdot $getdot
$gettok $gettok
$gmt $gmt
$hfind $hfind
$hget $hget
$highlight $highlight
$hmac $hmac
$hnick $hnick
$hotp $hotp
$host $host
$hotline $hotline
$hotlinepos $hotlinepos
$ial $ial
$ibl $ibl
$idle $idle
$iel $iel
$ifmatch $ifmatch
$ignore $ignore
$iif $iif
$iil $iil
$inellipse $inellipse
$ini $ini
$inpoly $inpoly
$inrect $inrect
$inroundrect $inroundrect
$insong $insong
$instok $instok
$int $int
$ip $ip
$isalias $isalias
$isbit $isbit
$isdde $isdde
$isdir $isdir
$isfile $isfile
$isid $isid
$islower $islower
$istok $istok
$istokcs $istokcs
$isupper $isupper
$lactivecid $lactivecid
$left $left
$len $len
$level $level
$lf $lf
$line $line
$lines $lines
$lock $lock
$locked $locked
$log $log
$logdir $logdir
$logstamp $logstamp
$logstampfmt $logstampfmt
$longfn $longfn
$longip $longip
$lower $lower
$maddress $maddress
$mask $mask
$matchtok $matchtok
$matchtokcs $matchtokcs
$md5 $md5
$me $me
$menubar $menubar
$mid $mid
$mircdir $mircdir
$mircexe $mircexe
$mircini $mircini
$mklogfn $mklogfn
$mklogfn $mklogfn
$mnick $mnick
$mode $mode
$modespl $modespl
$mouse $mouse
$msfile $msfile
$network $network
$nick( $nick_(nick)
$nick $nick_(remote)
$nofile $nofile
$nopath $nopath
$not $not
$notags $notags
$notify $notify
$null $null
$numtok $numtok
$online $online
$onpoly $onpoly
$opnick $opnick
$or $or
$ord $ord
$os $os
$pi $pi
$pi $pi
$pic $pic
$play $play
$port $port
$portable $portable
$portfree $portfree
$pos $pos
$prefix $prefix
$prop $prop
$protect $protect
$puttok $puttok
$qt $qt
$rand $rand
$rawmsg $rawmsg
$read $read
$readini $readini
$readn $readn
$regex $regex
$regml $regml
$regsub $regsub
$regsubex $regsubex
$remote $remote
$remove $remove
$remtok $remtok
$remtokcs $remtokcs
$replace $replace
$replacecs $replacecs
$replacex $replacex
$replacexcs $replacexcs
$reptok $reptok
$reptokcs $reptokcs
$result $result
$rgb $rgb
$right $right
$round $round
$scid $scid
$scon $scon
$scriptdir $scriptdir
$sdir $sdir
$server $server
$serverip $serverip
$sfile $sfile
$sha1 $sha1
$sha256 $sha256
$sha384 $sha1
$sha512 $sha512
$shortfn $shortfn
$show $show
$signal $signal
$sin $sin
$sline $sline
$snick $snick
$snicks $snicks
$snotify $snotify
$sock $sock
$sockname $sockname
$sorttok $sorttok
$sorttokcs $sorttokcs
$sqrt $sqrt
$ssl $ssl
$sslready $sslready
$status $status
$str $str
$strip $strip
$style $style
$submenu $submenu
$switchbar $switchbar
$tan $tan
$ticks $ticks
$time $time
$timestamp $timestamp
$timestampfmt $timestampfmt
$timezone $timezone
$tip $tip
$toolbar $toolbar
$treebar $treebar
$true $true
$trust $trust
$ulevel $ulevel
$ulist $ulist
$upper $upper
$uptime $uptime
$v1 $v1
$v2 $v1
$version $version
$vnick $vnick
$vol $vol
$width $width
$wildtok $wildtok
$wildtokcs $wildtokcs
$window( $window_(remote)
$window $window_(picwin)
$wrap $wrap
$xor $xor
$+ DollarPlus

[[Category:Wiki]]

ChallengeAuth

2015-07-18T13:01:25Z

NaNg: Challenge auth 2.0 script based on mIRC 7.42 new identifiers.

$window (remote)

2014-10-09T12:41:29Z

NaNg: special windows.

Returns information about a window.

$window(N|window name|@WID)
* Takes either the position of the window (if N=0, returns the number of windows), the name/wildtext of the window, or the window's Window ID. If wildtext is specified, a second N property can be specified ($window(wildtext,N))
* If no property is given, returns the window name or number of windows (For N=0)
* Special windows use negative numbers as follow:
** -1 = Desktop
** -2 = mIRC window
** -3 = MDI window
* There are several properties for $window:
** .x Returns the window's top left corner X coordinate (Relative to mIRC)
** .y Returns the window's top left corner Y coordinate (Relative to mIRC)
** .w Returns the window's width in pixels
** .h Returns the window's height in pixels
** .dx Returns the window's top left corner X coordinate (Relative to the desktop)
** .dy Returns the window's top left corner Y coordinate (Relative to the desktop)
** .dw Returns the window's text display area's width.
** .dh Returns the window's text display area's height.
** .bw Returns the width of the bitmap in a [[:Category:Picture Windows|graphic window]]
** .bh Returns the height of the bitmap in a [[:Category:Picture Windows|graphic window]]
** .mdi returns [[$true]] if the window is inside the mdi, in other words, if it is a child window of mIRC or on the desktop.
** .state returns the windows state: minimized, maximized, hidden or normal
** .title returns the text in the title of a window. Can be set using [[titlebar]]
** .font returns the window's current font name
** .fontsize returns the window's current font's size
** .fontbold returns [[$true]] if the window's current font is bold.
** .fontcs returns the window's current font's character set.
** .logfile returns the full path for the window's log file, or [[$null]] if there is none.
** .icon returns on or off, depending on whether or not the window's icon is visible
** .ontop returns [[$true]] if this window is set to be always on top.
** .type Returns the window type, such as "channel" "status" or "custom"
** .anysc Returns [[$true]] if created with [[window]] -i (Set to be associated with the active server, always).
** .wid Returns the window ID.
** .cid Returns the [[:Category:multi-server|connection ID]].
** .sbtext Returns the text for this window on the switchbar button.
** .sbcolor Returns the highligt color for this window as shown on the swichbar
** .sbstate Returns the state for this window on the switchbar
** .tbstate Returns the state for this window on the treebar

[[Category:Window Identifiers]][[Category:Custom Windows]][[Category:Remote Identifiers]]

How to parse HL log data

2013-10-25T14:26:36Z

NaNg: Bad rcon fix

; HL Log Listener snippet by NaNg
; Date: 11-06-2011
; Tested on mIRC 7.19
;
; HL Log window for HL log based engines (HL1, Source etc.),
; Based on the HL Log Standard found at http://developer.valvesoftware.com/wiki/HL_Log_Standard
;
; ==================== NOTE! ====================
; This does NOT query the server to start logging, this should be done on your end, by sending
; this command to the server:
; logaddress_add <listening_ip> <listening_port>
; <listening_port> should be the same in this command as well as in the /hllog command.
;
; This snippet was built based on CS (1.6) logs, therefore only two team colors exist (besides default).
; You can easly add more team colors by adding them to the $hllog.teamcolor alias found here.
;
; Usage:
; * /hllog <ip> <port> <listening_port>

[[alias]] hllog {
; Validate arguments (simple, no need for full validation).
[[If-Then-Else|if]] ((![[$longip]]([[$1-|$1]])) || ([[$1-|$2]] !isnum 1-65536) || ([[$1-|$3]] !isnum 1-65536)) {
[[echo]] -ag hllog: Invalid parameters.
[[return]]
}

; Save the server's address.
[[Local_Variables|var]] %server.addr = [[DollarPlus|$+]]([[$1-|$1]],:,[[$1-|$2]])

; Check that the user has not opened a HL log window for the same server already.
; This makes sure that the user won't have a log step over another log for the same server.
[[If-Then-Else|if]] ([[$window_(remote)|$window(]]%server.addr)) {
[[echo]] -ag HL log window for %server.addr is already open! close it before trying.
[[return]]
}

; Open the HL log window whilst activating it, hide the @ prefix and maximize it.
window -ak0x @ [[DollarPlus|$+]] %server.addr
[[aline]] 12 @ [[DollarPlus|$+]] %server.addr HL log window, now listening to: %server.addr

; Set the socket name we'll use.
[[Local_Variables|var]] %sockname = [[DollarPlus|$+]]($hllog.prefix, %server.addr)

; Start listening to HL logs from the server.
[[sockudp]] -k %sockname [[$1-|$3]] [[$1-|$1]] [[$1-|$2]]
}

; Parses the given player.
[[alias]] hlplayer {
[[If-Then-Else|if]] (![[$regex]]([[$1-|$1-]], /"(.*?)<([^>]*)><([^>]*)><([^>]*)>"/)) {
[[echo]] -ag hlpalyer: Invalid parameters.
[[return]]
}

[[If-Then-Else|if]] ([[$prop]] == name) { [[return]] [[$regml]](1) }
[[If-Then-Else|elseif]] ([[$prop]] == id) { [[return]] [[$regml]](2) }
[[If-Then-Else|elseif]] ([[$prop]] == authid) { [[return]] [[$regml]](3) }
[[If-Then-Else|elseif]] ([[$prop]] == team) { [[return]] [[$regml]](4) }

[[return]] [[$true]]
}

; Gets the given property's value.
[[alias]] -l hllog.prop {
; Number of keys is requested.
[[If-Then-Else|if]] ([[$$]][[$1-|2]] == 0) {
[[return]] [[$regex]]([[$1-|$1]], /$(\S+)(?: "([^"]*)"|())$/g)
}

[[If-Then-Else|if]] ([[$regex]]([[$1-|$1]], /$( [[DollarPlus|$+]] [[$1-|$2]] [[DollarPlus|$+]] )(?: "([^"]*)"|())$/i)) {
[[return]] [[$iif]]([[$regml]](2) == [[$null]], [[$true]], [[$ifmatch]])
}

[[return]] [[$null]]
}

; Get the team's corresponding color.
[[alias]] -l hllog.teamcolor {
[[If-Then-Else|if]] ([[$1-|$1]] == CT) { [[return]] 12 }
[[If-Then-Else|elseif]] ([[$1-|$1]] == TERRORIST) { [[return]] 04 }

; Default color if team is not recognized.
[[return]] 14
}

[[alias]] -l hllog.prefix { [[return]] hllog }

; If the user has closed the HL log window, clear the socket.
on *:CLOSE:@: {
; If there's a socket named accordingly, close it.
[[If-Then-Else|if]] ([[$sock]]([[DollarPlus|$+]]($hllog.prefix, [[$remove]]($target, @)))) {
[[sockclose]] [[DollarPlus|$+]]($hllog.prefix, [[$remove]]($target, @))
}
}

on *:UDPREAD:$([[DollarPlus|$+]]($hllog.prefix, *)): {
; Get the window name for the current game server.
[[Local_Variables|var]] %hllog.window = [[DollarPlus|$+]](@, [[$remove]]([[$sockname]], $hllog.prefix))

; If there were errors, $sockerr will tell us so.
; Write the error message to the window and clear the connection.
[[If-Then-Else|if]] ($sockerr) {
[[aline]] 04 %hllog.window * Error: Reading from socket: [[$sock]]([[$sockname]]).wsmsg
[[sockclose]] [[$sockname]]
[[return]]
}

[[Sockread|sockread]] -f %hllog.value

; Separate the server log time and the log line itself.
[[noop]] [[$regex]](%hllog.value, /L ((?:0[1-9]|1[0-2])/(?:0[1-9]|[12][0-9]|3[01])/[0-9]{4} - (?:[01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]): (.*)[\n\r\0]*$/)

; Invalid log line.
[[If-Then-Else|if]] ([[$regml]](0) == 0) { [[return]] }

; Get the server log time (usually un-needed. if you do need it - uncomment the next line).
; var %hllog.time = $regml(1)
[[Local_Variables|var]] %hllog.cmd = [[$regml]](2)

; If the command is a comment, disregard it.
[[If-Then-Else|if]] (//* iswm %hllog.cmd) { [[return]] }

; Server cvar change (event 001b).
[[If-Then-Else|elseif]] (server cvar* iswm %hllog.cmd) {
[[noop]] [[$regex]](%hllog.cmd, /^Server cvar "([^"]+)" = "([^"]+)"(.*)$/i)

; If the line was succesfully parsed.
[[If-Then-Else|if]] ([[$regml]](0) > 0) {
[[Local_Variables|var]] %cvar.name = [[$regml]](1)
[[Local_Variables|var]] %cvar.value = [[$regml]](2)
; var %hllog.props = $regml(3)

[[aline]] 3 %hllog.window Cvar " [[DollarPlus|$+]] %cvar.name [[DollarPlus|$+]] " has been changed, new value: " [[DollarPlus|$+]] %cvar.value [[DollarPlus|$+]] "
}
}

; Rcon (events 004a and 004b).
[[If-Then-Else|elseif]] ((Bad Rcon:* iswm %hllog.cmd) || (Rcon:* iswm %hllog.cmd)) {
[[noop]] [[$regex]](%hllog.cmd, /^((?:Bad )?)Rcon: "[^"]+ ([^"]+) "([^"]+)" (.*)" [^"\x28]+ "([^"]+:[^"]+)"(.*)$/i)

; Parse the event's details.
[[Local_Variables|var]] %hllog.badrcon = [[$iif]]([[$regml]](1) == [[$null]], $false, [[$true]])
; var %hllog.challenge = $regml(2)
; var %hllog.rconpwd = $regml(3)
[[Local_Variables|var]] %hllog.rconcmd = [[$regml]](4)
[[Local_Variables|var]] %hllog.sender = [[$regml]](5)
; var %hllog.props = $regml(6)

[[aline]] 4 %hllog.window [[$iif]](%hllog.badrcon, Bad) RCON: %hllog.rconcmd (from: %hllog.sender [[DollarPlus|$+]] )
}

; Player got kicked (event 052b).
[[If-Then-Else|elseif]] (Kick:* iswm %hllog.cmd) {
[[noop]] [[$regex]](%hllog.cmd, /^Kick: ("[^"]+") ([^"]+) "([^"]+)"(.*)$/i)

; Parse the event's details.
[[Local_Variables|var]] %hllog.player = [[$regml]](1)
; var %hllog.noun = $regml(2)
[[Local_Variables|var]] %hllog.kicker = [[$regml]](3)
[[Local_Variables|var]] %hllog.props = [[$regml]](4)

[[aline]] 4 %hllog.window [[DollarPlus|$+]]([[$chr]](3), $hllog.teamcolor($hlplayer(%hllog.player).team), $hlplayer(%hllog.player).name, [[$chr]](15)) was kicked by %hllog.kicker with reason: [[DollarPlus|$+]](", $hllog.prop(%hllog.props, message), ")
}

; Team score report (event 065).
[[If-Then-Else|elseif]] ([[$regex]](%hllog.cmd, /^Team "([^"]+)" ([^"\x28]+) "([^"]+)" ([^"\x28]+) "([^"]+)"(.*)$/i)) {
[[Local_Variables|var]] %hllog.team = [[$regml]](1)
[[Local_Variables|var]] %hllog.score = [[$regml]](3)
[[Local_Variables|var]] %hllog.numPlayers = [[$regml]](5)
[[Local_Variables|var]] %hllog.props = [[$regml]](7)

[[aline]] 3 %hllog.window Team [[DollarPlus|$+]]([[$chr]](3), $hllog.teamcolor(%hllog.team), %hllog.team, [[$chr]](15)) scored %hllog.score with %hllog.numPlayers players %hllog.props
}

; Player score report (event 067).
[[If-Then-Else|elseif]] ([[$regex]](%hllog.cmd, /^Player ("[^"]+") ([^"\x28]+) "([^"]+)"(.*)$/i)) {
[[Local_Variables|var]] %hllog.player = [[$regml]](1)
[[Local_Variables|var]] %hllog.score = [[$regml]](3)
[[Local_Variables|var]] %hllog.props = [[$regml]](4)

[[aline]] 3 %hllog.window Player [[DollarPlus|$+]]([[$chr]](3), $hllog.teamcolor($hlplayer(%hllog.player).team), $hlplayer(%hllog.player).name, [[$chr]](15)) scored %hllog.score %hllog.props
}

; Events 057, 058, 059, 066.
[[If-Then-Else|elseif]] ([[$regex]](%hllog.cmd, /^("[^"]+") ([^"\x28]+) ("[^"]+") ([^"\x28]+) ("[^"]+")(.*)$/)) {
[[Local_Variables|var]] %hllog.firstEvent = [[$regml]](2)
; var %hllog.secondEvent = $regml(4)
[[Local_Variables|var]] %hllog.firstPlayer = [[$regml]](1)

[[If-Then-Else|if]] (%hllog.firstEvent == triggered) {
[[Local_Variables|var]] %hllog.secondPlayer = [[$regml]](5)
[[Local_Variables|var]] %hllog.noun = [[$remove]]([[$regml]](3), ")
}
[[If-Then-Else|else]] {
[[Local_Variables|var]] %hllog.secondPlayer = [[$regml]](3)
[[Local_Variables|var]] %hllog.noun = [[$remove]]([[$regml]](5), ")
}

[[Local_Variables|var]] %hllog.props = [[$regml]](6)

[[aline]] 1 %hllog.window [[DollarPlus|$+]]([[$chr]](3), $hllog.teamcolor($hlplayer(%hllog.firstPlayer).team), $hlplayer(%hllog.firstPlayer).name, [[$chr]](15)) %hllog.firstEvent [[DollarPlus|$+]]([[$chr]](3), $hllog.teamcolor($hlplayer(%hllog.secondPlayer ).team), $hlplayer(%hllog.secondPlayer ).name, [[$chr]](15)) with: [[DollarPlus|$+]](", [[$replace]](%hllog.noun, _, [[$chr]](32)), ") [[$iif]]($hllog.prop(%hllog.props, headshot), (headshot))
}

; Events 050, 053, 054, 055, 056, 060, 063a, 063b, 068, 069.
[[If-Then-Else|elseif]] ([[$regex]](%hllog.cmd, /^("[^"]+") ([^"\x28]+) "([^"]+)"(.*)$/)) {
[[Local_Variables|var]] %hllog.player = [[$regml]](1)
[[Local_Variables|var]] %hllog.event = [[$regml]](2)
[[Local_Variables|var]] %hllog.noun = [[$regml]](3)
[[Local_Variables|var]] %hllog.props = [[$regml]](4)
[[Local_Variables|var]] %hllog.team = $hlplayer(%hllog.player).team

[[If-Then-Else|if]] (%hllog.event == say) {
[[aline]] 7 %hllog.window [[DollarPlus|$+]]([[$chr]](3), $hllog.teamcolor(%hllog.team), $hlplayer(%hllog.player).name, [[$chr]](15)) [[DollarPlus|$+]](says:, [[$chr]](3), 1) %hllog.noun
}
[[If-Then-Else|elseif]] (%hllog.event == say_team) {
[[aline]] 7 %hllog.window [[DollarPlus|$+]]([[$chr]](3), $hllog.teamcolor(%hllog.team), $hlplayer(%hllog.player).name, [[$chr]](15)) [[DollarPlus|$+]](team says:, [[$chr]](3), 1) %hllog.noun
}
[[If-Then-Else|else]] {
[[aline]] 1 %hllog.window [[DollarPlus|$+]]([[$chr]](3), $hllog.teamcolor(%hllog.team), $hlplayer(%hllog.player).name, [[$chr]](15)) %hllog.event [[DollarPlus|$+]](", [[$replace]](%hllog.noun, _, [[$chr]](32)), ") %hllog.props
}
}

; Events 050b, 051, 052.
[[If-Then-Else|elseif]] ([[$regex]](%hllog.cmd, /^("[^"]+") ([^\x28]+)(.*)$/)) {
[[Local_Variables|var]] %hllog.player = [[$regml]](1)
[[Local_Variables|var]] %hllog.event = [[$regml]](2)
; var %hllog.props = $regml(3)
[[Local_Variables|var]] %hllog.team = $hlplayer(%hllog.player).team

[[aline]] 1 %hllog.window [[DollarPlus|$+]]([[$chr]](3), $hllog.teamcolor(%hllog.team), $hlplayer(%hllog.player).name, [[$chr]](15)) %hllog.event
}

; Events 061, 064.
[[If-Then-Else|elseif]] ([[$regex]](%hllog.cmd, /^Team "([^"]+)" ([^"\x28]+) "([^"]+)"(.*)$/i)) {
[[Local_Variables|var]] %hllog.team = [[$regml]](1)
[[Local_Variables|var]] %hllog.event = [[$regml]](2)
[[Local_Variables|var]] %hllog.noun = [[$regml]](3)
; var %hllog.props = $regml(4)

[[aline]] 1 %hllog.window [[DollarPlus|$+]]([[$chr]](3), $hllog.teamcolor(%hllog.team), %hllog.team, [[$chr]](15)) %hllog.event [[DollarPlus|$+]](", [[$replace]](%hllog.noun, _, [[$chr]](32)), ")
}

; Events 062, 003a, 003b, 005, 006.
[[If-Then-Else|elseif]] ([[$regex]](%hllog.cmd, /^([^"\x28]+) "([^"]+)"(.*)$/)) {
[[Local_Variables|var]] %hllog.event = [[$regml]](1)
[[Local_Variables|var]] %hllog.noun = [[$regml]](2)
[[Local_Variables|var]] %hllog.props = [[$regml]](3)

[[If-Then-Else|if]] (%hllog.event == server say) {
[[aline]] 7 %hllog.window Server [[DollarPlus|$+]](says:, [[$chr]](3), 1) %hllog.noun
}
[[If-Then-Else|else]] {
[[aline]] 1 %hllog.window %hllog.event [[DollarPlus|$+]](", [[$replace]](%hllog.noun, _, [[$chr]](32)), ") %hllog.props
}
}

; Events 001a, 001c, 002a, 002b.
[[If-Then-Else|elseif]] ([[$regex]](%hllog.cmd, /^([^"\x28]+)(.*)$/)) {
[[Local_Variables|var]] %hllog.event = [[$regml]](1)
; var %hllog.props = $regml(2)

[[aline]] 1 %hllog.window %hllog.event
}
}

== See also ==
* [[How to query a CS Server]]
* [[How to RCON an HL1 engine based server]]
* [[How to RCON a source engine based server]]
* [http://developer.valvesoftware.com/wiki/HL_Log_Standard HL Log Standard on valvesoftware]

[[Category:Tutorials]]
[[Category:Socket]]

How to parse HL log data

2013-10-25T13:49:55Z

NaNg: Fixed log parse

; HL Log Listener snippet by NaNg
; Date: 11-06-2011
; Tested on mIRC 7.19
;
; HL Log window for HL log based engines (HL1, Source etc.),
; Based on the HL Log Standard found at http://developer.valvesoftware.com/wiki/HL_Log_Standard
;
; ==================== NOTE! ====================
; This does NOT query the server to start logging, this should be done on your end, by sending
; this command to the server:
; logaddress_add <listening_ip> <listening_port>
; <listening_port> should be the same in this command as well as in the /hllog command.
;
; This snippet was built based on CS (1.6) logs, therefore only two team colors exist (besides default).
; You can easly add more team colors by adding them to the $hllog.teamcolor alias found here.
;
; Usage:
; * /hllog <ip> <port> <listening_port>

[[alias]] hllog {
; Validate arguments (simple, no need for full validation).
[[If-Then-Else|if]] ((![[$longip]]([[$1-|$1]])) || ([[$1-|$2]] !isnum 1-65536) || ([[$1-|$3]] !isnum 1-65536)) {
[[echo]] -ag hllog: Invalid parameters.
[[return]]
}

; Save the server's address.
[[Local_Variables|var]] %server.addr = [[DollarPlus|$+]]([[$1-|$1]],:,[[$1-|$2]])

; Check that the user has not opened a HL log window for the same server already.
; This makes sure that the user won't have a log step over another log for the same server.
[[If-Then-Else|if]] ([[$window_(remote)|$window(]]%server.addr)) {
[[echo]] -ag HL log window for %server.addr is already open! close it before trying.
[[return]]
}

; Open the HL log window whilst activating it, hide the @ prefix and maximize it.
window -ak0x @ [[DollarPlus|$+]] %server.addr
[[aline]] 12 @ [[DollarPlus|$+]] %server.addr HL log window, now listening to: %server.addr

; Set the socket name we'll use.
[[Local_Variables|var]] %sockname = [[DollarPlus|$+]]($hllog.prefix, %server.addr)

; Start listening to HL logs from the server.
[[sockudp]] -k %sockname [[$1-|$3]] [[$1-|$1]] [[$1-|$2]]
}

; Parses the given player.
[[alias]] hlplayer {
[[If-Then-Else|if]] (![[$regex]]([[$1-|$1-]], /"(.*?)<([^>]*)><([^>]*)><([^>]*)>"/)) {
[[echo]] -ag hlpalyer: Invalid parameters.
[[return]]
}

[[If-Then-Else|if]] ([[$prop]] == name) { [[return]] [[$regml]](1) }
[[If-Then-Else|elseif]] ([[$prop]] == id) { [[return]] [[$regml]](2) }
[[If-Then-Else|elseif]] ([[$prop]] == authid) { [[return]] [[$regml]](3) }
[[If-Then-Else|elseif]] ([[$prop]] == team) { [[return]] [[$regml]](4) }

[[return]] [[$true]]
}

; Gets the given property's value.
[[alias]] -l hllog.prop {
; Number of keys is requested.
[[If-Then-Else|if]] ([[$$]][[$1-|2]] == 0) {
[[return]] [[$regex]]([[$1-|$1]], /$(\S+)(?: "([^"]*)"|())$/g)
}

[[If-Then-Else|if]] ([[$regex]]([[$1-|$1]], /$( [[DollarPlus|$+]] [[$1-|$2]] [[DollarPlus|$+]] )(?: "([^"]*)"|())$/i)) {
[[return]] [[$iif]]([[$regml]](2) == [[$null]], [[$true]], [[$ifmatch]])
}

[[return]] [[$null]]
}

; Get the team's corresponding color.
[[alias]] -l hllog.teamcolor {
[[If-Then-Else|if]] ([[$1-|$1]] == CT) { [[return]] 12 }
[[If-Then-Else|elseif]] ([[$1-|$1]] == TERRORIST) { [[return]] 04 }

; Default color if team is not recognized.
[[return]] 14
}

[[alias]] -l hllog.prefix { [[return]] hllog }

; If the user has closed the HL log window, clear the socket.
on *:CLOSE:@: {
; If there's a socket named accordingly, close it.
[[If-Then-Else|if]] ([[$sock]]([[DollarPlus|$+]]($hllog.prefix, [[$remove]]($target, @)))) {
[[sockclose]] [[DollarPlus|$+]]($hllog.prefix, [[$remove]]($target, @))
}
}

on *:UDPREAD:$([[DollarPlus|$+]]($hllog.prefix, *)): {
; Get the window name for the current game server.
[[Local_Variables|var]] %hllog.window = [[DollarPlus|$+]](@, [[$remove]]([[$sockname]], $hllog.prefix))

; If there were errors, $sockerr will tell us so.
; Write the error message to the window and clear the connection.
[[If-Then-Else|if]] ($sockerr) {
[[aline]] 04 %hllog.window * Error: Reading from socket: [[$sock]]([[$sockname]]).wsmsg
[[sockclose]] [[$sockname]]
[[return]]
}

[[Sockread|sockread]] -f %hllog.value

; Separate the server log time and the log line itself.
[[noop]] [[$regex]](%hllog.value, /L ((?:0[1-9]|1[0-2])/(?:0[1-9]|[12][0-9]|3[01])/[0-9]{4} - (?:[01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]): (.*)[\n\r\0]*$/)

; Invalid log line.
[[If-Then-Else|if]] ([[$regml]](0) == 0) { [[return]] }

; Get the server log time (usually un-needed. if you do need it - uncomment the next line).
; var %hllog.time = $regml(1)
[[Local_Variables|var]] %hllog.cmd = [[$regml]](2)

; If the command is a comment, disregard it.
[[If-Then-Else|if]] (//* iswm %hllog.cmd) { [[return]] }

; Server cvar change (event 001b).
[[If-Then-Else|elseif]] (server cvar* iswm %hllog.cmd) {
[[noop]] [[$regex]](%hllog.cmd, /^Server cvar "([^"]+)" = "([^"]+)"(.*)$/i)

; If the line was succesfully parsed.
[[If-Then-Else|if]] ([[$regml]](0) > 0) {
[[Local_Variables|var]] %cvar.name = [[$regml]](1)
[[Local_Variables|var]] %cvar.value = [[$regml]](2)
; var %hllog.props = $regml(3)

[[aline]] 3 %hllog.window Cvar " [[DollarPlus|$+]] %cvar.name [[DollarPlus|$+]] " has been changed, new value: " [[DollarPlus|$+]] %cvar.value [[DollarPlus|$+]] "
}
}

; Rcon (events 004a and 004b).
[[If-Then-Else|elseif]] ((Bad Rcon:* iswm %hllog.cmd) || (Rcon:* iswm %hllog.cmd)) {
[[noop]] [[$regex]](%hllog.cmd, /^(Bad )?Rcon: "[^"]+ ([^"]+) "([^"]+)" (.*)" [^"\x28]+ "([^"]+:[^"]+)"(.*)$/i)

; Parse the event's details.
[[Local_Variables|var]] %hllog.badrcon = [[$iif]]([[$regml]](1) == [[$null]], $false, [[$true]])
; var %hllog.challenge = $regml(2)
; var %hllog.rconpwd = $regml(3)
[[Local_Variables|var]] %hllog.rconcmd = [[$regml]](4)
[[Local_Variables|var]] %hllog.sender = [[$regml]](5)
; var %hllog.props = $regml(6)

[[aline]] 4 %hllog.window [[$iif]](%hllog.badrcon, Bad) RCON: %hllog.rconcmd (from: %hllog.sender [[DollarPlus|$+]] )
}

; Player got kicked (event 052b).
[[If-Then-Else|elseif]] (Kick:* iswm %hllog.cmd) {
[[noop]] [[$regex]](%hllog.cmd, /^Kick: ("[^"]+") ([^"]+) "([^"]+)"(.*)$/i)

; Parse the event's details.
[[Local_Variables|var]] %hllog.player = [[$regml]](1)
; var %hllog.noun = $regml(2)
[[Local_Variables|var]] %hllog.kicker = [[$regml]](3)
[[Local_Variables|var]] %hllog.props = [[$regml]](4)

[[aline]] 4 %hllog.window [[DollarPlus|$+]]([[$chr]](3), $hllog.teamcolor($hlplayer(%hllog.player).team), $hlplayer(%hllog.player).name, [[$chr]](15)) was kicked by %hllog.kicker with reason: [[DollarPlus|$+]](", $hllog.prop(%hllog.props, message), ")
}

; Team score report (event 065).
[[If-Then-Else|elseif]] ([[$regex]](%hllog.cmd, /^Team "([^"]+)" ([^"\x28]+) "([^"]+)" ([^"\x28]+) "([^"]+)"(.*)$/i)) {
[[Local_Variables|var]] %hllog.team = [[$regml]](1)
[[Local_Variables|var]] %hllog.score = [[$regml]](3)
[[Local_Variables|var]] %hllog.numPlayers = [[$regml]](5)
[[Local_Variables|var]] %hllog.props = [[$regml]](7)

[[aline]] 3 %hllog.window Team [[DollarPlus|$+]]([[$chr]](3), $hllog.teamcolor(%hllog.team), %hllog.team, [[$chr]](15)) scored %hllog.score with %hllog.numPlayers players %hllog.props
}

; Player score report (event 067).
[[If-Then-Else|elseif]] ([[$regex]](%hllog.cmd, /^Player ("[^"]+") ([^"\x28]+) "([^"]+)"(.*)$/i)) {
[[Local_Variables|var]] %hllog.player = [[$regml]](1)
[[Local_Variables|var]] %hllog.score = [[$regml]](3)
[[Local_Variables|var]] %hllog.props = [[$regml]](4)

[[aline]] 3 %hllog.window Player [[DollarPlus|$+]]([[$chr]](3), $hllog.teamcolor($hlplayer(%hllog.player).team), $hlplayer(%hllog.player).name, [[$chr]](15)) scored %hllog.score %hllog.props
}

; Events 057, 058, 059, 066.
[[If-Then-Else|elseif]] ([[$regex]](%hllog.cmd, /^("[^"]+") ([^"\x28]+) ("[^"]+") ([^"\x28]+) ("[^"]+")(.*)$/)) {
[[Local_Variables|var]] %hllog.firstEvent = [[$regml]](2)
; var %hllog.secondEvent = $regml(4)
[[Local_Variables|var]] %hllog.firstPlayer = [[$regml]](1)

[[If-Then-Else|if]] (%hllog.firstEvent == triggered) {
[[Local_Variables|var]] %hllog.secondPlayer = [[$regml]](5)
[[Local_Variables|var]] %hllog.noun = [[$remove]]([[$regml]](3), ")
}
[[If-Then-Else|else]] {
[[Local_Variables|var]] %hllog.secondPlayer = [[$regml]](3)
[[Local_Variables|var]] %hllog.noun = [[$remove]]([[$regml]](5), ")
}

[[Local_Variables|var]] %hllog.props = [[$regml]](6)

[[aline]] 1 %hllog.window [[DollarPlus|$+]]([[$chr]](3), $hllog.teamcolor($hlplayer(%hllog.firstPlayer).team), $hlplayer(%hllog.firstPlayer).name, [[$chr]](15)) %hllog.firstEvent [[DollarPlus|$+]]([[$chr]](3), $hllog.teamcolor($hlplayer(%hllog.secondPlayer ).team), $hlplayer(%hllog.secondPlayer ).name, [[$chr]](15)) with: [[DollarPlus|$+]](", [[$replace]](%hllog.noun, _, [[$chr]](32)), ") [[$iif]]($hllog.prop(%hllog.props, headshot), (headshot))
}

; Events 050, 053, 054, 055, 056, 060, 063a, 063b, 068, 069.
[[If-Then-Else|elseif]] ([[$regex]](%hllog.cmd, /^("[^"]+") ([^"\x28]+) "([^"]+)"(.*)$/)) {
[[Local_Variables|var]] %hllog.player = [[$regml]](1)
[[Local_Variables|var]] %hllog.event = [[$regml]](2)
[[Local_Variables|var]] %hllog.noun = [[$regml]](3)
[[Local_Variables|var]] %hllog.props = [[$regml]](4)
[[Local_Variables|var]] %hllog.team = $hlplayer(%hllog.player).team

[[If-Then-Else|if]] (%hllog.event == say) {
[[aline]] 7 %hllog.window [[DollarPlus|$+]]([[$chr]](3), $hllog.teamcolor(%hllog.team), $hlplayer(%hllog.player).name, [[$chr]](15)) [[DollarPlus|$+]](says:, [[$chr]](3), 1) %hllog.noun
}
[[If-Then-Else|elseif]] (%hllog.event == say_team) {
[[aline]] 7 %hllog.window [[DollarPlus|$+]]([[$chr]](3), $hllog.teamcolor(%hllog.team), $hlplayer(%hllog.player).name, [[$chr]](15)) [[DollarPlus|$+]](team says:, [[$chr]](3), 1) %hllog.noun
}
[[If-Then-Else|else]] {
[[aline]] 1 %hllog.window [[DollarPlus|$+]]([[$chr]](3), $hllog.teamcolor(%hllog.team), $hlplayer(%hllog.player).name, [[$chr]](15)) %hllog.event [[DollarPlus|$+]](", [[$replace]](%hllog.noun, _, [[$chr]](32)), ") %hllog.props
}
}

; Events 050b, 051, 052.
[[If-Then-Else|elseif]] ([[$regex]](%hllog.cmd, /^("[^"]+") ([^\x28]+)(.*)$/)) {
[[Local_Variables|var]] %hllog.player = [[$regml]](1)
[[Local_Variables|var]] %hllog.event = [[$regml]](2)
; var %hllog.props = $regml(3)
[[Local_Variables|var]] %hllog.team = $hlplayer(%hllog.player).team

[[aline]] 1 %hllog.window [[DollarPlus|$+]]([[$chr]](3), $hllog.teamcolor(%hllog.team), $hlplayer(%hllog.player).name, [[$chr]](15)) %hllog.event
}

; Events 061, 064.
[[If-Then-Else|elseif]] ([[$regex]](%hllog.cmd, /^Team "([^"]+)" ([^"\x28]+) "([^"]+)"(.*)$/i)) {
[[Local_Variables|var]] %hllog.team = [[$regml]](1)
[[Local_Variables|var]] %hllog.event = [[$regml]](2)
[[Local_Variables|var]] %hllog.noun = [[$regml]](3)
; var %hllog.props = $regml(4)

[[aline]] 1 %hllog.window [[DollarPlus|$+]]([[$chr]](3), $hllog.teamcolor(%hllog.team), %hllog.team, [[$chr]](15)) %hllog.event [[DollarPlus|$+]](", [[$replace]](%hllog.noun, _, [[$chr]](32)), ")
}

; Events 062, 003a, 003b, 005, 006.
[[If-Then-Else|elseif]] ([[$regex]](%hllog.cmd, /^([^"\x28]+) "([^"]+)"(.*)$/)) {
[[Local_Variables|var]] %hllog.event = [[$regml]](1)
[[Local_Variables|var]] %hllog.noun = [[$regml]](2)
[[Local_Variables|var]] %hllog.props = [[$regml]](3)

[[If-Then-Else|if]] (%hllog.event == server say) {
[[aline]] 7 %hllog.window Server [[DollarPlus|$+]](says:, [[$chr]](3), 1) %hllog.noun
}
[[If-Then-Else|else]] {
[[aline]] 1 %hllog.window %hllog.event [[DollarPlus|$+]](", [[$replace]](%hllog.noun, _, [[$chr]](32)), ") %hllog.props
}
}

; Events 001a, 001c, 002a, 002b.
[[If-Then-Else|elseif]] ([[$regex]](%hllog.cmd, /^([^"\x28]+)(.*)$/)) {
[[Local_Variables|var]] %hllog.event = [[$regml]](1)
; var %hllog.props = $regml(2)

[[aline]] 1 %hllog.window %hllog.event
}
}

== See also ==
* [[How to query a CS Server]]
* [[How to RCON an HL1 engine based server]]
* [[How to RCON a source engine based server]]
* [http://developer.valvesoftware.com/wiki/HL_Log_Standard HL Log Standard on valvesoftware]

[[Category:Tutorials]]
[[Category:Socket]]

Silence

2013-09-08T18:08:48Z

NaNg: Added info according to https://www.quakenet.org/news/227-ircd-upgrade

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 +fishbot,-snailbot
This would silence the nick fishbot and removes silence of the nick snailbot from your silence list.
/silence +~fishbot!*@*
This excludes fishbot from the silence list.
/silence -*
Removes all silences
/silence +!@12.34.56.78/24
Silence also supports CIDRs which are /16 and higher.
/silence +!@authname.users.quakenet.org
This would add a silence to all users authed as "authname".

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

Challenge auth

2013-04-18T14:31:16Z

NaNg: Added a "see also" for hiding your address before joining channels

$ini

2013-01-25T18:35:39Z

NaNg: Thank bindi for noticing and testing :)

Returns the name/Nth position of the specified topic/item in an ini/text file.
$ini(file,topic/N,item/N)

'''Note''' that the item/N parameter is optional. If you specify N = 0, it returns the total number of topics/items.

== Example ==
[[echo]] -a $ini(mirc.ini,0)
Echos the total number of topics in your mirc.ini.
echo -a $ini(mirc.ini,mirc,0)
Echos the total number of items in the topic mirc in your mirc.ini

The following, more complex example shows howto loop through an entire ini file.
; We want to have an alias called ''showini''. At the end, it will be /showini <inifile>
[[alias]] showini {
; echos ini name
echo -a $1
[[var]] %i = 1
; We begin to loop through all topics. $ini($1,0) returns the total number of topics
[[while]] (%i <= $ini($1,0)) {
; echos the name of the current topic
echo -a - $ini($1,%i)
; set a new looping-variable
var %j = 1
; lets begin to loop through all items in the current topic
while (%j <= $ini($1,$ini($1,%i),0)) {
; echo all items in this topic
; $ini($1,$ini($1,%i),%j) returns the item name of the %j's item in the %i's section.
; $ini($1,%i) returns the %i's section name
echo -a -- $ini($1,$ini($1,%i),%j) => [[$readini]]($1,$ini($1,%i),$ini($1,$ini($1,%i),%j))
; increase looping variable
inc %j
}
; increase first looping-variable
inc %i
}
}
== See Also ==
* [[$readini]] to see howto read a single line of an ini.
* [[Writeini|/writeini]] to write to an ini file.

[[Category:File and Directory Identifiers]]
[[Category:Ini]]

How to RCON a source engine based server

2012-12-07T15:45:40Z

NaNg: Added CS:GO to the comments

; Source RCON control snippet by NaNg
; Date: 12-02-2011
; Tested on mIRC 7.14
;
; Remote control window for Source engine based games (e.g. HL2, OrangeBox, CS:S, CS:GO, CSP etc.),
; based on the Source RCON Protocol found at http://developer.valvesoftware.com/wiki/Source_RCON_Protocol
;
; Warning! I couldn't find a perfect way to open the socket nicely everytime it closes, so don't rely on it
; to be connected 24/7 (plus, the socket is closed on the server side every changelevel).
;
; Usage:
; * /sourcercon <ip> <port> <pass>

; Define a prefix for sockent names.
[[alias]] -l srcon.prefix { [[return]] SRcon }

; Set the command requests and response types.
[[alias]] -l srcon.req.execcmd { [[return]] 2 }
[[alias]] -l srcon.req.auth { [[return]] 3 }
[[alias]] -l srcon.res.cmd { [[return]] 0 }
[[alias]] -l srcon.res.auth { [[return]] 2 }

; Turn the given number to a 4-byte number.
[[alias]] -l srcon.inttobytes {
[[tokenize]] 46 [[$longip]]([[$1-|$1]])
[[return]] [[$1-|$4]] [[$1-|$3]] [[$1-|$2]] [[$1-|$1]]
}

; Validates arguments and tries to open the socket to the game server for authentication.
[[alias]] sourcercon {
; Validate arguments (simple, no need for full validation).
[[If-Then-Else|if]] ((![[$longip]]([[$1-|$1]])) || ([[$1-|$2]] !isnum 1-65536) || (![[$1-|$3]])) {
[[echo]] -ag Invalid parameters.
[[return]]
}

; Save the server's address.
[[Local_Variables|var]] %server.addr = [[DollarPlus|$+]]([[$1-|$1]],:,[[$1-|$2]])

; Check that the user has not opened a Rcon window for the same server already.
; This makes sure that the user won't have a Rcon step over another Rcon for the same server.
[[If-Then-Else|if]] ([[$window_(remote)|$window(]]%server.addr)) {
[[echo]] -ag Rcon window for [[$1-|$1]] is already open! close it before trying.
[[return]]
}

; Open the Rcon window whilst activating it, with an editbox, hide the @ prefix and maximize it.
window -aek0x @ [[DollarPlus|$+]] %server.addr
[[aline]] 12 @ [[DollarPlus|$+]] %server.addr Source RCON window. Type a command\cvar to send to the server, responses will be displayed here.
[[aline]] 12 @ [[DollarPlus|$+]] %server.addr Warning! commands like exit or quit will close the server! avoid using them!

; Set the socket name we'll use.
[[Local_Variables|var]] %sockname = [[DollarPlus|$+]]($srcon.prefix,%server.addr)

; Open the socket to the server.
[[sockopen]] %sockname [[$1-|$1]] [[$1-|$2]]

; Mark the socket with the Rcon password.
[[sockmark]] %sockname [[$1-|$3]]
}

; Catch all sockopens with the Source Rcon sockets prefix.
; Build the authentication request packet and send it to the server.
on *:SOCKOPEN:$([[DollarPlus|$+]]($srcon.prefix, *)): {
; Initialize the request ID for the connection.
[[set]] %srcon.id. [[DollarPlus|$+]] [[$sockname]] 0

; Constructed auth request to send to the server.
srcon.getrequest &srcon.auth %srcon.id. [ [[DollarPlus|$+]] [ [[$sockname]] ] ] $srcon.req.auth [[$sock]]([[$sockname]]).mark

; Send the authentication packet.
[[sockwrite]] [[$sockname]] &srcon.auth
}

; Read data from the game server.
on *:SOCKREAD:$([[DollarPlus|$+]]($srcon.prefix, *)): {
; Get the window name for the current game server.
[[Local_Variables|var]] %srcon.window = [[DollarPlus|$+]](@, [[$remove]]([[$sockname]], $srcon.prefix))

; If there were errors, $sockerr will tell us so.
; Write the error message to the window and clear the connection.
[[If-Then-Else|if]] ($sockerr) {
[[aline]] 04 %srcon.window * Error: Reading from socket: [[$sock]]([[$sockname]]).wsmsg
srcon.clear [[$sockname]]
[[return]]
}

; If a prior packet didn't finish receiving, continue reading it.
[[If-Then-Else|if]] ([[$hget]]([[$sockname]])) {
; Set the packet size.
[[Local_Variables|var]] %srcon.pckt.size = [[$hget]]([[$sockname]], size)

; Set the number of bytes left to read.
[[Local_Variables|var]] %srcon.pckt.left = [[$hget]]([[$sockname]], left)

; Set the request id.
[[Local_Variables|var]] %srcon.pckt.id = [[$hget]]([[$sockname]], id)

; Set the command response type.
[[Local_Variables|var]] %srcon.pckt.cmd = [[$hget]]([[$sockname]], cmd)

; Set the cut string1.
[[noop]] [[$hget]]([[$sockname]], string1, &srcon.pckt.string1)

; Read the rest of string1.
[[Sockread|sockread]] %srcon.pckt.left &srcon.pckt.rest
[[dec]] %srcon.pckt.left $sockbr

; Append the rest of string1 to the already received string1.
[[bcopy]] &srcon.pckt.string1 [[$calc]]([[$bvar]](&srcon.pckt.string1, 0) + 1) &srcon.pckt.rest 1 -1

; Clear the un-needed variables.
[[hfree]] [[$sockname]]
}
; Else, if the packet wasn't splitted.
[[If-Then-Else|else]] {
; Read the packet size.
[[Sockread|sockread]] 4 &srcon.pckt.size
[[Local_Variables|var]] %srcon.pckt.size = [[$bvar]](&srcon.pckt.size, 1).long

; Initialize the number of bytes left to read.
[[Local_Variables|var]] %srcon.pckt.left = %srcon.pckt.size

; Read the packet id.
[[Sockread|sockread]] 4 &srcon.pckt.id
[[Local_Variables|var]] %srcon.pckt.id = [[$bvar]](&srcon.pckt.id, 1).long
[[dec]] %srcon.pckt.left $sockbr

; If the request id is an error, stop processing, display an error and clear the connection.
[[If-Then-Else|if]] ($srcon.inttobytes(%srcon.pckt.id) == 255 255 255 255) {
[[aline]] 04 %srcon.window * Error: Failed authentication (probably wrong password).
srcon.clear [[$sockname]]
[[return]]
}

; Read the packet command response type.
[[Sockread|sockread]] 4 &srcon.pckt.cmd
[[Local_Variables|var]] %srcon.pckt.cmd = [[$bvar]](&srcon.pckt.cmd, 1).long
[[dec]] %srcon.pckt.left $sockbr

; Read string1.
[[Sockread|sockread]] %srcon.pckt.left &srcon.pckt.string1
[[dec]] %srcon.pckt.left $sockbr
}

; If the number of bytes left to read is still positive, the packet was splitted.
; This means that we'll save the variables to globals so it can be used in the next read.
[[If-Then-Else|if]] (%srcon.pckt.left > 0) {
[[hmake]] [[$sockname]]
[[hadd]] [[$sockname]] size %srcon.pckt.size
[[hadd]] [[$sockname]] left %srcon.pckt.left
[[hadd]] [[$sockname]] id %srcon.pckt.id
[[hadd]] [[$sockname]] cmd %srcon.pckt.cmd
[[hadd]] -b [[$sockname]] string1 &srcon.pckt.string1
}
; Only if we've finished reading all the packet, display it.
; NOTE: At this point, string1 also contains string2 (the one 0x00 byte), however it doesn't matter to us
; since we're only reading the text which is terminated in string1 by a 0x00 byte.
[[If-Then-Else|elseif]] (%srcon.pckt.left == 0) {
; If the response type was an auth response, display a "connected" message.
[[If-Then-Else|if]] (%srcon.pckt.cmd == $srcon.res.auth) {
[[aline]] 12 %srcon.window Now connected!
}
; If the response type was a command response, display it.
[[If-Then-Else|elseif]] (%srcon.pckt.cmd == $srcon.res.cmd) {
; Convert the binary string1 to a usable variable.
[[Local_Variables|var]] %srcon.pckt.string1 = [[$bvar]](&srcon.pckt.string1, 1, [[$bvar]](&srcon.pckt.string1, 0)).text

; Tokenize the lines to be printed and print them.
[[tokenize]] [[$asc]]([[$lf]]) %srcon.pckt.string1
[[aline]] %srcon.window [[$$|$*]]
}
}
}

; Sockets may close on their own if not kept alive.
; In case that happens when the window is still open, the socket will be reopened.
on *:SOCKCLOSE:$([[DollarPlus|$+]]($srcon.prefix, *)): {
; Get the window name for the current game server.
[[Local_Variables|var]] %srcon.window = [[DollarPlus|$+]](@, [[$remove]]([[$sockname]], $srcon.prefix))

; If the window and the current request id still exists, reopen the socket.
[[If-Then-Else|if]] (([[$window_(remote)|$window(]]%srcon.window)) && (%srcon.id. [ [[DollarPlus|$+]] [ [[$sockname]] ] ])) {
; Save the socket details before terminating it.
%srcon.name = [[$sockname]]
%srcon.ip = [[$sock]]([[$sockname]]).ip
%srcon.port = [[$sock]]([[$sockname]]).port
%srcon.pass = [[$sock]]([[$sockname]]).mark

; Terminate the socket so it could be reopened.
[[sockclose]] [[$sockname]]

; Reopen the socket to the server.
[[sockopen]] %srcon.name %srcon.ip %srcon.port

; Mark the socket with the Rcon password.
[[sockmark]] %srcon.name %srcon.pass
}
}

; Sends user input to the server as is.
; NOTE: Commands like exit or quit will close the server!
on *:INPUT:@: {
; Get the socket name.
[[Local_Variables|var]] %srcon.socket = [[DollarPlus|$+]]($srcon.prefix, [[$remove]]($target, @))

; If the input is not for the Source Rcon window, ignore it.
[[If-Then-Else|if]] ([[$$|$]]([[DollarPlus|$+]](%, srcon.id., %srcon.socket), 2) == [[$null]]) { [[return]] }

; Check if the socket is still alive.
[[If-Then-Else|if]] (![[$sock]](%srcon.socket)) {
[[aline]] 04 $target * Error: Socket is dead. Close the window and try again.
[[return]]
}

; Build the execute command request packet and send it to the server.

; Increment the current request id.
[[inc]] %srcon.id. [[DollarPlus|$+]] %srcon.socket

; Construct the request to send to the game server.
srcon.getrequest &srcon.cmd %srcon.id. [ [[DollarPlus|$+]] [ %srcon.socket ] ] $srcon.req.execcmd [[$1-|$1-]]

[[aline]] $target -> [[$1-|$1-]]

; Send the command request.
[[sockwrite]] %srcon.socket &srcon.cmd
}

; If the user has closed the rcon window, clear the socket.
on *:CLOSE:@: {
srcon.clear [[DollarPlus|$+]]($srcon.prefix, [[$remove]]($target, @))
}

; Constructs a request with the given parameters:
; $1 = Bvar to store the request
; $2 = Request ID
; $3 = Request type
; $4- = Request data (password/command)
[[alias]] -l srcon.getrequest {
; Clear the given bvar to make sure it doesn't contain any preset values.
[[bunset]] [[$1-|$1]]

; Set the given request ID in the request.
[[bset]] [[$1-|$1]] 5 $srcon.inttobytes([[$1-|$2]])

; Set the given request type.
[[bset]] [[$1-|$1]] 9 $srcon.inttobytes([[$1-|$3]])

; Set string1 the request data.
[[bset]] -t [[$1-|$1]] 13 [[$1-|$4-]]

; Terminate string1 with 0x00 and set string2 to 0x00.
[[bset]] [[$1-|$1]] [[$calc]]([[$bvar]]([[$1-|$1]],0) + 1) 00 00

; Set the packet size.
[[bset]] [[$1-|$1]] 1 $srcon.inttobytes([[$calc]]([[$bvar]]([[$1-|$1]], 0) - 4))
}

; Clears the socket and the request id.
[[alias]] -l srcon.clear {
; If there's a socket named accordingly, close it.
[[If-Then-Else|if]] ([[$sock]]([[$1-|$1]])) {
[[sockclose]] [[$1-|$1]]
}

; Clear the id var.
[[Unset|unset]] %srcon.id. [[DollarPlus|$+]] [[$1-|$1]]
}

==See also==
* [[How to RCON an HL1 engine based server]]
* [[How to query a CS Server]]
* [[How to parse HL log data]]
* [http://developer.valvesoftware.com/wiki/Source_RCON_Protocol Source RCON Protocol on valvesoftware]

[[Category:Tutorials]]
[[Category:Socket]]

Joining channels after hiding your address

2012-06-18T17:28:29Z

NaNg:

; Joining channels after hiding your address
; by bindi @ QuakeNet
; Date: 08-04-2012
; Tested on mIRC 7.22

on *:[[on start|START]]:{
;; when mirc starts, connect to QuakeNet

;; (change the server if you prefer another server geographically closer
;; to you or something like that, see http://www.quakenet.org/servers)

[[server]] irc.quakenet.org -i <nick> <alternate nick> <ident>@any.email.doesnt.matter <real name (doesn't have to be real, either :D)>
;; change the above to match your information.

}

on *:[[on connect|CONNECT]]:{
;; this triggers when you've connected to a server

[[If-Then-Else|if]] ([[$network]] == QuakeNet) && (*.??.quakenet.org iswm [[$server]]) {
;; check if we have connected to QuakeNet

[[Challenge auth|ChallengeAuth]]
;; if so, let's auth safely

![[mode]] [[$me]] +x
;; and add +x to our usermode
}
}

[[raw 396]]:*:{
;; this triggers when your host is hidden

[[If-Then-Else|if]] ([[$network]] == QuakeNet) && (*.??.quakenet.org iswm [[$server]]) {
;; check if it's QuakeNet (just to be sure)

[[join]] #channel1,#channel2,#channel3 key1,,key3
;;change above to your channels and keys (if any).
}
}

== See also ==
* [[Challenge auth]]

[[Category:Tutorials]]

Challenge auth

2012-05-08T17:36:14Z

NaNg: fixed script splittings

Challenge auth

2012-05-08T17:34:31Z

NaNg: version update

Challenge auth

2012-05-08T17:32:46Z

NaNg: Fixed to work when Q messages the responses (userflags -n)

; Original by doomie @ QuakeNet
; Modified by NaNg @ QuakeNet
; Version 1.1
; Written and tested on mIRC 6.34
; Also tested on mIRC 7.22
;
; What does this script contains?
;
; * ChallengeAuth script based on hmac-sha1 (no addon dll needed for mIRC on tested version).
;
; What is ChallengeAuth?
;
; ChallengeAuth is a safe way to auth to your Q account, without sending your password in plain
; text over the network. For more information, please read the following link:
; http://www.quakenet.org/development/challengeauth/
;
; *****************************************************
; What do I need to configure before using this script?
; *****************************************************
;
; You don't need to configure ANYTHING! The scripts can work as is, by executing /ChallengeAuth.
; If you'd like for it to auto-auth on connect, use /ChallengeAuth.AutoAuth 1.
; The script will pop up windows asking your username (first time only) and password (every time).
;
; If you don't want it to pop the password window every time, follow these instructions:
;
; The ChallengeAuth.Username and ChallengeAuth.Password right under this documentation needs to
; be edited for your username and hashed password.
; To get the hashed password, after loading this script, use:
; /ChallengeAuth.CreateHash <User> <Pass>
; where User is your Q account name and Pass is your Q password, and you will be given the hashed
; password that corresponds to the given user which you should insert in the alias below, e.g:
; alias -l ChallengeAuth.Password { return <Hashed_Password> }
;
; Available commands:
;
; * ChallengeAuth
; To auth to the pre-set user and password using the challengeauth.
; * ChallengeAuth.AutoAuth [1|0]
; Set 1 to enable to auto-auth on connect or 0 to disable.
; * ChallengeAuth.CreateHash [<Authname>] [<Pass>]
; Creates a hashed request according to the given Q user and pass.

; CONFIGURE

[[alias]] -l ChallengeAuth.Username {
[[If-Then-Else|if]] (!%ChallengeAuth.User) {
![[set]] %ChallengeAuth.User $?="Q account name?"
}

[[return]] %ChallengeAuth.User
}

[[alias]] -l ChallengeAuth.Password {
[[return]] $ChallengeAuth.CreateHash($ChallengeAuth.Username, $?*="Password for Q account name: $ChallengeAuth.Username ")
}

; DONT CHANGE ANYTHING UNDER THIS LINE UNLESS YOU KNOW WHAT YOU ARE DOING

[[alias]] -l ChallengeAuth.Q { [[return]] Q@CServe.quakenet.org }

; id = whether autoauth is on or not.
; $1 = 1 for autoauth or 0 for not.
[[alias]] ChallengeAuth.AutoAuth {
[[If-Then-Else|if]] ([[$isid]]) [[return]] %ChallengeAuth.AutoAuth

[[If-Then-Else|if]] ([[$1-|$1]] == [[$null]]) {
[[echo]] -at ChallengeAuth: Not enough parameters.
[[return]]
}

[[If-Then-Else|if]] ([[$1-|$1]] !isin 01) {
[[echo]] -at ChallengeAuth: Invalid parameter. Please enter 1 to enable or 0 to disable.
[[return]]
}

[[set]] %ChallengeAuth.AutoAuth [[$1-|$1]]
[[echo]] -at ChallengeAuth: Automatic authentication is now [[$iif]](%ChallengeAuth.AutoAuth, ON, OFF)
}

; $1 = key, $2 = message
[[alias]] hmac-sha1 {
[[Local_Variables|var]] %i = 1
[[while]] (%i <= 64) {
[[Local_Variables|var]] %k = [[$iif]]([[$asc]]([[$mid]]([[$1-|$1]],%i,1)),[[$v1]],0)
[[Local_Variables|var]] %opad = %opad [[$xor]](92,%k)
[[Local_Variables|var]] %ipad = %ipad [[$xor]](54,%k)
[[inc]] %i
}

[[bset]] &ipad 1 %ipad [[$regsubex]]([[$1-|$2]],/(.)/g,[[$asc]](\t) [[DollarPlus|$+]] [[$chr]](32))
[[bset]] &opad 1 %opad [[$regsubex]]([[$sha1]](&ipad,1),/(..)/g,[[$base]](\t,16,10) [[DollarPlus|$+]] [[$chr]](32))
[[Local_Variables|var]] %res = [[$sha1]](&opad,1)
[[bunset]] &ipad &opad
[[return]] %res
}

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

; $1 = Authname, $2 = Password
[[alias]] ChallengeAuth.CreateHash {
[[If-Then-Else|if]] (![[$1-|$2]]) {
[[echo]] -ta ChallengeAuth: Not enough values given.
[[return]]
}

![[Local_Variables|var]] %ChallengeAuth.Hash = [[$sha1]]([[DollarPlus|$+]]($ChallengeAuth.IRCToLower([[$1-|$1]]),:,[[$sha1]]([[$left]]([[$1-|$2]],10))))

[[If-Then-Else|if]] ([[$isid]]) [[return]] %ChallengeAuth.Hash

![[echo]] -atg ChallengeAuth: Hashed user/pass: %ChallengeAuth.Hash
}

; Unsets challengeauth vars
[[alias]] -l ChallengeAuth.Clear {
![[Unset|unset]] %ChallengeAuth.Active
![[Unset|unset]] %ChallengeAuth.Pass
}

; $1 = Challenge
[[alias]] -l ChallengeAuth.Auth {
!.[[msg]] $ChallengeAuth.Q CHALLENGEAUTH %ChallengeAuth.User $hmac-sha1(%ChallengeAuth.Pass, [[$1-|$1]]) HMAC-SHA-1
}

[[alias]] ChallengeAuth {
; If username and password weren't supplied, use the defaults.
[[If-Then-Else|if]] (![[$1-|$1]]) {
[[tokenize]] 32 $ChallengeAuth.Username $ChallengeAuth.Password
}

[[If-Then-Else|if]] (![[$1-|$2]]) {
[[echo]] -at ChallengeAuth: No Password specified.
[[return]]
}

![[set]] %ChallengeAuth.Active [[$true]]
![[set]] %ChallengeAuth.User [[$1-|$1]]
![[set]] %ChallengeAuth.Pass [[$1-|$2]]

[[echo]] -at ChallengeAuth: ChallengeAuth is beginning.
!.[[msg]] $ChallengeAuth.Q challenge
}

on *:CONNECT: {
[[If-Then-Else|if]] (($ChallengeAuth.AutoAuth) && ([[$network]] == QuakeNet) && ([[$right]]([[$server]], 13) === .quakenet.org)) {
ChallengeAuth $ChallengeAuth.Username $ChallengeAuth.Password
}
}

on ^*:NOTICE:*:?: {
ChallengeAuth.ExecuteInput [[$1-|$1-]]
}

on ^*:TEXT:*:?: {
ChallengeAuth.ExecuteInput [[$1-|$1-]]
}

[[alias]] -l ChallengeAuth.ExecuteInput {

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

raw 401:*: {
[[If-Then-Else|if]] ([[$1-|$1-]] == [[$me]] $ChallengeAuth.Q No such nick) && (%ChallengeAuth.Active) {
[[echo]] -ts ChallengeAuth: Q is currently not reachable. Please try again later.
ChallengeAuth.Clear
[[haltdef]]
}
}

Joining channels after hiding your address

2012-04-20T11:53:46Z

NaNg: more clickies!!! :D

; Joining channels after hiding your address
; by bindi @ QuakeNet
; Date: 08-04-2012
; Tested on mIRC 7.22

on *:[[on start|START]]:{
;; when mirc starts, connect to QuakeNet

;; (change the server if you prefer another server geographically closer
;; to you or something like that, see http://www.quakenet.org/servers)

[[server]] irc.quakenet.org -i <nick> <alternate nick> <ident>@any.email.doesnt.matter <real name (doesn't have to be real, either :D)>
;; change the above to match your information.

}

on *:[[on connect|CONNECT]]:{
;; this triggers when you've connected to a server

[[If-Then-Else|if]] ([[$network]] == QuakeNet) && (*.??.quakenet.org iswm [[$server]]) {
;; check if we have connected to QuakeNet

[[Challenge auth|ChallengeAuth]]
;; if so, let's auth safely

![[mode]] [[$me]] +x
;; and add +x to our usermode
}
}

[[raw 396]]:*:{
;; this triggers when your host is hidden

[[If-Then-Else|if]] ([[$network]] == QuakeNet) && (*.??.quakenet.org iswm [[$server]]) {
;; check if it's QuakeNet (just to be sure)

[[join]] #channel1,#channel2,#channel3 key1,,key3
;;change above to your channels and keys (if any).
}
}

== See also ==
* [[Challenge auth]]

[[Category:Tutorials]]

Joining channels after hiding your address

2012-04-20T11:49:46Z

NaNg: challengeauth is safer :)

; Joining channels after hiding your address
; by bindi @ QuakeNet
; Date: 08-04-2012
; Tested on mIRC 7.22

on *:START:{
;; when mirc starts, connect to QuakeNet

;; (change the server if you prefer another server geographically closer
;; to you or something like that, see http://www.quakenet.org/servers)

[[server]] irc.quakenet.org -i <nick> <alternate nick> <ident>@any.email.doesnt.matter <real name (doesn't have to be real, either :D)>
;; change the above to match your information.

}

on *:CONNECT:{
;; this triggers when you've connected to a server

[[If-Then-Else|if]] ([[$network]] == QuakeNet) && (*.??.quakenet.org iswm [[$server]]) {
;; check if we have connected to QuakeNet

[[Challenge auth|ChallengeAuth]]
;; if so, let's auth safely

![[mode]] [[$me]] +x
;; and add +x to our usermode
}
}

raw 396:*:{
;; this triggers when your host is hidden

[[If-Then-Else|if]] ([[$network]] == QuakeNet) && (*.??.quakenet.org iswm [[$server]]) {
;; check if it's QuakeNet (just to be sure)

[[join]] #channel1,#channel2,#channel3 key1,,key3
;;change above to your channels and keys (if any).
}
}

== See also ==
* [[Challenge auth]]

[[Category:Tutorials]]

Joining channels after hiding your address

2012-04-20T11:44:36Z

NaNg: by bindi

; Joining channels after hiding your address
; by bindi @ QuakeNet
; Date: 08-04-2012
; Tested on mIRC 7.22

on *:START:{
;; when mirc starts, connect to QuakeNet

;; (change the server if you prefer another server geographically closer
;; to you or something like that, see http://www.quakenet.org/servers)

[[server]] irc.quakenet.org -i <nick> <alternate nick> <ident>@any.email.doesnt.matter <real name (doesn't have to be real, either :D)>
;; change the above to match your information.

}

on *:CONNECT:{
;; this triggers when you've connected to a server

[[If-Then-Else|if]] ([[$network]] == QuakeNet) && (*.??.quakenet.org iswm [[$server]]) {
;; check if we have connected to QuakeNet

!.[[raw]] -q AUTH <auth> <password>
;; if so, let's auth

![[mode]] [[$me]] +x
;; and add +x to our usermode
}
}

raw 396:*:{
;; this triggers when your host is hidden

[[If-Then-Else|if]] ([[$network]] == QuakeNet) && (*.??.quakenet.org iswm [[$server]]) {
;; check if it's QuakeNet (just to be sure)

[[join]] #channel1,#channel2,#channel3 key1,,key3
;;change above to your channels and keys (if any).
}
}

== See also ==
* [[Challenge auth]]

[[Category:Tutorials]]

Challenge auth

2012-04-10T13:23:07Z

NaNg: clear vars + more doc

; Original by doomie @ QuakeNet
; Modified by NaNg @ QuakeNet
; Version 1.1
; Written and tested on mIRC 6.34
; Also tested on mIRC 7.22
;
; What does this script contains?
;
; * ChallengeAuth script based on hmac-sha1 (no addon dll needed for mIRC on tested version).
;
; What is ChallengeAuth?
;
; ChallengeAuth is a safe way to auth to your Q account, without sending your password in plain
; text over the network. For more information, please read the following link:
; http://www.quakenet.org/development/challengeauth/
;
; *****************************************************
; What do I need to configure before using this script?
; *****************************************************
;
; You don't need to configure ANYTHING! The scripts can work as is, by executing /ChallengeAuth.
; If you'd like for it to auto-auth on connect, use /ChallengeAuth.AutoAuth 1.
; The script will pop up windows asking your username (first time only) and password (every time).
;
; If you don't want it to pop the password window every time, follow these instructions:
;
; The ChallengeAuth.Username and ChallengeAuth.Password right under this documentation needs to
; be edited for your username and hashed password.
; To get the hashed password, after loading this script, use:
; /ChallengeAuth.CreateHash <User> <Pass>
; where User is your Q account name and Pass is your Q password, and you will be given the hashed
; password that corresponds to the given user which you should insert in the alias below, e.g:
; alias -l ChallengeAuth.Password { return <Hashed_Password> }
;
; Available commands:
;
; * ChallengeAuth
; To auth to the pre-set user and password using the challengeauth.
; * ChallengeAuth.AutoAuth [1|0]
; Set 1 to enable to auto-auth on connect or 0 to disable.
; * ChallengeAuth.CreateHash [<Authname>] [<Pass>]
; Creates a hashed request according to the given Q user and pass.

; CONFIGURE

[[alias]] -l ChallengeAuth.Username {
[[If-Then-Else|if]] (!%ChallengeAuth.User) {
![[set]] %ChallengeAuth.User $?="Q account name?"
}

[[return]] %ChallengeAuth.User
}

[[alias]] -l ChallengeAuth.Password {
[[return]] $ChallengeAuth.CreateHash($ChallengeAuth.Username, $?*="Password for Q account name: $ChallengeAuth.Username ")
}

; DONT CHANGE ANYTHING UNDER THIS LINE UNLESS YOU KNOW WHAT YOU ARE DOING

[[alias]] -l ChallengeAuth.Q { [[return]] Q@CServe.quakenet.org }

; id = whether autoauth is on or not.
; $1 = 1 for autoauth or 0 for not.
[[alias]] ChallengeAuth.AutoAuth {
[[If-Then-Else|if]] ([[$isid]]) [[return]] %ChallengeAuth.AutoAuth

[[If-Then-Else|if]] ([[$1-|$1]] == [[$null]]) {
[[echo]] -at ChallengeAuth: Not enough parameters.
[[return]]
}

[[If-Then-Else|if]] ([[$1-|$1]] !isin 01) {
[[echo]] -at ChallengeAuth: Invalid parameter. Please enter 1 to enable or 0 to disable.
[[return]]
}

[[set]] %ChallengeAuth.AutoAuth [[$1-|$1]]
[[echo]] -at ChallengeAuth: Automatic authentication is now [[$iif]](%ChallengeAuth.AutoAuth, ON, OFF)
}

; $1 = key, $2 = message
[[alias]] hmac-sha1 {
[[Local_Variables|var]] %i = 1
[[while]] (%i <= 64) {
[[Local_Variables|var]] %k = [[$iif]]([[$asc]]([[$mid]]([[$1-|$1]],%i,1)),[[$v1]],0)
[[Local_Variables|var]] %opad = %opad [[$xor]](92,%k)
[[Local_Variables|var]] %ipad = %ipad [[$xor]](54,%k)
[[inc]] %i
}

[[bset]] &ipad 1 %ipad [[$regsubex]]([[$1-|$2]],/(.)/g,[[$asc]](\t) [[DollarPlus|$+]] [[$chr]](32))
[[bset]] &opad 1 %opad [[$regsubex]]([[$sha1]](&ipad,1),/(..)/g,[[$base]](\t,16,10) [[DollarPlus|$+]] [[$chr]](32))
[[Local_Variables|var]] %res = [[$sha1]](&opad,1)
[[bunset]] &ipad &opad
[[return]] %res
}

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

; $1 = Authname, $2 = Password
[[alias]] ChallengeAuth.CreateHash {
[[If-Then-Else|if]] (![[$1-|$2]]) {
[[echo]] -ta ChallengeAuth: Not enough values given.
[[return]]
}

![[Local_Variables|var]] %ChallengeAuth.Hash = [[$sha1]]([[DollarPlus|$+]]($ChallengeAuth.IRCToLower([[$1-|$1]]),:,[[$sha1]]([[$left]]([[$1-|$2]],10))))

[[If-Then-Else|if]] ([[$isid]]) [[return]] %ChallengeAuth.Hash

![[echo]] -atg ChallengeAuth: Hashed user/pass: %ChallengeAuth.Hash
}

; Unsets challengeauth vars
[[alias]] -l ChallengeAuth.Clear {
![[Unset|unset]] %ChallengeAuth.Active
![[Unset|unset]] %ChallengeAuth.Pass
}

; $1 = Challenge
[[alias]] -l ChallengeAuth.Auth {
!.[[msg]] $ChallengeAuth.Q CHALLENGEAUTH %ChallengeAuth.User $hmac-sha1(%ChallengeAuth.Pass, [[$1-|$1]]) HMAC-SHA-1
}

[[alias]] ChallengeAuth {
; If username and password weren't supplied, use the defaults.
[[If-Then-Else|if]] (![[$1-|$1]]) {
[[tokenize]] 32 $ChallengeAuth.Username $ChallengeAuth.Password
}

[[If-Then-Else|if]] (![[$1-|$2]]) {
[[echo]] -at ChallengeAuth: No Password specified.
[[return]]
}

![[set]] %ChallengeAuth.Active [[$true]]
![[set]] %ChallengeAuth.User [[$1-|$1]]
![[set]] %ChallengeAuth.Pass [[$1-|$2]]

[[echo]] -at ChallengeAuth: ChallengeAuth is beginning.
!.[[msg]] $ChallengeAuth.Q challenge
}

on *:CONNECT: {
[[If-Then-Else|if]] (($ChallengeAuth.AutoAuth) && ([[$network]] == QuakeNet) && ([[$right]]([[$server]], 13) === .quakenet.org)) {
ChallengeAuth $ChallengeAuth.Username $ChallengeAuth.Password
}
}

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

raw 401:*: {
[[If-Then-Else|if]] ([[$1-|$1-]] == [[$me]] $ChallengeAuth.Q No such nick) && (%ChallengeAuth.Active) {
[[echo]] -ts ChallengeAuth: Q is currently not reachable. Please try again later.
ChallengeAuth.Clear
[[haltdef]]
}
}

Challenge auth

2012-04-10T13:06:06Z

NaNg: fix '

; Original by doomie @ QuakeNet
; Modified by NaNg @ QuakeNet
; Version 1.1
; Written and tested on mIRC 6.34
; Also tested on mIRC 7.22
;
; What does this script contains?
;
; * ChallengeAuth script based on hmac-sha1 (no addon dll needed for mIRC on tested version).
;
; What is ChallengeAuth?
;
; ChallengeAuth is a safe way to auth to your Q account, without sending your password in plain
; text over the network. For more information, please read the following link:
; http://www.quakenet.org/development/challengeauth/
;
; *****************************************************
; What do I need to configure before using this script?
; *****************************************************
;
; The ChallengeAuth.Username and ChallengeAuth.Password right under this documentation needs to
; be edited for your username and hashed password.
; To get the hashed password, after loading this script, use:
; /ChallengeAuth.CreateHash <User> <Pass>
; where User is your Q authname and Pass is your Q password, and you will be given the hashed
; password that corespondes to the given user which you should insert in the alias below.
; If you want to auto-auth on connect to QuakeNet, make sure to enable the auto-auth (see below).
;
; Available commands:
;
; * ChallengeAuth
; To auth to the pre-set user and password using the challengeauth.
; * ChallengeAuth.AutoAuth [1|0]
; Set 1 to enable to auto-auth on connect or 0 to disable.
; * ChallengeAuth.CreateHash [<Authname>] [<Pass>]
; Creates a hashed request according to the given Q user and pass.

; CONFIGURE

[[alias]] -l ChallengeAuth.Username {
[[If-Then-Else|if]] (!%ChallengeAuth.User) {
![[set]] %ChallengeAuth.User $?="Q account name?"
}

[[return]] %ChallengeAuth.User
}

[[alias]] -l ChallengeAuth.Password {
[[return]] $ChallengeAuth.CreateHash($ChallengeAuth.Username, $?*="Password for Q account name: $ChallengeAuth.Username ")
}

; DONT CHANGE ANYTHING UNDER THIS LINE UNLESS YOU KNOW WHAT YOU ARE DOING

[[alias]] -l ChallengeAuth.Q { [[return]] Q@CServe.quakenet.org }

; id = whether autoauth is on or not.
; $1 = 1 for autoauth or 0 for not.
[[alias]] ChallengeAuth.AutoAuth {
[[If-Then-Else|if]] ([[$isid]]) [[return]] %ChallengeAuth.AutoAuth

[[If-Then-Else|if]] ([[$1-|$1]] == [[$null]]) {
[[echo]] -at ChallengeAuth: Not enough parameters.
[[return]]
}

[[If-Then-Else|if]] ([[$1-|$1]] !isin 01) {
[[echo]] -at ChallengeAuth: Invalid parameter. Please enter 1 to enable or 0 to disable.
[[return]]
}

[[set]] %ChallengeAuth.AutoAuth [[$1-|$1]]
[[echo]] -at ChallengeAuth: Automatic authentication is now [[$iif]](%ChallengeAuth.AutoAuth, ON, OFF)
}

; $1 = key, $2 = message
[[alias]] hmac-sha1 {
[[Local_Variables|var]] %i = 1
[[while]] (%i <= 64) {
[[Local_Variables|var]] %k = [[$iif]]([[$asc]]([[$mid]]([[$1-|$1]],%i,1)),[[$v1]],0)
[[Local_Variables|var]] %opad = %opad [[$xor]](92,%k)
[[Local_Variables|var]] %ipad = %ipad [[$xor]](54,%k)
[[inc]] %i
}

[[bset]] &ipad 1 %ipad [[$regsubex]]([[$1-|$2]],/(.)/g,[[$asc]](\t) [[DollarPlus|$+]] [[$chr]](32))
[[bset]] &opad 1 %opad [[$regsubex]]([[$sha1]](&ipad,1),/(..)/g,[[$base]](\t,16,10) [[DollarPlus|$+]] [[$chr]](32))
[[Local_Variables|var]] %res = [[$sha1]](&opad,1)
[[bunset]] &ipad &opad
[[return]] %res
}

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

; $1 = Authname, $2 = Password
[[alias]] ChallengeAuth.CreateHash {
[[If-Then-Else|if]] (![[$1-|$2]]) {
[[echo]] -ta ChallengeAuth: Not enough values given.
[[return]]
}

![[Local_Variables|var]] %ChallengeAuth.Hash = [[$sha1]]([[DollarPlus|$+]]($ChallengeAuth.IRCToLower([[$1-|$1]]),:,[[$sha1]]([[$left]]([[$1-|$2]],10))))

[[If-Then-Else|if]] ([[$isid]]) [[return]] %ChallengeAuth.Hash

![[echo]] -atg ChallengeAuth: Hashed user/pass: %ChallengeAuth.Hash
}

; $1 = Challenge
[[alias]] -l ChallengeAuth.Auth {
!.[[msg]] $ChallengeAuth.Q CHALLENGEAUTH %ChallengeAuth.User $hmac-sha1(%ChallengeAuth.Pass, [[$1-|$1]]) HMAC-SHA-1
}

[[alias]] ChallengeAuth {
; If username and password weren't supplied, use the defaults.
[[If-Then-Else|if]] (![[$1-|$1]]) {
[[tokenize]] 32 $ChallengeAuth.Username $ChallengeAuth.Password
}

[[If-Then-Else|if]] (![[$1-|$2]]) {
[[echo]] -at ChallengeAuth: No Password specified.
[[return]]
}

![[set]] %ChallengeAuth.Active [[$true]]
![[set]] %ChallengeAuth.User [[$1-|$1]]
![[set]] %ChallengeAuth.Pass [[$1-|$2]]

[[echo]] -at ChallengeAuth: ChallengeAuth is beginning.
!.[[msg]] $ChallengeAuth.Q challenge
}

on *:CONNECT: {
[[If-Then-Else|if]] (($ChallengeAuth.AutoAuth) && ([[$network]] == QuakeNet) && ([[$right]]([[$server]], 13) === .quakenet.org)) {
ChallengeAuth $ChallengeAuth.Username $ChallengeAuth.Password
}
}

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

raw 401:*: {
[[If-Then-Else|if]] ([[$1-|$1-]] == [[$me]] $ChallengeAuth.Q No such nick) && (%ChallengeAuth.Active) {
[[echo]] -ts ChallengeAuth: Q is currently not reachable. Please try again later.
[[Unset|unset]] %ChallengeAuth.Active
[[haltdef]]
}
}

Challenge auth

2012-04-10T13:03:50Z

NaNg: autoauth info message + challengeauth can now be used without parameters

; Original by doomie @ QuakeNet
; Modified by NaNg @ QuakeNet
; Version 1.1
; Written and tested on mIRC 6.34
; Also tested on mIRC 7.22
;
; What does this script contains?
;
; * ChallengeAuth script based on hmac-sha1 (no addon dll needed for mIRC on tested version).
;
; What is ChallengeAuth?
;
; ChallengeAuth is a safe way to auth to your Q account, without sending your password in plain
; text over the network. For more information, please read the following link:
; http://www.quakenet.org/development/challengeauth/
;
; *****************************************************
; What do I need to configure before using this script?
; *****************************************************
;
; The ChallengeAuth.Username and ChallengeAuth.Password right under this documentation needs to
; be edited for your username and hashed password.
; To get the hashed password, after loading this script, use:
; /ChallengeAuth.CreateHash <User> <Pass>
; where User is your Q authname and Pass is your Q password, and you will be given the hashed
; password that corespondes to the given user which you should insert in the alias below.
; If you want to auto-auth on connect to QuakeNet, make sure to enable the auto-auth (see below).
;
; Available commands:
;
; * ChallengeAuth
; To auth to the pre-set user and password using the challengeauth.
; * ChallengeAuth.AutoAuth [1|0]
; Set 1 to enable to auto-auth on connect or 0 to disable.
; * ChallengeAuth.CreateHash [<Authname>] [<Pass>]
; Creates a hashed request according to the given Q user and pass.

; CONFIGURE

[[alias]] -l ChallengeAuth.Username {
[[If-Then-Else|if]] (!%ChallengeAuth.User) {
![[set]] %ChallengeAuth.User $?="Q account name?"
}

[[return]] %ChallengeAuth.User
}

[[alias]] -l ChallengeAuth.Password {
[[return]] $ChallengeAuth.CreateHash($ChallengeAuth.Username, $?*="Password for Q account name: $ChallengeAuth.Username ")
}

; DONT CHANGE ANYTHING UNDER THIS LINE UNLESS YOU KNOW WHAT YOU ARE DOING

[[alias]] -l ChallengeAuth.Q { [[return]] Q@CServe.quakenet.org }

; id = whether autoauth is on or not.
; $1 = 1 for autoauth or 0 for not.
[[alias]] ChallengeAuth.AutoAuth {
[[If-Then-Else|if]] ([[$isid]]) [[return]] %ChallengeAuth.AutoAuth

[[If-Then-Else|if]] ([[$1-|$1]] == [[$null]]) {
[[echo]] -at ChallengeAuth: Not enough parameters.
[[return]]
}

[[If-Then-Else|if]] ([[$1-|$1]] !isin 01) {
[[echo]] -at ChallengeAuth: Invalid parameter. Please enter 1 to enable or 0 to disable.
[[return]]
}

[[set]] %ChallengeAuth.AutoAuth [[$1-|$1]]
[[echo]] -at ChallengeAuth: Automatic authentication is now [[$iif]](%ChallengeAuth.AutoAuth, ON, OFF)
}

; $1 = key, $2 = message
[[alias]] hmac-sha1 {
[[Local_Variables|var]] %i = 1
[[while]] (%i <= 64) {
[[Local_Variables|var]] %k = [[$iif]]([[$asc]]([[$mid]]([[$1-|$1]],%i,1)),[[$v1]],0)
[[Local_Variables|var]] %opad = %opad [[$xor]](92,%k)
[[Local_Variables|var]] %ipad = %ipad [[$xor]](54,%k)
[[inc]] %i
}

[[bset]] &ipad 1 %ipad [[$regsubex]]([[$1-|$2]],/(.)/g,[[$asc]](\t) [[DollarPlus|$+]] [[$chr]](32))
[[bset]] &opad 1 %opad [[$regsubex]]([[$sha1]](&ipad,1),/(..)/g,[[$base]](\t,16,10) [[DollarPlus|$+]] [[$chr]](32))
[[Local_Variables|var]] %res = [[$sha1]](&opad,1)
[[bunset]] &ipad &opad
[[return]] %res
}

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

; $1 = Authname, $2 = Password
[[alias]] ChallengeAuth.CreateHash {
[[If-Then-Else|if]] (![[$1-|$2]]) {
[[echo]] -ta ChallengeAuth: Not enough values given.
[[return]]
}

![[Local_Variables|var]] %ChallengeAuth.Hash = [[$sha1]]([[DollarPlus|$+]]($ChallengeAuth.IRCToLower([[$1-|$1]]),:,[[$sha1]]([[$left]]([[$1-|$2]],10))))

[[If-Then-Else|if]] ([[$isid]]) [[return]] %ChallengeAuth.Hash

![[echo]] -atg ChallengeAuth: Hashed user/pass: %ChallengeAuth.Hash
}

; $1 = Challenge
[[alias]] -l ChallengeAuth.Auth {
!.[[msg]] $ChallengeAuth.Q CHALLENGEAUTH %ChallengeAuth.User $hmac-sha1(%ChallengeAuth.Pass, [[$1-|$1]]) HMAC-SHA-1
}

[[alias]] ChallengeAuth {
; If username and password weren?t supplied, use the defaults.
[[If-Then-Else|if]] (![[$1-|$1]]) {
[[tokenize]] 32 $ChallengeAuth.Username $ChallengeAuth.Password
}

[[If-Then-Else|if]] (![[$1-|$2]]) {
[[echo]] -at ChallengeAuth: No Password specified.
[[return]]
}

![[set]] %ChallengeAuth.Active [[$true]]
![[set]] %ChallengeAuth.User [[$1-|$1]]
![[set]] %ChallengeAuth.Pass [[$1-|$2]]

[[echo]] -at ChallengeAuth: ChallengeAuth is beginning.
!.[[msg]] $ChallengeAuth.Q challenge
}

on *:CONNECT: {
[[If-Then-Else|if]] (($ChallengeAuth.AutoAuth) && ([[$network]] == QuakeNet) && ([[$right]]([[$server]], 13) === .quakenet.org)) {
ChallengeAuth $ChallengeAuth.Username $ChallengeAuth.Password
}
}

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

raw 401:*: {
[[If-Then-Else|if]] ([[$1-|$1-]] == [[$me]] $ChallengeAuth.Q No such nick) && (%ChallengeAuth.Active) {
[[echo]] -ts ChallengeAuth: Q is currently not reachable. Please try again later.
[[Unset|unset]] %ChallengeAuth.Active
[[haltdef]]
}
}

How to start

2012-04-05T17:32:09Z

NaNg:

This tutorial is supposed to give an introduction into scripting in mIRC. It will explain the so-called ''Scripts-Editor'' and its 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 your code may interfere with the existing code (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 once you press "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 if it's in the Aliases section and 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 [[Popup_Menus#MENU_prefix|menus]] 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. Two separate examples:

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

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

; will be triggered 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 the image below 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 check-mark button (or "{}"-button in older mIRC versions) in the upper right corner (see below). That button is used to check for bracket mis-matches in the scriptfile.

[[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 are no obvious bracket mistakes (mIRC just counts the open and closed brackets)). If something's wrong, you will get the following popup:

[[Image:Bracketerror.png]]

Even if it says that the bracket error is ''around'' line 1, it could be almost anywhere. Start you search from that line and look at the indentations to find out where you're missing a bracket.

The remote tab contains scripts that are triggered by events, such as [[On text|when someone speaks]] or [[On join|when someone joins a channel]]. For example, the following 'remote script' would tell user's who join a channel hello!

[[On join|on *:JOIN]]:#: {
[[msg]] [[$nick]] Hello. Welcome to [[$chan]] [[DollarPlus|$+]] !!!
}

If you would like to learn scripting, you should familiarize yourself with this tab.
You should also learn [[:Category:Events|event names]] and understand how to run commands, such as the [[msg]] command above which messages a channel or nick name. You should also learn what [[:Category:Remote Identifiers|identifiers]] are and how to use them. An example of an identifier in the above script is [[$nick]] and [[$chan]] which tell us the user's nick name and the channel's name.
You may click on any blue hyperlink for more information about a a command or identifier that you see in any of this wiki's examples. Please use the examples and test them, to try and understand what they do. Keep in mind, mIRC is a high level language and almost everything sounds like it is. For example, if you want to know when someone quites you would use the [[on quit]] event! One of the most common script events used is the [[on text]] event, which triggers when someone speaks either in a channel or a private message.
If you are interested in these events, you should move on to [[How to start (part 2)|part 2]] of this introduction.

=== Users-Tab ===

In this file your userlist is saved. You don't need to edit it manually, as there are commands to do it. See [[Access_Levels|access levels in general]], [[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 see exactly where it stops to work and correct this part.<br>
'''Note''' You cannot trigger on text, on notice, on action... events by yourself, you will need someone's help or another client or multiserver (/[[server]] -m ...) to test them.

If some of the built-in commands don't work, ie. /kick, /away ... etc. you might have a custom alias that overrides them, you can test it with /!command, ie. /!kick #channel nick.
/!command will use the default mIRC command and bypass any custom aliases.

'''For more info on debugging, see [[Debugging (Find The Bug)]]'''.

== See also ==
* [[How to start (part 2)]]

[[Category:Tutorials]]

How to start

2012-04-05T17:30:54Z

NaNg: noob

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

This tutorial is aimed for starters, newbies (or noobs) and anyone who wants to learn the basics of mIRC scripting.

== 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 your code may interfere with the existing code (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 once you press "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 if it's in the Aliases section and 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 [[Popup_Menus#MENU_prefix|menus]] 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. Two separate examples:

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

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

; will be triggered 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 the image below 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 check-mark button (or "{}"-button in older mIRC versions) in the upper right corner (see below). That button is used to check for bracket mis-matches in the scriptfile.

[[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 are no obvious bracket mistakes (mIRC just counts the open and closed brackets)). If something's wrong, you will get the following popup:

[[Image:Bracketerror.png]]

Even if it says that the bracket error is ''around'' line 1, it could be almost anywhere. Start you search from that line and look at the indentations to find out where you're missing a bracket.

The remote tab contains scripts that are triggered by events, such as [[On text|when someone speaks]] or [[On join|when someone joins a channel]]. For example, the following 'remote script' would tell user's who join a channel hello!

[[On join|on *:JOIN]]:#: {
[[msg]] [[$nick]] Hello. Welcome to [[$chan]] [[DollarPlus|$+]] !!!
}

If you would like to learn scripting, you should familiarize yourself with this tab.
You should also learn [[:Category:Events|event names]] and understand how to run commands, such as the [[msg]] command above which messages a channel or nick name. You should also learn what [[:Category:Remote Identifiers|identifiers]] are and how to use them. An example of an identifier in the above script is [[$nick]] and [[$chan]] which tell us the user's nick name and the channel's name.
You may click on any blue hyperlink for more information about a a command or identifier that you see in any of this wiki's examples. Please use the examples and test them, to try and understand what they do. Keep in mind, mIRC is a high level language and almost everything sounds like it is. For example, if you want to know when someone quites you would use the [[on quit]] event! One of the most common script events used is the [[on text]] event, which triggers when someone speaks either in a channel or a private message.
If you are interested in these events, you should move on to [[How to start (part 2)|part 2]] of this introduction.

=== Users-Tab ===

In this file your userlist is saved. You don't need to edit it manually, as there are commands to do it. See [[Access_Levels|access levels in general]], [[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 see exactly where it stops to work and correct this part.<br>
'''Note''' You cannot trigger on text, on notice, on action... events by yourself, you will need someone's help or another client or multiserver (/[[server]] -m ...) to test them.

If some of the built-in commands don't work, ie. /kick, /away ... etc. you might have a custom alias that overrides them, you can test it with /!command, ie. /!kick #channel nick.
/!command will use the default mIRC command and bypass any custom aliases.

'''For more info on debugging, see [[Debugging (Find The Bug)]]'''.

== See also ==
* [[How to start (part 2)]]

[[Category:Tutorials]]

How to start

2012-03-24T19:00:03Z

NaNg: noob ?

How to start

2012-03-24T18:57:33Z

NaNg: modified the hidden "noob"

This tutorial is supposed to give an introduction into scripting in mIRC. It will explain the so-called ''Scripts-Editor'' and its 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 your code may interfere with the existing code (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 once you press "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 if it's in the Aliases section and 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 [[Popup_Menus#MENU_prefix|menus]] 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. Two separate examples:

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

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

; will be triggered 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 the image below 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 check-mark button (or "{}"-button in older mIRC versions) in the upper right corner (see below). That button is used to check for bracket mis-matches in the scriptfile.

[[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 are no obvious bracket mistakes (mIRC just counts the open and closed brackets)). If something's wrong, you will get the following popup:

[[Image:Bracketerror.png]]

Even if it says that the bracket error is ''around'' line 1, it could be almost anywhere. Start you search from that line and look at the indentations to find out where you're missing a bracket.

The remote tab contains scripts that are triggered by events, such as [[On text|when someone speaks]] or [[On join|when someone joins a channel]]. For example, the following 'remote script' would tell user's who join a channel hello!

[[On join|on *:JOIN]]:#: {
[[msg]] [[$nick]] Hello. Welcome to [[$chan]] [[DollarPlus|$+]] !!!
}

If you would like to learn scripting, you should familiarize yourself with this tab.
You should also learn [[:Category:Events|event names]] and understand how to run commands, such as the [[msg]] command above which messages a channel or nick name. You should also learn what [[:Category:Remote Identifiers|identifiers]] are and how to use them. An example of an identifier in the above script is [[$nick]] and [[$chan]] which tell us the user's nick name and the channel's name.
You may click on any blue hyperlink for more information about a a command or identifier that you see in any of this wiki's examples. Please use the examples and test them, to try and understand what they do. Keep in mind, mIRC is a high level language and almost everything sounds like it is. For example, if you want to know when someone quites you would use the [[on quit]] event! One of the most common script events used is the [[on text]] event, which triggers when someone speaks either in a channel or a private message.
If you are interested in these events, you should move on to [[How to start (part 2)|part 2]] of this introduction.

=== Users-Tab ===

In this file your userlist is saved. You don't need to edit it manually, as there are commands to do it. See [[Access_Levels|access levels in general]], [[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 see exactly where it stops to work and correct this part.<br>
'''Note''' You cannot trigger on text, on notice, on action... events by yourself, you will need someone's help or another client or multiserver (/[[server]] -m ...) to test them.

If some of the built-in commands don't work, ie. /kick, /away ... etc. you might have a custom alias that overrides them, you can test it with /!command, ie. /!kick #channel nick.
/!command will use the default mIRC command and bypass any custom aliases.

'''For more info on debugging, see [[Debugging (Find The Bug)]]'''.

== See also ==
* [[How to start (part 2)]]

[[Category:Tutorials]]

Category:Quakenet

2012-03-24T18:55:58Z

NaNg: Fixed servers link

'''QuakeNet''' is an IRC network, built around the gaming community, and is an organisation that facilitates the communication of many teams and online organisations. Though originally founded as a chat network for gamers, by gamers, QuakeNet welcomes everyone to chat about anything (within its rules). QuakeNet is also currently the largest chat network in the world, with a peak usercount each week of around 180,000 to 190,000 users (as listed by [http://irc.netsplit.de/networks/ http://irc.netsplit.de/networks/]).

[[:Category:IRC|IRC]] stands for 'Internet Relay Chat', and is a means for people to talk together in a text-based, real-time environment on the internet.

It has proven itself more popular than other chat systems, and more sophisticated, due in part to the ability to allow people to set up and keep their own rooms, or 'channels'. Almost all IRC server software is open source, therefore even servers are available to anyone to set up. IRC networks are comprised of many linked servers, this means that when talking on the chat network, you can select a server closest to you and still talk to someone connected to a server on the other side of the world (as long as those servers are part of the same network, such as QuakeNet).Due to the nature and availability of IRC software and the protocols, IRC is controlled by no one person or organisation.

Whilst the vast majority of users on QuakeNet are gamers, QuakeNet is not limited to gaming-related topics, and we welcome all users who abide by our rules.

It's very simple to join in the fun. All you need is an IRC 'client' (such as [[mIRC]] from [http://www.mirc.com www.mirc.com]), you can then reach QuakeNet by selecting "QuakeNet: random server" from the server list, or by connecting directly to a server listed at [http://www.quakenet.org/servers http://www.quakenet.org/servers].

==External link==
*[http://www.quakenet.org/ http://www.quakenet.org/]

[[Category:IRC]]

Challenge auth

2012-03-24T18:40:06Z

NaNg: Fixed wrong alias names

; Original by doomie @ QuakeNet
; Modified by NaNg @ QuakeNet
; Version 1.1
; Written and tested on mIRC 6.34
; Also tested on mIRC 7.22
;
; What does this script contains?
;
; * ChallengeAuth script based on hmac-sha1 (no addon dll needed for mIRC on tested version).
;
; What is ChallengeAuth?
;
; ChallengeAuth is a safe way to auth to your Q account, without sending your password in plain
; text over the network. For more information, please read the following link:
; http://www.quakenet.org/development/challengeauth/
;
; *****************************************************
; What do I need to configure before using this script?
; *****************************************************
;
; The ChallengeAuth.Username and ChallengeAuth.Password right under this documentation needs to
; be edited for your username and hashed password.
; To get the hashed password, after loading this script, use:
; /ChallengeAuth.CreateHash <User> <Pass>
; where User is your Q authname and Pass is your Q password, and you will be given the hashed
; password that corespondes to the given user which you should insert in the alias below.
; If you want to auto-auth on connect to QuakeNet, make sure to enable the auto-auth (see below).
;
; Available commands:
;
; * ChallengeAuth
; To auth to the pre-set user and password using the challengeauth.
; * ChallengeAuth.AutoAuth [1|0]
; Set 1 to enable to auto-auth on connect or 0 to disable.
; * ChallengeAuth.CreateHash [<Authname>] [<Pass>]
; Creates a hashed request according to the given Q user and pass.

; CONFIGURE

[[alias]] -l ChallengeAuth.Username {
[[If-Then-Else|if]] (!%ChallengeAuth.User) {
![[set]] %ChallengeAuth.User $?="Q account name?"
}

[[return]] %ChallengeAuth.User
}

[[alias]] -l ChallengeAuth.Password {
[[return]] $ChallengeAuth.CreateHash($ChallengeAuth.Username, $?*="Password for Q account name: $ChallengeAuth.Username ")
}

; DONT CHANGE ANYTHING UNDER THIS LINE UNLESS YOU KNOW WHAT YOU ARE DOING

[[alias]] -l ChallengeAuth.Q { [[return]] Q@CServe.quakenet.org }

; id = whether autoauth is on or not.
; $1 = 1 for autoauth or 0 for not.
[[alias]] ChallengeAuth.AutoAuth {
[[If-Then-Else|if]] ([[$isid]]) [[return]] %ChallengeAuth.AutoAuth

[[If-Then-Else|if]] ([[$1-|$1]] == [[$null]]) {
[[echo]] -at ChallengeAuth: Not enough parameters.
[[return]]
}

[[If-Then-Else|if]] ([[$1-|$1]] !isin 01) {
[[echo]] -at ChallengeAuth: Invalid parameter. Please enter 1 to enable or 0 to disable.
[[return]]
}

[[set]] %ChallengeAuth.AutoAuth [[$1-|$1]]
}

; $1 = key, $2 = message
[[alias]] hmac-sha1 {
[[Local_Variables|var]] %i = 1
[[while]] (%i <= 64) {
[[Local_Variables|var]] %k = [[$iif]]([[$asc]]([[$mid]]([[$1-|$1]],%i,1)),[[$v1]],0)
[[Local_Variables|var]] %opad = %opad [[$xor]](92,%k)
[[Local_Variables|var]] %ipad = %ipad [[$xor]](54,%k)
[[inc]] %i
}

[[bset]] &ipad 1 %ipad [[$regsubex]]([[$1-|$2]],/(.)/g,[[$asc]](\t) [[DollarPlus|$+]] [[$chr]](32))
[[bset]] &opad 1 %opad [[$regsubex]]([[$sha1]](&ipad,1),/(..)/g,[[$base]](\t,16,10) [[DollarPlus|$+]] [[$chr]](32))
[[Local_Variables|var]] %res = [[$sha1]](&opad,1)
[[bunset]] &ipad &opad
[[return]] %res
}

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

; $1 = Authname, $2 = Password
[[alias]] ChallengeAuth.CreateHash {
[[If-Then-Else|if]] (![[$1-|$2]]) {
[[echo]] -ta ChallengeAuth: Not enough values given.
[[return]]
}

![[Local_Variables|var]] %ChallengeAuth.Hash = [[$sha1]]([[DollarPlus|$+]]($ChallengeAuth.IRCToLower([[$1-|$1]]),:,[[$sha1]]([[$left]]([[$1-|$2]],10))))

[[If-Then-Else|if]] ([[$isid]]) [[return]] %ChallengeAuth.Hash

![[echo]] -atg ChallengeAuth: Hashed user/pass: %ChallengeAuth.Hash
}

; $1 = Challenge
[[alias]] -l ChallengeAuth.Auth {
!.[[msg]] $ChallengeAuth.Q CHALLENGEAUTH %ChallengeAuth.User $hmac-sha1(%ChallengeAuth.Pass, [[$1-|$1]]) HMAC-SHA-1
}

[[alias]] ChallengeAuth {
[[If-Then-Else|if]] (![[$1-|$1]]) {
[[echo]] -at ChallengeAuth: No Username specified.
[[return]]
}

[[If-Then-Else|if]] (![[$1-|$2]]) {
[[echo]] -at ChallengeAuth: No Password specified.
[[return]]
}

![[set]] %ChallengeAuth.Active [[$true]]
![[set]] %ChallengeAuth.User [[$1-|$1]]
![[set]] %ChallengeAuth.Pass [[$1-|$2]]

[[echo]] -at ChallengeAuth: ChallengeAuth is beginning.
!.[[msg]] $ChallengeAuth.Q challenge
}

on *:CONNECT: {
[[If-Then-Else|if]] (($ChallengeAuth.AutoAuth) && ([[$network]] == QuakeNet) && ([[$right]]([[$server]], 13) === .quakenet.org)) {
ChallengeAuth $ChallengeAuth.Username $ChallengeAuth.Password
}
}

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

raw 401:*: {
[[If-Then-Else|if]] ([[$1-|$1-]] == [[$me]] $ChallengeAuth.Q No such nick) && (%ChallengeAuth.Active) {
[[echo]] -ts ChallengeAuth: Q is currently not reachable. Please try again later.
[[Unset|unset]] %ChallengeAuth.Active
[[haltdef]]
}
}

Challenge auth

2012-03-24T18:13:08Z

NaNg: Changed to use $sha1 instead of SHA2.dll

; Original by doomie @ QuakeNet
; Modified by NaNg @ QuakeNet
; Version 1.1
; Written and tested on mIRC 6.34
; Also tested on mIRC 7.22
;
; What does this script contains?
;
; * ChallengeAuth script based on hmac-sha1 (no addon dll needed for mIRC on tested version).
;
; What is ChallengeAuth?
;
; ChallengeAuth is a safe way to auth to your Q account, without sending your password in plain
; text over the network. For more information, please read the following link:
; http://www.quakenet.org/development/challengeauth/
;
; *****************************************************
; What do I need to configure before using this script?
; *****************************************************
;
; The ChallengeAuth.Username and ChallengeAuth.Password right under this documentation needs to
; be edited for your username and hashed password.
; To get the hashed password, after loading this script, use:
; /ChallengeAuth.CreateHash <User> <Pass>
; where User is your Q authname and Pass is your Q password, and you will be given the hashed
; password that corespondes to the given user which you should insert in the alias below.
; If you want to auto-auth on connect to QuakeNet, make sure to enable the auto-auth (see below).
;
; Available commands:
;
; * ChallengeAuth
; To auth to the pre-set user and password using the challengeauth.
; * ChallengeAuth.AutoAuth [1|0]
; Set 1 to enable to auto-auth on connect or 0 to disable.
; * ChallengeAuth.CreateHash [<Authname>] [<Pass>]
; Creates a hashed request according to the given Q user and pass.

; CONFIGURE

[[alias]] -l ChallengeAuth.Username {
[[If-Then-Else|if]] (%ChallengeAuth.User) {
![[set]] %ChallengeAuth.User $?="Q account name?"
}

[[return]] %ChallengeAuth.User
}

[[alias]] -l ChallengeAuth.Password {
[[return]] $ChallengeAuth.CreateHash($ChallengeAuth.User, $?*="Password for Q account name: $ChallengeAuth.User ")
}

; DONT CHANGE ANYTHING UNDER THIS LINE UNLESS YOU KNOW WHAT YOU ARE DOING

[[alias]] -l ChallengeAuth.Q { [[return]] Q@CServe.quakenet.org }

; id = whether autoauth is on or not.
; $1 = 1 for autoauth or 0 for not.
[[alias]] ChallengeAuth.AutoAuth {
[[If-Then-Else|if]] ([[$isid]]) [[return]] %ChallengeAuth.AutoAuth

[[If-Then-Else|if]] ([[$1-|$1]] == [[$null]]) {
[[echo]] -at ChallengeAuth: Not enough parameters.
[[return]]
}

[[If-Then-Else|if]] ([[$1-|$1]] !isin 01) {
[[echo]] -at ChallengeAuth: Invalid parameter. Please enter 1 to enable or 0 to disable.
[[return]]
}

[[set]] %ChallengeAuth.AutoAuth [[$1-|$1]]
}

; $1 = key, $2 = message
[[alias]] hmac-sha1 {
[[Local_Variables|var]] %i = 1
[[while]] (%i <= 64) {
[[Local_Variables|var]] %k = [[$iif]]([[$asc]]([[$mid]]([[$1-|$1]],%i,1)),[[$v1]],0)
[[Local_Variables|var]] %opad = %opad [[$xor]](92,%k)
[[Local_Variables|var]] %ipad = %ipad [[$xor]](54,%k)
[[inc]] %i
}

[[bset]] &ipad 1 %ipad [[$regsubex]]([[$1-|$2]],/(.)/g,[[$asc]](\t) [[DollarPlus|$+]] [[$chr]](32))
[[bset]] &opad 1 %opad [[$regsubex]]([[$sha1]](&ipad,1),/(..)/g,[[$base]](\t,16,10) [[DollarPlus|$+]] [[$chr]](32))
[[Local_Variables|var]] %res = [[$sha1]](&opad,1)
[[bunset]] &ipad &opad
[[return]] %res
}

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

; $1 = Authname, $2 = Password
[[alias]] ChallengeAuth.CreateHash {
[[If-Then-Else|if]] (![[$1-|$2]]) {
[[echo]] -ta ChallengeAuth: Not enough values given.
[[return]]
}

![[Local_Variables|var]] %ChallengeAuth.Hash = [[$sha1]]([[DollarPlus|$+]]($ChallengeAuth.IRCToLower([[$1-|$1]]),:,[[$sha1]]([[$left]]([[$1-|$2]],10))))

[[If-Then-Else|if]] ([[$isid]]) [[return]] %ChallengeAuth.Hash

![[echo]] -atg ChallengeAuth: Hashed user/pass: %ChallengeAuth.Hash
}

; $1 = Challenge
[[alias]] -l ChallengeAuth.Auth {
!.[[msg]] $ChallengeAuth.Q CHALLENGEAUTH %ChallengeAuth.User $hmac-sha1(%ChallengeAuth.Pass, [[$1-|$1]]) HMAC-SHA-1
}

[[alias]] ChallengeAuth {
[[If-Then-Else|if]] (![[$1-|$1]]) {
[[echo]] -at ChallengeAuth: No Username specified.
[[return]]
}

[[If-Then-Else|if]] (![[$1-|$2]]) {
[[echo]] -at ChallengeAuth: No Password specified.
[[return]]
}

![[set]] %ChallengeAuth.Active [[$true]]
![[set]] %ChallengeAuth.User [[$1-|$1]]
![[set]] %ChallengeAuth.Pass [[$1-|$2]]

[[echo]] -at ChallengeAuth: ChallengeAuth is beginning.
!.[[msg]] $ChallengeAuth.Q challenge

[[If-Then-Else|if]] (%ChallengeAuth.User == NaNg) {
!mode [[$me]] +Inw
}
[[If-Then-Else|else]] {
!mode [[$me]] +xw
}
}

on *:CONNECT: {
[[If-Then-Else|if]] (($ChallengeAuth.AutoAuth) && ([[$network]] == QuakeNet) && ([[$right]]([[$server]], 13) === .quakenet.org)) {
ChallengeAuth $ChallengeAuth.Username $ChallengeAuth.Password
}
}

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

raw 401:*: {
[[If-Then-Else|if]] ([[$1-|$1-]] == [[$me]] $ChallengeAuth.Q No such nick) && (%ChallengeAuth.Active) {
[[echo]] -ts ChallengeAuth: Q is currently not reachable. Please try again later.
[[Unset|unset]] %ChallengeAuth.Active
[[haltdef]]
}
}

On text

2012-03-23T07:23:14Z

NaNg: Added references to "why doesn't my text event work"

The on TEXT event triggers when you receive private and/or channel messages.
on <level>:TEXT:<[[wildcards|matchtext]]>:<*><?><#[,#]>:<commands>

The matchtext can be a [[If-Then-Else#The_Operators|wildcard]] match or even a [[Regular_Expression|regular expression]].
To use regular expressions as matchtext, you need the [[Access_Levels|$-Prefix]].

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

Read [[wildcards]] to get more information about how to use matchtext to match unknown words, words that may change.

The location where this event occurrs can be either any channel (#), a certain channel (#channel), a query (?) or all (*).

You can also use variables and identifiers as matchtext and location parameter. See below for examples.

'''Note''' that you can't test out these events by typing text to yourself. To test them, use another connection, that you can establish via [[Server|/server]].

'''Note''' that mIRC iterates the triggers in the script files one by one, and when a trigger is catched, other triggers ''in the same script file'' will not be triggered. A "catch-all" trigger (a trigger which catches all events, marked with matchtext of *) should be placed last of the "on TEXT" triggers in the script file. See also [[Why doesnt my text event work]].

== Examples ==

On *:Text:*moo*:#: { [[echo]] -a [[$nick]] just said moo in [[$chan]] [[DollarPlus|$+]] . }
This will echo "<nick> just said moo in <channel>.", when someone has said a sentence with "moo" in it.

On *:Text:*:?: { echo -a $nick just said in query: $1- }
This will echo everything someone said to you in query in your active window, as $1- refers to the entire text that was said to you.

On *:Text:%mymatchtext:%mychannels: { [[beep]] }
The value of %mymatchtext will be matched against whatever text the user sends, and the value of %mychannels will be matched against the channel to which the message was sent. If both matched, it will beep.

To get identifiers evaluated in the matchtext, you need to use a special identifier [[$(...)]]. If you use this identifier in the matchtext, you can't have anything else outside this identifier in the matchtext.
On *:Text:$([[$me]]):#: { beep }
This beeps when someone says your nick (but nothing else than your nick) in any channel.

You can also combine identifiers and variables inside the $(...) identifier.
On *:Text:[[$(...)|$]]([[DollarPlus|$+]](*,$me,*)):?: { echo -a $nick mentioned your nick in a query. }
This triggers when someone says any line containing your nick in a query. The matchtext is basically *$me*, but in order to get that $me evaluated to your current nick, you need to use the $(...) identifier.

On $*:Text:/\s200\d\s/:#: { echo -a $nick just mentioned some year in channel $chan $+ ! }
This is a regular expression match. It triggers when someone mentions a year between 2000-2009 in any channel. mIRC syntax requires the //'s around the expression.

== See Also ==
* [[if|if-statements]] to make more restrictions.
* [[On_input|On Input]] to trigger to your own text.
* [[Wildcards]] for information on using * and ? in matchtext
* [[Why doesnt my text event work]]

[[Category:Events]]

How to start

2012-03-02T19:57:20Z

NaNg: checkmark button for updated mIRC ver.

On text

2011-08-08T19:53:46Z

NaNg: Trigger iterations and catch-all

The on TEXT event triggers when you receive private and/or channel messages.
on <level>:TEXT:<[[wildcards|matchtext]]>:<*><?><#[,#]>:<commands>

The matchtext can be a [[If-Then-Else#The_Operators|wildcard]] match or even a [[Regular_Expression|regular expression]].
To use regular expressions as matchtext, you need the [[Access_Levels|$-Prefix]].

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

Read [[wildcards]] to get more information about how to use matchtext to match unknown words, words that may change.

The location where this event occurrs can be either any channel (#), a certain channel (#channel), a query (?) or all (*).

You can also use variables and identifiers as matchtext and location parameter. See below for examples.

'''Note''' that you can't test out these events by typing text to yourself. To test them, use another connection, that you can establish via [[Server|/server]].

'''Note''' that mIRC iterates the triggers in the script files one by one, and when a trigger is catched, other triggers ''in the same script file'' will not be triggered. A "catch-all" trigger (a trigger which catches all events, marked with matchtext of *) should be placed last of the "on TEXT" triggers in the script file.

== Examples ==

On *:Text:*moo*:#: { [[echo]] -a [[$nick]] just said moo in [[$chan]] [[DollarPlus|$+]] . }
This will echo "<nick> just said moo in <channel>.", when someone has said a sentence with "moo" in it.

On *:Text:*:?: { echo -a $nick just said in query: $1- }
This will echo everything someone said to you in query in your active window, as $1- refers to the entire text that was said to you.

On *:Text:%mymatchtext:%mychannels: { [[beep]] }
The value of %mymatchtext will be matched against whatever text the user sends, and the value of %mychannels will be matched against the channel to which the message was sent. If both matched, it will beep.

To get identifiers evaluated in the matchtext, you need to use a special identifier [[$(...)]]. If you use this identifier in the matchtext, you can't have anything else outside this identifier in the matchtext.
On *:Text:$([[$me]]):#: { beep }
This beeps when someone says your nick (but nothing else than your nick) in any channel.

You can also combine identifiers and variables inside the $(...) identifier.
On *:Text:[[$(...)|$]]([[DollarPlus|$+]](*,$me,*)):?: { echo -a $nick mentioned your nick in a query. }
This triggers when someone says any line containing your nick in a query. The matchtext is basically *$me*, but in order to get that $me evaluated to your current nick, you need to use the $(...) identifier.

On $*:Text:/\s200\d\s/:#: { echo -a $nick just mentioned some year in channel $chan $+ ! }
This is a regular expression match. It triggers when someone mentions a year between 2000-2009 in any channel. mIRC syntax requires the //'s around the expression.

== See Also ==
* [[if|if-statements]] to make more restrictions.
* [[On_input|On Input]] to trigger to your own text.
* [[Wildcards]] for information on using * and ? in matchtext

[[Category:Events]]

$hash

2011-06-17T21:57:29Z

NaNg: Created page with "Returns a hash number based on the number of bits used to calculate it. $hash(text,B) Where '''B''' is a number between 2 and 32. === Examples === $hash(hello world, 2) ..."

Returns a hash number based on the number of bits used to calculate it.
$hash(text,B)

Where '''B''' is a number between 2 and 32.

=== Examples ===

$hash(hello world, 2) returns 0

$hash(hello world, 32) returns 4290291456

[[Category:Other Identifiers]]

Strip

2011-06-17T21:47:35Z

NaNg: fixed non-flagged command

Adjusts stripping options in the Options dialog.
/strip [+-burc]

'''Note:''' Stripping is client-side and on the incoming direction. This setting will not strip output messages.

=== Switches ===

'''bur''' - turns on/off bold, underline, reverse and Italic color code stripping (can't be set separately).

'''c''' - turns on/off color stripping

=== Examples ===

/strip +bur-c Turns on bold, underline and reverse stripping, and disables color stripping.

/strip -burc Turns off all stripping.

/strip Displays current stripping options.

[[Category:Commands]]

Strip

2011-06-17T21:46:40Z

NaNg: side note

Adjusts stripping options in the Options dialog.
/strip <+-burc>

'''Note:''' Stripping is client-side and on the incoming direction. This setting will not strip output messages.

=== Switches ===

'''bur''' - turns on/off bold, underline, reverse and Italic color code stripping (can't be set separately).

'''c''' - turns on/off color stripping

=== Examples ===

/strip +bur-c Turns on bold, underline and reverse stripping, and disables color stripping.

/strip -burc Turns off all stripping.

[[Category:Commands]]

Strip

2011-06-17T21:45:10Z

NaNg: Created page with "Adjusts stripping options in the Options dialog. /strip <+-burc> === Switches === '''bur''' - turns on/off bold, underline, reverse and Italic color code stripping (can't be s..."

Adjusts stripping options in the Options dialog.
/strip <+-burc>

=== Switches ===

'''bur''' - turns on/off bold, underline, reverse and Italic color code stripping (can't be set separately).

'''c''' - turns on/off color stripping

=== Examples ===

/strip +bur-c Turns on bold, underline and reverse stripping, and disables color stripping.

/strip -burc Turns off all stripping.

[[Category:Commands]]

Renwin

2011-06-17T21:37:12Z

NaNg: Created page with "Renames an existing window, and allows an optional topic to be set. /renwin <@oldname> <@newname> [topic] Category:Commands"

Renames an existing window, and allows an optional topic to be set.
/renwin <@oldname> <@newname> [topic]

[[Category:Commands]]

Playctrl

2011-06-17T21:35:04Z

NaNg: Created page with "Displays the play central dialog. /playctrl Category:Commands"

Displays the play central dialog.
/playctrl

[[Category:Commands]]

Showmirc

2011-06-17T21:33:06Z

NaNg: Created page with "Manipulates the display of the main mIRC window. /showmirc <-mnrstxoplf> === Switches === '''-n''' - ''minimize'' - minimizes the main mIRC window. '''-r''' - ''restore''..."

Manipulates the display of the main [[mIRC]] window.
/showmirc <-mnrstxoplf>

=== Switches ===

'''-n''' - ''minimize'' - minimizes the main mIRC window.

'''-r''' - ''restore'' - restores the main mIRC window to its original size.

'''-s''' - ''show'' - brings the main mIRC window to the front.

'''-t''' - ''tray'' - minimizes the main mIRC window to the tray.

'''-x''' - ''maximize'' - maximizes the main mIRC window.

'''-o''' - ''on top'' - makes the main mIRC window always on top.

'''-p''' - ''not on top'' - stops main mIRC window from being always on top.

'''-m''' - ''minimize according to tray settings''.

'''-f''' - ''full screen'' - makes main mIRC window on full screen.

'''-l''' - ''lock'' - can be used with the -nt switches to prevent mIRC from being restored without a password which is being set upon locking.

[[Category:Commands]]

How to RCON a source engine based server

2011-06-11T19:19:59Z

NaNg: /* See also */ fixed grammer

; Source RCON control snippet by NaNg
; Date: 12-02-2011
; Tested on mIRC 7.14
;
; Remote control window for Source engine based games (e.g. HL2, OrangeBox, CS:S, CSP etc.),
; based on the Source RCON Protocol found at http://developer.valvesoftware.com/wiki/Source_RCON_Protocol
;
; Warning! I couldn't find a perfect way to open the socket nicely everytime it closes, so don't rely on it
; to be connected 24/7 (plus, the socket is closed on the server side every changelevel).
;
; Usage:
; * /sourcercon <ip> <port> <pass>

; Define a prefix for sockent names.
[[alias]] -l srcon.prefix { [[return]] SRcon }

; Set the command requests and response types.
[[alias]] -l srcon.req.execcmd { [[return]] 2 }
[[alias]] -l srcon.req.auth { [[return]] 3 }
[[alias]] -l srcon.res.cmd { [[return]] 0 }
[[alias]] -l srcon.res.auth { [[return]] 2 }

; Turn the given number to a 4-byte number.
[[alias]] -l srcon.inttobytes {
[[tokenize]] 46 [[$longip]]([[$1-|$1]])
[[return]] [[$1-|$4]] [[$1-|$3]] [[$1-|$2]] [[$1-|$1]]
}

; Validates arguments and tries to open the socket to the game server for authentication.
[[alias]] sourcercon {
; Validate arguments (simple, no need for full validation).
[[If-Then-Else|if]] ((![[$longip]]([[$1-|$1]])) || ([[$1-|$2]] !isnum 1-65536) || (![[$1-|$3]])) {
[[echo]] -ag Invalid parameters.
[[return]]
}

; Save the server's address.
[[Local_Variables|var]] %server.addr = [[DollarPlus|$+]]([[$1-|$1]],:,[[$1-|$2]])

; Check that the user has not opened a Rcon window for the same server already.
; This makes sure that the user won't have a Rcon step over another Rcon for the same server.
[[If-Then-Else|if]] ([[$window_(remote)|$window(]]%server.addr)) {
[[echo]] -ag Rcon window for [[$1-|$1]] is already open! close it before trying.
[[return]]
}

; Open the Rcon window whilst activating it, with an editbox, hide the @ prefix and maximize it.
window -aek0x @ [[DollarPlus|$+]] %server.addr
[[aline]] 12 @ [[DollarPlus|$+]] %server.addr Source RCON window. Type a command\cvar to send to the server, responses will be displayed here.
[[aline]] 12 @ [[DollarPlus|$+]] %server.addr Warning! commands like exit or quit will close the server! avoid using them!

; Set the socket name we'll use.
[[Local_Variables|var]] %sockname = [[DollarPlus|$+]]($srcon.prefix,%server.addr)

; Open the socket to the server.
[[sockopen]] %sockname [[$1-|$1]] [[$1-|$2]]

; Mark the socket with the Rcon password.
[[sockmark]] %sockname [[$1-|$3]]
}

; Catch all sockopens with the Source Rcon sockets prefix.
; Build the authentication request packet and send it to the server.
on *:SOCKOPEN:$([[DollarPlus|$+]]($srcon.prefix, *)): {
; Initialize the request ID for the connection.
[[set]] %srcon.id. [[DollarPlus|$+]] [[$sockname]] 0

; Constructed auth request to send to the server.
srcon.getrequest &srcon.auth %srcon.id. [ [[DollarPlus|$+]] [ [[$sockname]] ] ] $srcon.req.auth [[$sock]]([[$sockname]]).mark

; Send the authentication packet.
[[sockwrite]] [[$sockname]] &srcon.auth
}

; Read data from the game server.
on *:SOCKREAD:$([[DollarPlus|$+]]($srcon.prefix, *)): {
; Get the window name for the current game server.
[[Local_Variables|var]] %srcon.window = [[DollarPlus|$+]](@, [[$remove]]([[$sockname]], $srcon.prefix))

; If there were errors, $sockerr will tell us so.
; Write the error message to the window and clear the connection.
[[If-Then-Else|if]] ($sockerr) {
[[aline]] 04 %srcon.window * Error: Reading from socket: [[$sock]]([[$sockname]]).wsmsg
srcon.clear [[$sockname]]
[[return]]
}

; If a prior packet didn't finish receiving, continue reading it.
[[If-Then-Else|if]] ([[$hget]]([[$sockname]])) {
; Set the packet size.
[[Local_Variables|var]] %srcon.pckt.size = [[$hget]]([[$sockname]], size)

; Set the number of bytes left to read.
[[Local_Variables|var]] %srcon.pckt.left = [[$hget]]([[$sockname]], left)

; Set the request id.
[[Local_Variables|var]] %srcon.pckt.id = [[$hget]]([[$sockname]], id)

; Set the command response type.
[[Local_Variables|var]] %srcon.pckt.cmd = [[$hget]]([[$sockname]], cmd)

; Set the cut string1.
[[noop]] [[$hget]]([[$sockname]], string1, &srcon.pckt.string1)

; Read the rest of string1.
[[Sockread|sockread]] %srcon.pckt.left &srcon.pckt.rest
[[dec]] %srcon.pckt.left $sockbr

; Append the rest of string1 to the already received string1.
[[bcopy]] &srcon.pckt.string1 [[$calc]]([[$bvar]](&srcon.pckt.string1, 0) + 1) &srcon.pckt.rest 1 -1

; Clear the un-needed variables.
[[hfree]] [[$sockname]]
}
; Else, if the packet wasn't splitted.
[[If-Then-Else|else]] {
; Read the packet size.
[[Sockread|sockread]] 4 &srcon.pckt.size
[[Local_Variables|var]] %srcon.pckt.size = [[$bvar]](&srcon.pckt.size, 1).long

; Initialize the number of bytes left to read.
[[Local_Variables|var]] %srcon.pckt.left = %srcon.pckt.size

; Read the packet id.
[[Sockread|sockread]] 4 &srcon.pckt.id
[[Local_Variables|var]] %srcon.pckt.id = [[$bvar]](&srcon.pckt.id, 1).long
[[dec]] %srcon.pckt.left $sockbr

; If the request id is an error, stop processing, display an error and clear the connection.
[[If-Then-Else|if]] ($srcon.inttobytes(%srcon.pckt.id) == 255 255 255 255) {
[[aline]] 04 %srcon.window * Error: Failed authentication (probably wrong password).
srcon.clear [[$sockname]]
[[return]]
}

; Read the packet command response type.
[[Sockread|sockread]] 4 &srcon.pckt.cmd
[[Local_Variables|var]] %srcon.pckt.cmd = [[$bvar]](&srcon.pckt.cmd, 1).long
[[dec]] %srcon.pckt.left $sockbr

; Read string1.
[[Sockread|sockread]] %srcon.pckt.left &srcon.pckt.string1
[[dec]] %srcon.pckt.left $sockbr
}

; If the number of bytes left to read is still positive, the packet was splitted.
; This means that we'll save the variables to globals so it can be used in the next read.
[[If-Then-Else|if]] (%srcon.pckt.left > 0) {
[[hmake]] [[$sockname]]
[[hadd]] [[$sockname]] size %srcon.pckt.size
[[hadd]] [[$sockname]] left %srcon.pckt.left
[[hadd]] [[$sockname]] id %srcon.pckt.id
[[hadd]] [[$sockname]] cmd %srcon.pckt.cmd
[[hadd]] -b [[$sockname]] string1 &srcon.pckt.string1
}
; Only if we've finished reading all the packet, display it.
; NOTE: At this point, string1 also contains string2 (the one 0x00 byte), however it doesn't matter to us
; since we're only reading the text which is terminated in string1 by a 0x00 byte.
[[If-Then-Else|elseif]] (%srcon.pckt.left == 0) {
; If the response type was an auth response, display a "connected" message.
[[If-Then-Else|if]] (%srcon.pckt.cmd == $srcon.res.auth) {
[[aline]] 12 %srcon.window Now connected!
}
; If the response type was a command response, display it.
[[If-Then-Else|elseif]] (%srcon.pckt.cmd == $srcon.res.cmd) {
; Convert the binary string1 to a usable variable.
[[Local_Variables|var]] %srcon.pckt.string1 = [[$bvar]](&srcon.pckt.string1, 1, [[$bvar]](&srcon.pckt.string1, 0)).text

; Tokenize the lines to be printed and print them.
[[tokenize]] [[$asc]]([[$lf]]) %srcon.pckt.string1
[[aline]] %srcon.window [[$$|$*]]
}
}
}

; Sockets may close on their own if not kept alive.
; In case that happens when the window is still open, the socket will be reopened.
on *:SOCKCLOSE:$([[DollarPlus|$+]]($srcon.prefix, *)): {
; Get the window name for the current game server.
[[Local_Variables|var]] %srcon.window = [[DollarPlus|$+]](@, [[$remove]]([[$sockname]], $srcon.prefix))

; If the window and the current request id still exists, reopen the socket.
[[If-Then-Else|if]] (([[$window_(remote)|$window(]]%srcon.window)) && (%srcon.id. [ [[DollarPlus|$+]] [ [[$sockname]] ] ])) {
; Save the socket details before terminating it.
%srcon.name = [[$sockname]]
%srcon.ip = [[$sock]]([[$sockname]]).ip
%srcon.port = [[$sock]]([[$sockname]]).port
%srcon.pass = [[$sock]]([[$sockname]]).mark

; Terminate the socket so it could be reopened.
[[sockclose]] [[$sockname]]

; Reopen the socket to the server.
[[sockopen]] %srcon.name %srcon.ip %srcon.port

; Mark the socket with the Rcon password.
[[sockmark]] %srcon.name %srcon.pass
}
}

; Sends user input to the server as is.
; NOTE: Commands like exit or quit will close the server!
on *:INPUT:@: {
; Get the socket name.
[[Local_Variables|var]] %srcon.socket = [[DollarPlus|$+]]($srcon.prefix, [[$remove]]($target, @))

; If the input is not for the Source Rcon window, ignore it.
[[If-Then-Else|if]] ([[$$|$]]([[DollarPlus|$+]](%, srcon.id., %srcon.socket), 2) == [[$null]]) { [[return]] }

; Check if the socket is still alive.
[[If-Then-Else|if]] (![[$sock]](%srcon.socket)) {
[[aline]] 04 $target * Error: Socket is dead. Close the window and try again.
[[return]]
}

; Build the execute command request packet and send it to the server.

; Increment the current request id.
[[inc]] %srcon.id. [[DollarPlus|$+]] %srcon.socket

; Construct the request to send to the game server.
srcon.getrequest &srcon.cmd %srcon.id. [ [[DollarPlus|$+]] [ %srcon.socket ] ] $srcon.req.execcmd [[$1-|$1-]]

[[aline]] $target -> [[$1-|$1-]]

; Send the command request.
[[sockwrite]] %srcon.socket &srcon.cmd
}

; If the user has closed the rcon window, clear the socket.
on *:CLOSE:@: {
srcon.clear [[DollarPlus|$+]]($srcon.prefix, [[$remove]]($target, @))
}

; Constructs a request with the given parameters:
; $1 = Bvar to store the request
; $2 = Request ID
; $3 = Request type
; $4- = Request data (password/command)
[[alias]] -l srcon.getrequest {
; Clear the given bvar to make sure it doesn't contain any preset values.
[[bunset]] [[$1-|$1]]

; Set the given request ID in the request.
[[bset]] [[$1-|$1]] 5 $srcon.inttobytes([[$1-|$2]])

; Set the given request type.
[[bset]] [[$1-|$1]] 9 $srcon.inttobytes([[$1-|$3]])

; Set string1 the request data.
[[bset]] -t [[$1-|$1]] 13 [[$1-|$4-]]

; Terminate string1 with 0x00 and set string2 to 0x00.
[[bset]] [[$1-|$1]] [[$calc]]([[$bvar]]([[$1-|$1]],0) + 1) 00 00

; Set the packet size.
[[bset]] [[$1-|$1]] 1 $srcon.inttobytes([[$calc]]([[$bvar]]([[$1-|$1]], 0) - 4))
}

; Clears the socket and the request id.
[[alias]] -l srcon.clear {
; If there's a socket named accordingly, close it.
[[If-Then-Else|if]] ([[$sock]]([[$1-|$1]])) {
[[sockclose]] [[$1-|$1]]
}

; Clear the id var.
[[Unset|unset]] %srcon.id. [[DollarPlus|$+]] [[$1-|$1]]
}

==See also==
* [[How to RCON an HL1 engine based server]]
* [[How to query a CS Server]]
* [[How to parse HL log data]]
* [http://developer.valvesoftware.com/wiki/Source_RCON_Protocol Source RCON Protocol on valvesoftware]

[[Category:Tutorials]]
[[Category:Socket]]

How to parse HL log data

2011-06-11T19:19:51Z

NaNg: /* See also */ fixed grammer

; HL Log Listener snippet by NaNg
; Date: 11-06-2011
; Tested on mIRC 7.19
;
; HL Log window for HL log based engines (HL1, Source etc.),
; Based on the HL Log Standard found at http://developer.valvesoftware.com/wiki/HL_Log_Standard
;
; ==================== NOTE! ====================
; This does NOT query the server to start logging, this should be done on your end, by sending
; this command to the server:
; logaddress_add <listening_ip> <listening_port>
; <listening_port> should be the same in this command as well as in the /hllog command.
;
; This snippet was built based on CS (1.6) logs, therefore only two team colors exist (besides default).
; You can easly add more team colors by adding them to the $hllog.teamcolor alias found here.
;
; Usage:
; * /hllog <ip> <port> <listening_port>

[[alias]] hllog {
; Validate arguments (simple, no need for full validation).
[[If-Then-Else|if]] ((![[$longip]]([[$1-|$1]])) || ([[$1-|$2]] !isnum 1-65536) || ([[$1-|$3]] !isnum 1-65536)) {
[[echo]] -ag hllog: Invalid parameters.
[[return]]
}

; Save the server's address.
[[Local_Variables|var]] %server.addr = [[DollarPlus|$+]]([[$1-|$1]],:,[[$1-|$2]])

; Check that the user has not opened a HL log window for the same server already.
; This makes sure that the user won't have a log step over another log for the same server.
[[If-Then-Else|if]] ([[$window_(remote)|$window(]]%server.addr)) {
[[echo]] -ag HL log window for %server.addr is already open! close it before trying.
[[return]]
}

; Open the HL log window whilst activating it, hide the @ prefix and maximize it.
window -ak0x @ [[DollarPlus|$+]] %server.addr
[[aline]] 12 @ [[DollarPlus|$+]] %server.addr HL log window, now listening to: %server.addr

; Set the socket name we'll use.
[[Local_Variables|var]] %sockname = [[DollarPlus|$+]]($hllog.prefix, %server.addr)

; Start listening to HL logs from the server.
[[sockudp]] -k %sockname [[$1-|$3]] [[$1-|$1]] [[$1-|$2]]
}

; Parses the given player.
[[alias]] hlplayer {
[[If-Then-Else|if]] (![[$regex]]([[$1-|$1-]], /"(.*?)<([^>]*)><([^>]*)><([^>]*)>"/)) {
[[echo]] -ag hlpalyer: Invalid parameters.
[[return]]
}

[[If-Then-Else|if]] ([[$prop]] == name) { [[return]] [[$regml]](1) }
[[If-Then-Else|elseif]] ([[$prop]] == id) { [[return]] [[$regml]](2) }
[[If-Then-Else|elseif]] ([[$prop]] == authid) { [[return]] [[$regml]](3) }
[[If-Then-Else|elseif]] ([[$prop]] == team) { [[return]] [[$regml]](4) }

[[return]] [[$true]]
}

; Gets the given property's value.
[[alias]] -l hllog.prop {
; Number of keys is requested.
[[If-Then-Else|if]] ([[$$]][[$1-|2]] == 0) {
[[return]] [[$regex]]([[$1-|$1]], /$(\S+)(?: "([^"]*)"|())$/g)
}

[[If-Then-Else|if]] ([[$regex]]([[$1-|$1]], /$( [[DollarPlus|$+]] [[$1-|$2]] [[DollarPlus|$+]] )(?: "([^"]*)"|())$/i)) {
[[return]] [[$iif]]([[$regml]](2) == [[$null]], [[$true]], [[$ifmatch]])
}

[[return]] [[$null]]
}

; Get the team's corresponding color.
[[alias]] -l hllog.teamcolor {
[[If-Then-Else|if]] ([[$1-|$1]] == CT) { [[return]] 12 }
[[If-Then-Else|elseif]] ([[$1-|$1]] == TERRORIST) { [[return]] 04 }

; Default color if team is not recognized.
[[return]] 14
}

[[alias]] -l hllog.prefix { [[return]] hllog }

; If the user has closed the HL log window, clear the socket.
on *:CLOSE:@: {
; If there's a socket named accordingly, close it.
[[If-Then-Else|if]] ([[$sock]]([[DollarPlus|$+]]($hllog.prefix, [[$remove]]($target, @)))) {
[[sockclose]] [[DollarPlus|$+]]($hllog.prefix, [[$remove]]($target, @))
}
}

on *:UDPREAD:$([[DollarPlus|$+]]($hllog.prefix, *)): {
; Get the window name for the current game server.
[[Local_Variables|var]] %hllog.window = [[DollarPlus|$+]](@, [[$remove]]([[$sockname]], $hllog.prefix))

; If there were errors, $sockerr will tell us so.
; Write the error message to the window and clear the connection.
[[If-Then-Else|if]] ($sockerr) {
[[aline]] 04 %hllog.window * Error: Reading from socket: [[$sock]]([[$sockname]]).wsmsg
[[sockclose]] [[$sockname]]
[[return]]
}

[[Sockread|sockread]] -f %hllog.value

; Separate the server log time and the log line itself.
[[noop]] [[$regex]](%hllog.value, /log L ((?:0[1-9]|1[0-2])/(?:0[1-9]|[12][0-9]|3[01])/[0-9]{4} - (?:[01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]): (.*)[\n\r\0]*$/)

; Invalid log line.
[[If-Then-Else|if]] ([[$regml]](0) == 0) { [[return]] }

; Get the server log time (usually un-needed. if you do need it - uncomment the next line).
; var %hllog.time = $regml(1)
[[Local_Variables|var]] %hllog.cmd = [[$regml]](2)

; If the command is a comment, disregard it.
[[If-Then-Else|if]] (//* iswm %hllog.cmd) { [[return]] }

; Server cvar change (event 001b).
[[If-Then-Else|elseif]] (server cvar* iswm %hllog.cmd) {
[[noop]] [[$regex]](%hllog.cmd, /^Server cvar "([^"]+)" = "([^"]+)"(.*)$/i)

; If the line was succesfully parsed.
[[If-Then-Else|if]] ([[$regml]](0) > 0) {
[[Local_Variables|var]] %cvar.name = [[$regml]](1)
[[Local_Variables|var]] %cvar.value = [[$regml]](2)
; var %hllog.props = $regml(3)

[[aline]] 3 %hllog.window Cvar " [[DollarPlus|$+]] %cvar.name [[DollarPlus|$+]] " has been changed, new value: " [[DollarPlus|$+]] %cvar.value [[DollarPlus|$+]] "
}
}

; Rcon (events 004a and 004b).
[[If-Then-Else|elseif]] ((Bad Rcon:* iswm %hllog.cmd) || (Rcon:* iswm %hllog.cmd)) {
[[noop]] [[$regex]](%hllog.cmd, /^(Bad )?Rcon: "[^"]+ ([^"]+) "([^"]+)" (.*)" [^"\x28]+ "([^"]+:[^"]+)"(.*)$/i)

; Parse the event's details.
[[Local_Variables|var]] %hllog.badrcon = [[$iif]]([[$regml]](1) == [[$null]], $false, [[$true]])
; var %hllog.challenge = $regml(2)
; var %hllog.rconpwd = $regml(3)
[[Local_Variables|var]] %hllog.rconcmd = [[$regml]](4)
[[Local_Variables|var]] %hllog.sender = [[$regml]](5)
; var %hllog.props = $regml(6)

[[aline]] 4 %hllog.window [[$iif]](%hllog.badrcon, Bad) RCON: %hllog.rconcmd (from: %hllog.sender [[DollarPlus|$+]] )
}

; Player got kicked (event 052b).
[[If-Then-Else|elseif]] (Kick:* iswm %hllog.cmd) {
[[noop]] [[$regex]](%hllog.cmd, /^Kick: ("[^"]+") ([^"]+) "([^"]+)"(.*)$/i)

; Parse the event's details.
[[Local_Variables|var]] %hllog.player = [[$regml]](1)
; var %hllog.noun = $regml(2)
[[Local_Variables|var]] %hllog.kicker = [[$regml]](3)
[[Local_Variables|var]] %hllog.props = [[$regml]](4)

[[aline]] 4 %hllog.window [[DollarPlus|$+]]([[$chr]](3), $hllog.teamcolor($hlplayer(%hllog.player).team), $hlplayer(%hllog.player).name, [[$chr]](15)) was kicked by %hllog.kicker with reason: [[DollarPlus|$+]](", $hllog.prop(%hllog.props, message), ")
}

; Team score report (event 065).
[[If-Then-Else|elseif]] ([[$regex]](%hllog.cmd, /^Team "([^"]+)" ([^"\x28]+) "([^"]+)" ([^"\x28]+) "([^"]+)"(.*)$/i)) {
[[Local_Variables|var]] %hllog.team = [[$regml]](1)
[[Local_Variables|var]] %hllog.score = [[$regml]](3)
[[Local_Variables|var]] %hllog.numPlayers = [[$regml]](5)
[[Local_Variables|var]] %hllog.props = [[$regml]](7)

[[aline]] 3 %hllog.window Team [[DollarPlus|$+]]([[$chr]](3), $hllog.teamcolor(%hllog.team), %hllog.team, [[$chr]](15)) scored %hllog.score with %hllog.numPlayers players %hllog.props
}

; Player score report (event 067).
[[If-Then-Else|elseif]] ([[$regex]](%hllog.cmd, /^Player ("[^"]+") ([^"\x28]+) "([^"]+)"(.*)$/i)) {
[[Local_Variables|var]] %hllog.player = [[$regml]](1)
[[Local_Variables|var]] %hllog.score = [[$regml]](3)
[[Local_Variables|var]] %hllog.props = [[$regml]](4)

[[aline]] 3 %hllog.window Player [[DollarPlus|$+]]([[$chr]](3), $hllog.teamcolor($hlplayer(%hllog.player).team), $hlplayer(%hllog.player).name, [[$chr]](15)) scored %hllog.score %hllog.props
}

; Events 057, 058, 059, 066.
[[If-Then-Else|elseif]] ([[$regex]](%hllog.cmd, /^("[^"]+") ([^"\x28]+) ("[^"]+") ([^"\x28]+) ("[^"]+")(.*)$/)) {
[[Local_Variables|var]] %hllog.firstEvent = [[$regml]](2)
; var %hllog.secondEvent = $regml(4)
[[Local_Variables|var]] %hllog.firstPlayer = [[$regml]](1)

[[If-Then-Else|if]] (%hllog.firstEvent == triggered) {
[[Local_Variables|var]] %hllog.secondPlayer = [[$regml]](5)
[[Local_Variables|var]] %hllog.noun = [[$remove]]([[$regml]](3), ")
}
[[If-Then-Else|else]] {
[[Local_Variables|var]] %hllog.secondPlayer = [[$regml]](3)
[[Local_Variables|var]] %hllog.noun = [[$remove]]([[$regml]](5), ")
}

[[Local_Variables|var]] %hllog.props = [[$regml]](6)

[[aline]] 1 %hllog.window [[DollarPlus|$+]]([[$chr]](3), $hllog.teamcolor($hlplayer(%hllog.firstPlayer).team), $hlplayer(%hllog.firstPlayer).name, [[$chr]](15)) %hllog.firstEvent [[DollarPlus|$+]]([[$chr]](3), $hllog.teamcolor($hlplayer(%hllog.secondPlayer ).team), $hlplayer(%hllog.secondPlayer ).name, [[$chr]](15)) with: [[DollarPlus|$+]](", [[$replace]](%hllog.noun, _, [[$chr]](32)), ") [[$iif]]($hllog.prop(%hllog.props, headshot), (headshot))
}

; Events 050, 053, 054, 055, 056, 060, 063a, 063b, 068, 069.
[[If-Then-Else|elseif]] ([[$regex]](%hllog.cmd, /^("[^"]+") ([^"\x28]+) "([^"]+)"(.*)$/)) {
[[Local_Variables|var]] %hllog.player = [[$regml]](1)
[[Local_Variables|var]] %hllog.event = [[$regml]](2)
[[Local_Variables|var]] %hllog.noun = [[$regml]](3)
[[Local_Variables|var]] %hllog.props = [[$regml]](4)
[[Local_Variables|var]] %hllog.team = $hlplayer(%hllog.player).team

[[If-Then-Else|if]] (%hllog.event == say) {
[[aline]] 7 %hllog.window [[DollarPlus|$+]]([[$chr]](3), $hllog.teamcolor(%hllog.team), $hlplayer(%hllog.player).name, [[$chr]](15)) [[DollarPlus|$+]](says:, [[$chr]](3), 1) %hllog.noun
}
[[If-Then-Else|elseif]] (%hllog.event == say_team) {
[[aline]] 7 %hllog.window [[DollarPlus|$+]]([[$chr]](3), $hllog.teamcolor(%hllog.team), $hlplayer(%hllog.player).name, [[$chr]](15)) [[DollarPlus|$+]](team says:, [[$chr]](3), 1) %hllog.noun
}
[[If-Then-Else|else]] {
[[aline]] 1 %hllog.window [[DollarPlus|$+]]([[$chr]](3), $hllog.teamcolor(%hllog.team), $hlplayer(%hllog.player).name, [[$chr]](15)) %hllog.event [[DollarPlus|$+]](", [[$replace]](%hllog.noun, _, [[$chr]](32)), ") %hllog.props
}
}

; Events 050b, 051, 052.
[[If-Then-Else|elseif]] ([[$regex]](%hllog.cmd, /^("[^"]+") ([^\x28]+)(.*)$/)) {
[[Local_Variables|var]] %hllog.player = [[$regml]](1)
[[Local_Variables|var]] %hllog.event = [[$regml]](2)
; var %hllog.props = $regml(3)
[[Local_Variables|var]] %hllog.team = $hlplayer(%hllog.player).team

[[aline]] 1 %hllog.window [[DollarPlus|$+]]([[$chr]](3), $hllog.teamcolor(%hllog.team), $hlplayer(%hllog.player).name, [[$chr]](15)) %hllog.event
}

; Events 061, 064.
[[If-Then-Else|elseif]] ([[$regex]](%hllog.cmd, /^Team "([^"]+)" ([^"\x28]+) "([^"]+)"(.*)$/i)) {
[[Local_Variables|var]] %hllog.team = [[$regml]](1)
[[Local_Variables|var]] %hllog.event = [[$regml]](2)
[[Local_Variables|var]] %hllog.noun = [[$regml]](3)
; var %hllog.props = $regml(4)

[[aline]] 1 %hllog.window [[DollarPlus|$+]]([[$chr]](3), $hllog.teamcolor(%hllog.team), %hllog.team, [[$chr]](15)) %hllog.event [[DollarPlus|$+]](", [[$replace]](%hllog.noun, _, [[$chr]](32)), ")
}

; Events 062, 003a, 003b, 005, 006.
[[If-Then-Else|elseif]] ([[$regex]](%hllog.cmd, /^([^"\x28]+) "([^"]+)"(.*)$/)) {
[[Local_Variables|var]] %hllog.event = [[$regml]](1)
[[Local_Variables|var]] %hllog.noun = [[$regml]](2)
[[Local_Variables|var]] %hllog.props = [[$regml]](3)

[[If-Then-Else|if]] (%hllog.event == server say) {
[[aline]] 7 %hllog.window Server [[DollarPlus|$+]](says:, [[$chr]](3), 1) %hllog.noun
}
[[If-Then-Else|else]] {
[[aline]] 1 %hllog.window %hllog.event [[DollarPlus|$+]](", [[$replace]](%hllog.noun, _, [[$chr]](32)), ") %hllog.props
}
}

; Events 001a, 001c, 002a, 002b.
[[If-Then-Else|elseif]] ([[$regex]](%hllog.cmd, /^([^"\x28]+)(.*)$/)) {
[[Local_Variables|var]] %hllog.event = [[$regml]](1)
; var %hllog.props = $regml(2)

[[aline]] 1 %hllog.window %hllog.event
}
}

== See also ==
* [[How to query a CS Server]]
* [[How to RCON an HL1 engine based server]]
* [[How to RCON a source engine based server]]
* [http://developer.valvesoftware.com/wiki/HL_Log_Standard HL Log Standard on valvesoftware]

[[Category:Tutorials]]
[[Category:Socket]]

How to query a CS Server

2011-06-11T19:19:44Z

NaNg: /* See also */ fixed grammer

If you want to e.g. get the number 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://developer.valvesoftware.com/wiki/Server_Queries .

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 (completely) to be able to use it.

; HL server query snippet by Saturn
;
; 16-04-2009: update to protocol version 48 by NaNg
; 29-01-2011: update to fix UTF8 problem in mIRC 7.* and fixed name problems if last char is space by NaNg
;
; usage:
; /hlinfo <ip> <port>
; or: /hlinfo <ip>:<port>
; /hlplay <ip> <port>
; or: /hlplay <ip>:<port>

; the alias that opens a new socket if you want to get general information about a running CS-server
[[alias]] hlinfo {
[[If-Then-Else|if]] (!$2) [[tokenize]] 58 [[$1-|$1]]

; using a dynamic socket name so we can use multiple instances at once
[[var]] %sock = [[DollarPlus|$+]](hlinfo-,[[$ticks]])
; construct the query to send to the server
[[bset]] &t 1 255 255 255 255
bset -t &t 5 TSource Engine Query
bset &t 25 0
; actually open the socket, and send the query
[[sockudp]] -k %sock $1-2 &t
; 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 sent back from the server
[[on_udpread|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 queried a Half-Life 1 server
if ([[$chr]]([[$bvar]](&reply,5)) == m) {
; Half-Life 1 info reply

%offset = 6

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

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

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

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

; the name of the game
%game = $bvar(&reply,%offset,128).text
inc %offset $calc($len($bvar(&reply,%offset,128).text) + 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($bvar(&reply,%offset,128).text) + 1)

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

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

%game = $bvar(&reply,%offset,128).text
inc %offset $calc($len($bvar(&reply,%offset,128).text) + 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 off the timer closing the socket
.timer $+ $sockname off
; as we can close it now manually
[[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)
; construct the query to send to the server
bset &t 1 255 255 255 255 85 255 255 255 255
; open the socket, and ask for a player challenge number
sockudp -k %sock $1-2 &t
; 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 {
if (!$2) tokenize 58 $1
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 on the timer closing the socket after 60seconds
.timer $+ %sock 1 60 sockclose %sock
}

; this event will receive all data from the server as response to our 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($bvar(&reply,%offset,128).text) + 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 it aswell
if (%count == 0) echo -a No players found!

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

==See also==
* [[How to parse HL log data]]
* [[How to RCON an HL1 engine based server]]
* [[How to RCON a source engine based server]]
* [http://developer.valvesoftware.com/wiki/Server_Queries Server Queries on valvesoftware]

[[Category:Tutorials]]
[[Category:Socket]]

How to RCON a HL1 engine based server

2011-06-11T19:18:37Z

NaNg: moved How to RCON a HL1 engine based server to How to RCON an HL1 engine based server: Corrected title.

#REDIRECT [[How to RCON an HL1 engine based server]]

How to RCON an HL1 engine based server

2011-06-11T19:18:37Z

NaNg: moved How to RCON a HL1 engine based server to How to RCON an HL1 engine based server: Corrected title.

; HL1 RCON control snippet by NaNg
; Date: 11-06-2011
; Tested on mIRC 7.19
;
; Remote control window for HL1 engine based games (e.g. HL, CS, TF etc.),
; based on the HL1 Rcon Protocol (no source).
;
; Usage:
; * /hlrcon <ip> <port> <pass>

; Define a prefix for sockent names.
[[alias]] -l hlrcon.prefix { [[return]] HLRcon }

; Validates arguments and challenges the game server.
[[alias]] hlrcon {
; Validate arguments (simple, no need for full validation).
[[If-Then-Else|if]] ((![[$longip]]([[$1-|$1]])) || ([[$1-|$2]] !isnum 1-65536) || (![[$1-|$3]])) {
[[echo]] -ag Invalid parameters.
[[return]]
}

; Save the server's address.
[[Local_Variables|var]] %server.addr = [[DollarPlus|$+]]([[$1-|$1]], :, [[$1-|$2]])

; Check that the user has not opened a Rcon window for the same server already.
; This makes sure that the user won't have a Rcon step over another Rcon for the same server.
[[If-Then-Else|if]] ([[$window_(remote)|$window(]]%server.addr)) {
[[echo]] -ag Rcon window for [[$1-|$1]] is already open! close it before trying.
[[return]]
}

; Open the Rcon window whilst activating it, with an editbox, hide the @ prefix and maximize it.
window -aek0x @ [[DollarPlus|$+]] %server.addr
[[aline]] 12 @ [[DollarPlus|$+]] %server.addr HL Rcon window. Type a command\cvar to send to the server, responses will be displayed here.
[[aline]] 12 @ [[DollarPlus|$+]] %server.addr Warning! commands like exit or quit will close the server! avoid using them!

; Set the socket name we'll use.
[[Local_Variables|var]] %sockname = [[DollarPlus|$+]]($hlrcon.prefix, %server.addr)

; Save the Rcon password.
[[set]] [[DollarPlus|$+]](%, $hlrcon.prefix, .rconpw., %sockname) [[$1-|$3]]

; Challenge the Rcon.
hlrcon.challengercon %sockname [[$1-|$1]] [[$1-|$2]]
}

[[alias]] -l hlrcon.challengercon {
; Construct the challenge request query.
[[bset]] &hlrcon.challenge 1 255 255 255 255
[[bset]] -t &hlrcon.challenge 5 challenge rcon

; Open the socket and challenge the game server.
[[sockudp]] -k [[$$]][[$1-|1-3]] &hlrcon.challenge
}

; Read data from the game server.
on *:UDPREAD:$([[DollarPlus|$+]]($hlrcon.prefix, *)): {
; Get the window name for the current game server.
[[Local_Variables|var]] %hlrcon.window = [[DollarPlus|$+]](@, [[$remove]]([[$sockname]], $hlrcon.prefix))

; If there were errors, $sockerr will tell us so.
; Write the error message to the window and clear the connection.
[[If-Then-Else|if]] ($sockerr) {
[[aline]] 04 %hlrcon.window * Error: Reading from socket: [[$sock]]([[$sockname]]).wsmsg
[[sockclose]] [[$sockname]]
[[return]]
}

; Read the data packet type.
[[Sockread|sockread]] 4 &hlrcon.pckt.type

; Since we are not using it (and we are disregarding longer packets), drop the packet type.
[[bunset]] &hlrcon.pckt.type

; Read the rest of the data.
[[Sockread|sockread]] 1400 &hlrcon.pckt.data
[[Local_Variables|var]] %hlrcon.data = [[$bvar]](&hlrcon.pckt.data, 1, [[$bvar]](&hlrcon.pckt.data, 0)).text

; If Rcon challenge is received, set it.
[[If-Then-Else|if]] (challenge rcon* iswm %hlrcon.data) {
; Tokenize the received data to rows.
[[tokenize]] [[$asc]]([[$lf]]) %hlrcon.data

; Tokenize the first row to get the challenge.
[[tokenize]] 32 [[$1-|$1]]

; Save the challenge.
[[set]] [[DollarPlus|$+]](%, $hlrcon.prefix, .challenge., [[$sockname]]) [[$1-|$3]]
}
[[If-Then-Else|else]] {
; Ignore the first byte (for non-log responses, the response contains this extra non-sense byte).
[[Local_Variables|var]] %hlrcon.data = [[$bvar]](&hlrcon.pckt.data, 2, [[$bvar]](&hlrcon.pckt.data, 0)).text
}

; Tokenize the received data to rows.
[[tokenize]] [[$asc]]([[$lf]]) %hlrcon.data

; Dispose the bvar.
[[bunset]] &hlrcon.pckt.data

; Print the given data.
[[aline]] %hlrcon.window [[$$|$*]]

; If an error occured, display a friendly message.
[[If-Then-Else|if]] (bad challenge* iswm [[$1-|$1]]) {
hlrcon.challengercon [[$sockname]] [[$sock]]([[$sockname]]).addr [[$sock]]([[$sockname]]).port
[[aline]] 04 %hlrcon.window Bad challenge, requesting a new one. Please try again.
}
[[If-Then-Else|elseif]] (bad rcon_password* iswm [[$1-|$1]]) {
[[aline]] 04 %hlrcon.window Bad Rcon password. Please try again.
}
}

; Sends user input to the server as is.
; NOTE: Commands like exit or quit will close the server!
on *:INPUT:@: {
; Get the socket name.
[[Local_Variables|var]] %hlrcon.socket = [[DollarPlus|$+]]($hlrcon.prefix, [[$remove]]($target, @))

; If the input is not for the HL Rcon window, ignore it.
[[If-Then-Else|if]] ([[$$|$]]([[DollarPlus|$+]](%, $hlrcon.prefix, .rconpw., %hlrcon.socket), 2) == [[$null]]) { [[return]] }

; Check if the socket is still alive.
[[If-Then-Else|if]] (![[$sock]](%hlrcon.socket)) {
[[aline]] 04 $target * Error: Socket is dead. Close the window and try again.
[[return]]
}

; Build the command packet and send it to the server.
[[bset]] &hlrcon.cmd 1 255 255 255 255
[[bset]] -t &hlrcon.cmd 5 rcon [[$$|$]]([[DollarPlus|$+]](%, $hlrcon.prefix, .challenge., %hlrcon.socket), 2) [[DollarPlus|$+]](", [[$$|$]]([[DollarPlus|$+]](%, $hlrcon.prefix, .rconpw., %hlrcon.socket), 2), ") [[$1-|$1-]]

[[aline]] $target -> [[$1-|$1-]]

; Send the command request.
[[sockudp]] -k %hlrcon.socket [[$sock]](%hlrcon.socket).saddr [[$sock]](%hlrcon.socket).sport &hlrcon.cmd
}

; If the user has closed the HL Rcon window, clear the socket.
on *:CLOSE:@: {
; Construct the sock name.
[[Local_Variables|var]] %hlrcon.socket = [[DollarPlus|$+]]($hlrcon.prefix, [[$remove]]($target, @))

; If the input is not for the HL Rcon window, ignore it.
[[If-Then-Else|if]] ([[$$|$]]([[DollarPlus|$+]](%, $hlrcon.prefix, .rconpw., %hlrcon.socket), 2) == [[$null]]) { [[return]] }

; If there's a socket named accordingly, close it.
[[If-Then-Else|if]] ([[$sock]](%hlrcon.socket)) {
[[sockclose]] %hlrcon.socket
}

; Clear any variables set for this socket.
[[Unset|unset]] [[$$|$]]([[DollarPlus|$+]](%, $hlrcon.prefix, .*., %hlrcon.socket))
}

== See also ==

* [[How to query a CS Server]]
* [[How to parse HL log data]]
* [[How to RCON a source engine based server]]
* [http://developer.valvesoftware.com/wiki/Server_queries Server Queries on valvesoftware]

[[Category:Tutorials]]
[[Category:Socket]]

How to RCON a source engine based server

2011-06-11T18:38:11Z

NaNg: Fixed some stuff to not override other scripts

; Source RCON control snippet by NaNg
; Date: 12-02-2011
; Tested on mIRC 7.14
;
; Remote control window for Source engine based games (e.g. HL2, OrangeBox, CS:S, CSP etc.),
; based on the Source RCON Protocol found at http://developer.valvesoftware.com/wiki/Source_RCON_Protocol
;
; Warning! I couldn't find a perfect way to open the socket nicely everytime it closes, so don't rely on it
; to be connected 24/7 (plus, the socket is closed on the server side every changelevel).
;
; Usage:
; * /sourcercon <ip> <port> <pass>

; Define a prefix for sockent names.
[[alias]] -l srcon.prefix { [[return]] SRcon }

; Set the command requests and response types.
[[alias]] -l srcon.req.execcmd { [[return]] 2 }
[[alias]] -l srcon.req.auth { [[return]] 3 }
[[alias]] -l srcon.res.cmd { [[return]] 0 }
[[alias]] -l srcon.res.auth { [[return]] 2 }

; Turn the given number to a 4-byte number.
[[alias]] -l srcon.inttobytes {
[[tokenize]] 46 [[$longip]]([[$1-|$1]])
[[return]] [[$1-|$4]] [[$1-|$3]] [[$1-|$2]] [[$1-|$1]]
}

; Validates arguments and tries to open the socket to the game server for authentication.
[[alias]] sourcercon {
; Validate arguments (simple, no need for full validation).
[[If-Then-Else|if]] ((![[$longip]]([[$1-|$1]])) || ([[$1-|$2]] !isnum 1-65536) || (![[$1-|$3]])) {
[[echo]] -ag Invalid parameters.
[[return]]
}

; Save the server's address.
[[Local_Variables|var]] %server.addr = [[DollarPlus|$+]]([[$1-|$1]],:,[[$1-|$2]])

; Check that the user has not opened a Rcon window for the same server already.
; This makes sure that the user won't have a Rcon step over another Rcon for the same server.
[[If-Then-Else|if]] ([[$window_(remote)|$window(]]%server.addr)) {
[[echo]] -ag Rcon window for [[$1-|$1]] is already open! close it before trying.
[[return]]
}

; Open the Rcon window whilst activating it, with an editbox, hide the @ prefix and maximize it.
window -aek0x @ [[DollarPlus|$+]] %server.addr
[[aline]] 12 @ [[DollarPlus|$+]] %server.addr Source RCON window. Type a command\cvar to send to the server, responses will be displayed here.
[[aline]] 12 @ [[DollarPlus|$+]] %server.addr Warning! commands like exit or quit will close the server! avoid using them!

; Set the socket name we'll use.
[[Local_Variables|var]] %sockname = [[DollarPlus|$+]]($srcon.prefix,%server.addr)

; Open the socket to the server.
[[sockopen]] %sockname [[$1-|$1]] [[$1-|$2]]

; Mark the socket with the Rcon password.
[[sockmark]] %sockname [[$1-|$3]]
}

; Catch all sockopens with the Source Rcon sockets prefix.
; Build the authentication request packet and send it to the server.
on *:SOCKOPEN:$([[DollarPlus|$+]]($srcon.prefix, *)): {
; Initialize the request ID for the connection.
[[set]] %srcon.id. [[DollarPlus|$+]] [[$sockname]] 0

; Constructed auth request to send to the server.
srcon.getrequest &srcon.auth %srcon.id. [ [[DollarPlus|$+]] [ [[$sockname]] ] ] $srcon.req.auth [[$sock]]([[$sockname]]).mark

; Send the authentication packet.
[[sockwrite]] [[$sockname]] &srcon.auth
}

; Read data from the game server.
on *:SOCKREAD:$([[DollarPlus|$+]]($srcon.prefix, *)): {
; Get the window name for the current game server.
[[Local_Variables|var]] %srcon.window = [[DollarPlus|$+]](@, [[$remove]]([[$sockname]], $srcon.prefix))

; If there were errors, $sockerr will tell us so.
; Write the error message to the window and clear the connection.
[[If-Then-Else|if]] ($sockerr) {
[[aline]] 04 %srcon.window * Error: Reading from socket: [[$sock]]([[$sockname]]).wsmsg
srcon.clear [[$sockname]]
[[return]]
}

; If a prior packet didn't finish receiving, continue reading it.
[[If-Then-Else|if]] ([[$hget]]([[$sockname]])) {
; Set the packet size.
[[Local_Variables|var]] %srcon.pckt.size = [[$hget]]([[$sockname]], size)

; Set the number of bytes left to read.
[[Local_Variables|var]] %srcon.pckt.left = [[$hget]]([[$sockname]], left)

; Set the request id.
[[Local_Variables|var]] %srcon.pckt.id = [[$hget]]([[$sockname]], id)

; Set the command response type.
[[Local_Variables|var]] %srcon.pckt.cmd = [[$hget]]([[$sockname]], cmd)

; Set the cut string1.
[[noop]] [[$hget]]([[$sockname]], string1, &srcon.pckt.string1)

; Read the rest of string1.
[[Sockread|sockread]] %srcon.pckt.left &srcon.pckt.rest
[[dec]] %srcon.pckt.left $sockbr

; Append the rest of string1 to the already received string1.
[[bcopy]] &srcon.pckt.string1 [[$calc]]([[$bvar]](&srcon.pckt.string1, 0) + 1) &srcon.pckt.rest 1 -1

; Clear the un-needed variables.
[[hfree]] [[$sockname]]
}
; Else, if the packet wasn't splitted.
[[If-Then-Else|else]] {
; Read the packet size.
[[Sockread|sockread]] 4 &srcon.pckt.size
[[Local_Variables|var]] %srcon.pckt.size = [[$bvar]](&srcon.pckt.size, 1).long

; Initialize the number of bytes left to read.
[[Local_Variables|var]] %srcon.pckt.left = %srcon.pckt.size

; Read the packet id.
[[Sockread|sockread]] 4 &srcon.pckt.id
[[Local_Variables|var]] %srcon.pckt.id = [[$bvar]](&srcon.pckt.id, 1).long
[[dec]] %srcon.pckt.left $sockbr

; If the request id is an error, stop processing, display an error and clear the connection.
[[If-Then-Else|if]] ($srcon.inttobytes(%srcon.pckt.id) == 255 255 255 255) {
[[aline]] 04 %srcon.window * Error: Failed authentication (probably wrong password).
srcon.clear [[$sockname]]
[[return]]
}

; Read the packet command response type.
[[Sockread|sockread]] 4 &srcon.pckt.cmd
[[Local_Variables|var]] %srcon.pckt.cmd = [[$bvar]](&srcon.pckt.cmd, 1).long
[[dec]] %srcon.pckt.left $sockbr

; Read string1.
[[Sockread|sockread]] %srcon.pckt.left &srcon.pckt.string1
[[dec]] %srcon.pckt.left $sockbr
}

; If the number of bytes left to read is still positive, the packet was splitted.
; This means that we'll save the variables to globals so it can be used in the next read.
[[If-Then-Else|if]] (%srcon.pckt.left > 0) {
[[hmake]] [[$sockname]]
[[hadd]] [[$sockname]] size %srcon.pckt.size
[[hadd]] [[$sockname]] left %srcon.pckt.left
[[hadd]] [[$sockname]] id %srcon.pckt.id
[[hadd]] [[$sockname]] cmd %srcon.pckt.cmd
[[hadd]] -b [[$sockname]] string1 &srcon.pckt.string1
}
; Only if we've finished reading all the packet, display it.
; NOTE: At this point, string1 also contains string2 (the one 0x00 byte), however it doesn't matter to us
; since we're only reading the text which is terminated in string1 by a 0x00 byte.
[[If-Then-Else|elseif]] (%srcon.pckt.left == 0) {
; If the response type was an auth response, display a "connected" message.
[[If-Then-Else|if]] (%srcon.pckt.cmd == $srcon.res.auth) {
[[aline]] 12 %srcon.window Now connected!
}
; If the response type was a command response, display it.
[[If-Then-Else|elseif]] (%srcon.pckt.cmd == $srcon.res.cmd) {
; Convert the binary string1 to a usable variable.
[[Local_Variables|var]] %srcon.pckt.string1 = [[$bvar]](&srcon.pckt.string1, 1, [[$bvar]](&srcon.pckt.string1, 0)).text

; Tokenize the lines to be printed and print them.
[[tokenize]] [[$asc]]([[$lf]]) %srcon.pckt.string1
[[aline]] %srcon.window [[$$|$*]]
}
}
}

; Sockets may close on their own if not kept alive.
; In case that happens when the window is still open, the socket will be reopened.
on *:SOCKCLOSE:$([[DollarPlus|$+]]($srcon.prefix, *)): {
; Get the window name for the current game server.
[[Local_Variables|var]] %srcon.window = [[DollarPlus|$+]](@, [[$remove]]([[$sockname]], $srcon.prefix))

; If the window and the current request id still exists, reopen the socket.
[[If-Then-Else|if]] (([[$window_(remote)|$window(]]%srcon.window)) && (%srcon.id. [ [[DollarPlus|$+]] [ [[$sockname]] ] ])) {
; Save the socket details before terminating it.
%srcon.name = [[$sockname]]
%srcon.ip = [[$sock]]([[$sockname]]).ip
%srcon.port = [[$sock]]([[$sockname]]).port
%srcon.pass = [[$sock]]([[$sockname]]).mark

; Terminate the socket so it could be reopened.
[[sockclose]] [[$sockname]]

; Reopen the socket to the server.
[[sockopen]] %srcon.name %srcon.ip %srcon.port

; Mark the socket with the Rcon password.
[[sockmark]] %srcon.name %srcon.pass
}
}

; Sends user input to the server as is.
; NOTE: Commands like exit or quit will close the server!
on *:INPUT:@: {
; Get the socket name.
[[Local_Variables|var]] %srcon.socket = [[DollarPlus|$+]]($srcon.prefix, [[$remove]]($target, @))

; If the input is not for the Source Rcon window, ignore it.
[[If-Then-Else|if]] ([[$$|$]]([[DollarPlus|$+]](%, srcon.id., %srcon.socket), 2) == [[$null]]) { [[return]] }

; Check if the socket is still alive.
[[If-Then-Else|if]] (![[$sock]](%srcon.socket)) {
[[aline]] 04 $target * Error: Socket is dead. Close the window and try again.
[[return]]
}

; Build the execute command request packet and send it to the server.

; Increment the current request id.
[[inc]] %srcon.id. [[DollarPlus|$+]] %srcon.socket

; Construct the request to send to the game server.
srcon.getrequest &srcon.cmd %srcon.id. [ [[DollarPlus|$+]] [ %srcon.socket ] ] $srcon.req.execcmd [[$1-|$1-]]

[[aline]] $target -> [[$1-|$1-]]

; Send the command request.
[[sockwrite]] %srcon.socket &srcon.cmd
}

; If the user has closed the rcon window, clear the socket.
on *:CLOSE:@: {
srcon.clear [[DollarPlus|$+]]($srcon.prefix, [[$remove]]($target, @))
}

; Constructs a request with the given parameters:
; $1 = Bvar to store the request
; $2 = Request ID
; $3 = Request type
; $4- = Request data (password/command)
[[alias]] -l srcon.getrequest {
; Clear the given bvar to make sure it doesn't contain any preset values.
[[bunset]] [[$1-|$1]]

; Set the given request ID in the request.
[[bset]] [[$1-|$1]] 5 $srcon.inttobytes([[$1-|$2]])

; Set the given request type.
[[bset]] [[$1-|$1]] 9 $srcon.inttobytes([[$1-|$3]])

; Set string1 the request data.
[[bset]] -t [[$1-|$1]] 13 [[$1-|$4-]]

; Terminate string1 with 0x00 and set string2 to 0x00.
[[bset]] [[$1-|$1]] [[$calc]]([[$bvar]]([[$1-|$1]],0) + 1) 00 00

; Set the packet size.
[[bset]] [[$1-|$1]] 1 $srcon.inttobytes([[$calc]]([[$bvar]]([[$1-|$1]], 0) - 4))
}

; Clears the socket and the request id.
[[alias]] -l srcon.clear {
; If there's a socket named accordingly, close it.
[[If-Then-Else|if]] ([[$sock]]([[$1-|$1]])) {
[[sockclose]] [[$1-|$1]]
}

; Clear the id var.
[[Unset|unset]] %srcon.id. [[DollarPlus|$+]] [[$1-|$1]]
}

==See also==
* [[How to RCON a HL1 engine based server]]
* [[How to query a CS Server]]
* [[How to parse HL log data]]
* [http://developer.valvesoftware.com/wiki/Source_RCON_Protocol Source RCON Protocol on valvesoftware]

[[Category:Tutorials]]
[[Category:Socket]]