Project

General

Profile

Scripting » History » Version 102

Per Amundsen, 03/19/2012 02:40 PM

1 42 Per Amundsen
h1. Notice: this is info for 1.8.8 and higher.
2 39 Per Amundsen
3 1 Per Amundsen
h1. Scripting
4
5
In the latest beta's, I am experimenting with a little more advanced scripting features and I will use this wiki to track progress and features.
6
7 8 Per Amundsen
Syntax, variables and functions will probably change a lot, so don't except previous scripts to still work in the next beta and so forth.
8 1 Per Amundsen
9 30 Per Amundsen
There are 2 types of scripting at the moment, one that have been here for a long time, and a new system.
10 16 Per Amundsen
11 38 Per Amundsen
All scripting is done in Commands -> Edit Commands where one line represent a script or a custom command and its trigger is one of 3 ways:
12
13
/something<whitespace> 
14 37 Per Amundsen
keys<whitespace>
15
OnEvent<whitespace>
16 16 Per Amundsen
17 1 Per Amundsen
Please note that variables and functions are *different* for these 2 types of scripts.
18 37 Per Amundsen
19
You can comment out a command by putting a # in front of it.
20 17 Per Amundsen
21 1 Per Amundsen
h1. Normal custom commands:
22 26 Per Amundsen
23 25 Per Amundsen
<pre>Syntax = /something<whitespace>/somethingelse</pre>
24 16 Per Amundsen
25 23 Per Amundsen
Here are some variables which can be used in Custom Commands, its like creating aliases of already available commands, e.g <pre>/hi /me says hi to $chan</pre> will show <pre>* kr0n says hi to #adiirc</pre> when typing <pre>/hi</pre>
26 16 Per Amundsen
27 32 Per Amundsen
Current variables are $1 to $9, $params, $chan and $me. $1 to $9 represents what you type after /yourcommand e.g <pre>/sup /say whats up $1</pre> when typing <pre>/sup kr0n</pre> it will show like this <pre>User: whats up kr0n</pre>
28 16 Per Amundsen
29 29 Per Amundsen
$params represents everything written after /yourcommand, $chan replaces itself with current channel and $me replaces itself with your current usernick. 
30 16 Per Amundsen
31 19 Per Amundsen
You can make combo commands by using | as a seperator, e.g <pre>/hi /me says hi to $chan|/me says hi again to $chan</pre>
32 16 Per Amundsen
33 1 Per Amundsen
$file[path] returns data from a file, $frand[path] fetchs a random line from a file and $floop[path] gets one line increasingly (line1, then line2, then line3 etc).
34 23 Per Amundsen
35 27 Per Amundsen
h1. Custom Commands by hotkeys
36 1 Per Amundsen
37 25 Per Amundsen
<pre>Syntax = key&key<whitespace>/something</pre>
38 1 Per Amundsen
39 27 Per Amundsen
In addition to making a custom command trigger by typing a /slash command, you make it trigger with a hotkey instead (note, these commmands will not be useable from the new scripting engine)
40
41 23 Per Amundsen
Useable modifies are ctrl, alt and shift and any character or number or F key.
42
43
An example
44
45 24 Per Amundsen
<pre>ctrl&o /msg $chan ohai i just pressed ctrl and o</pre>
46 23 Per Amundsen
47 1 Per Amundsen
Everytime you press ctrl and 'o' now, this command will be fired off.
48 24 Per Amundsen
49
<pre>ctrl&alt&o /msg $chan ohai i just pressed ctrl and alt and o</pre>
50
51 1 Per Amundsen
Everytime you press ctrl and alt and 'o' now, this command will be fired off.
52 16 Per Amundsen
53 27 Per Amundsen
h1. Unified Scripting
54 1 Per Amundsen
55 27 Per Amundsen
<pre>Syntax = OnEvent<whitespace>code</pre>
56
57 1 Per Amundsen
The new scripting tries to combine normal client commands, your custom commands, functions and events into one scripting language.
58
59 25 Per Amundsen
In Commands -> Edit Commands you can enter a scripting line with the following syntax:
60 1 Per Amundsen
61
Followed by either an expression like this (works recursivly)
62
63
<pre>
64
if (SOMETING == SOMETHINGELSE) { EXECUTE HERE }
65
if (SOMETING != SOMETHINGELSE) { EXECUTE HERE }
66 13 Per Amundsen
if (SOMETING ismatch SOMETHINGELSE) { EXECUTE HERE }</pre>
67 1 Per Amundsen
or by an executed command or function
68
69 2 Per Amundsen
You can now combine expressions with && (AND) and || (OR) like this
70 1 Per Amundsen
<pre>
71 2 Per Amundsen
if (SOMETHING == SOMETHING && SOMETHINGELSE != SOMETHINGELSE) { EXECUTE HERE }
72 13 Per Amundsen
if (SOMETHING == SOMETHING || SOMETHINGELSE != SOMETHINGELSE) { EXECUTE HERE }</pre>
73 1 Per Amundsen
The logic behind these expressions is not fully tested, id love any feedback on this.
74 33 Per Amundsen
75
It is also possible to use else if like this
76
<pre>if (SOMETHING == SOMETHING) { EXECUTE HERE } else if (SOMETHINGELSE == SOMETHINGELSE) { EXECUTE HERE }</pre>
77
In the future just "else" will be possible to.
78 12 Per Amundsen
79
(note: ismatch will check if SOMETHING exist inside SOMETHINGELSE e.g if something is "hello" and something else is "hello world" it would return True because "hello" exist)
80 2 Per Amundsen
81 1 Per Amundsen
Executed commands are /slash commands already in the client e.g /msg #channel hello world.
82
Executed functions are predefined functions in the client, only two exists for now.
83
84
An execution block can consist of both commands and functions if seperated by | (pipe) character like this <pre>/msg #channel hello world|.function bla bla|/msg #channel2 hello world</pre>
85
86
Furthermore there is a lot of predefined variables for use with these functions, for now they are:
87
88
$event / current event, e.g PRIVMSG 001 MODE and so forth
89
$channel / the channel the event occurred on, if any
90
$msg / the message to the channel/user or the message in a raw irc line e.g whois [kr0n] is a registered nick
91
$nick / the nick the event was sent from, can be a irc.server.com, a nick or null
92
$me / my current nick
93
$network / the network the event occured on e.g Quakenet
94
$ident / the from user ident if any
95
$host / the from user hostname if any
96
$myident / my ident
97
$myhost / my host
98 14 Per Amundsen
$server / host from the server e.g irc.server.com
99 1 Per Amundsen
100
Currently predefined functions are:
101
<pre>
102 36 Per Amundsen
.insert <nick (use null for nonick)> 
103
<where (a channel or $channel, a nick or $nick, or status)> 
104
<MsgType (MsgServer/MsgUser/MsgEmote/MsgCTCP/MsgNotice/MsgClient/MsgLog)> 
105
<$msg or message></pre>
106 1 Per Amundsen
107
<pre>
108 13 Per Amundsen
.eat <what (text or all)></pre>
109 1 Per Amundsen
.insert is used for inserting a specific message type into a chat window, its intended for use in cases where you want to override how adiirc shows a given event, but can also be used for adding additional messages.
110
111
.eat is used to tell adiirc to either "eat" the text output from an event or "eat" everything and don't act on this event at all.
112
113
Putting it all togheter, here are a few examples:
114
115
<pre>
116 13 Per Amundsen
OnEvent if ($event == NOTICE) { if ($msg ismatch hi there) { .insert $nick status MsgNotice $msg|.eat text } }</pre>
117 1 Per Amundsen
118
insert the notice into the server window and tells adiirc to "eat" its own text output from this notice
119
120
<pre>
121 41 Per Amundsen
OnEvent if ($event == PRIVMSG && $msg == herp) { /msg $channel derp }</pre>
122 7 Per Amundsen
123 1 Per Amundsen
if the event is a PRIVMSG AND the $msg equals "herp", then show "derp" in the channel
124
125 6 Per Amundsen
<pre>
126 13 Per Amundsen
OnEvent if ($event == PRIVMSG) { if ($nick == Q || $nick == $me) { /msg $channel Q or $me is speaking! } }</pre>
127 1 Per Amundsen
128
if the event is a PRIVMSG and the $nick equals "Q" OR $me then show "Q or $me is speaking" in the channel
129 9 Per Amundsen
130 34 Per Amundsen
<pre>OnEvent if ($event == OnOp && $nick == $me) { /msg $channel Thx for op! }</pre>
131
132 35 Per Amundsen
if the event is OnOp and the target nick is me, then show "Thx for op!" in the channel
133
134 3 Per Amundsen
A list of custom events that is also usable as $event ==
135 4 Per Amundsen
<pre>
136 3 Per Amundsen
OnOwner
137
OnDeOwner
138
OnSpecialOp
139
OnSpecialDeOp
140
OnOp
141
OnDeOp
142
OnHop
143
OnDeHop
144 1 Per Amundsen
OnVoice
145 42 Per Amundsen
OnDeVoice
146 46 Per Amundsen
</pre>
147 1 Per Amundsen
148 46 Per Amundsen
h1. Scripting changes in latest beta
149
This does not apply to the latest stable release!
150 1 Per Amundsen
151 60 Per Amundsen
*OnEvent* is now executed *AFTER* the event, use *OnBeforeEvent* for events where you want to .eat or in other ways manipulate the event.
152
153 50 Per Amundsen
New command /nmsg added for cross network output, and a new event OnSongChanged. 
154 1 Per Amundsen
155 50 Per Amundsen
Combine them and you can automatically announce song changes in a channel or to a user with:
156
157 42 Per Amundsen
<pre>
158 45 Per Amundsen
OnEvent if ($event == OnSongChanged) { /nmsg <network> <channel/Nick> $msg }
159 42 Per Amundsen
</pre>
160 62 Per Amundsen
161 42 Per Amundsen
Announce to several channels with:
162 62 Per Amundsen
163 42 Per Amundsen
<pre>
164 45 Per Amundsen
OnEvent if ($event == OnSongChanged) { /nmsg <network> <channel/Nick> $msg|/nmsg <network> <channel/Nick> $msg }
165 42 Per Amundsen
</pre>
166 1 Per Amundsen
167 61 Per Amundsen
Network is the network name where the channel is, e.g NordicIRC, freenode, Quakenet, look at the name of the server window you are connected on to find it.
168 46 Per Amundsen
169
Also added is better escaping, variables and a "null" variable, e.g
170
171
<pre>
172 47 Per Amundsen
OnEvent if ($event == PRIVMSG) { if (%test == null) { %test = SOMETHING|/msg $channel test is %test } }
173 46 Per Amundsen
</pre>
174
175 95 Per Amundsen
New variable $now returns unixtime/ctime from current time.
176 97 Per Amundsen
New variable $active returns the current window Status/#channel/Nick.
177 95 Per Amundsen
178 89 Per Amundsen
These variables are saved into vars.ini unless removed (%var == null) and reloaded when adiirc starts.
179
You can change/use them in any script.
180 48 Per Amundsen
181 49 Per Amundsen
Note also that all user set variables starts with % and client variables starts with $.
182
183 91 Per Amundsen
Some commands for manipulate variables:
184
185
<pre>
186 93 Per Amundsen
/set {-u seconds/-d] [%var] [value] / create or update a variable with value -u seconds, will delete the variable after X seconds, -d will decrease its value by 1 every second, then remove it
187 92 Per Amundsen
188 91 Per Amundsen
/unset [var] / deletes a variable
189 92 Per Amundsen
190 93 Per Amundsen
/inc {-u seconds/-d] [%var] [value] / increases a variable with value (only if value and var is ints) -u seconds, will delete the variable after X seconds, -d will decrease its value by 1 every second, then remove it
191 92 Per Amundsen
192 93 Per Amundsen
/dec {-u seconds/-d] [%var] [value] / decreases a variable with value (only if value and var is ints) -u seconds, will delete the variable after X seconds, -d will decrease its value by 1 every second, then remove it
193 92 Per Amundsen
194
/vars shows a list of all variables and their values
195 91 Per Amundsen
</pre>
196
197 1 Per Amundsen
Variables is still work in progress, id love some feedback/ideas of what it can be used for.
198 50 Per Amundsen
199 99 Per Amundsen
halt can now be used instead of .eat all, it will halt immediately, ignoring rest of the script.
200
return will halt immediately, ignoring rest of the script, but not eat anything.
201
202 51 Per Amundsen
<pre>
203 73 Per Amundsen
OnLoad / Called when the script is loaded
204
OnUnload / Called when the script is unloaded
205
OnReload / Called when the script is reloaded
206
OnConnecting / Called when a server is connecting
207
OnLookingUp / Called when a server is looking up the hostname
208
OnConnected / Called when a server is connected
209
OnDisconnect / Called when a server gets disconnected
210
OnCommand / Called whenever a user types a /slash command in the client ($msg will hold the full command, $0 will be the first word, $1 the second and so on)
211 99 Per Amundsen
OnCTCPRequest / Called when a user recives a CTCP request
212
OnCTCPReply / Called when a user recives a CTCP reply
213 100 Per Amundsen
ACTION / Called when a user recives a ACTION (/me) message
214 51 Per Amundsen
</pre>
215
216
A few examples using these.
217 1 Per Amundsen
218
<pre>
219
OnEvent if ($event == OnLoad) { %myvariable = This was set at startup }
220
OnEvent if ($event == OnUnLoad) { .msgbox varible set at startup was %myvariable }
221
OnEvent if ($event == OnReLoad) { .msgbox Script reloaded }
222 99 Per Amundsen
OnEvent if ($event == OnConnecting) { /echo i r conecting }
223
OnEvent if ($event == OnLookingUp ) { /echo i r looking up hostname }
224
OnEvent if ($event == OnConnected ) { /echo i r connected }
225
OnEvent if ($event == OnDisconnect) { /echo i r disconnected }
226
OnEvent if ($event == OnCommand) { if ($0 == /me) { /echo i typed /me } }
227
OnEvent if ($event == OnCommand) { /echo i typed $0, full command was $0- }
228 100 Per Amundsen
OnEvent if ($event == OnCTCPRequest) { /echo CTCP Request $0- from $nick }
229
OnEvent if ($event == OnCTCPReply) { /echo CTCP Reply $0- from $nick }
230
OnEvent if ($event == ACTION) { /echo ACTION $0- from $nick }
231 52 Per Amundsen
</pre>
232 53 Per Amundsen
233 99 Per Amundsen
New Operators, all operators can now use ! to reverse the logic e.g !ison. If no operators are added it will test if remaining text is not null if (%test), if ($channel) etc.
234 65 Per Amundsen
235
<pre>
236 101 Per Amundsen
> / Will try and cast left and right variable to int and try "int1 greater than int2"
237
< / Will try and cast left and right variable to int and try "int1 lower than int2"
238
>= / Will try and cast left and right variable to int and try "int1 greater than or equal to int2"
239
<= / Will try and cast left and right variable to int and try "int1 lower than or equal to int2"
240
isbetween / Will try and cast left variable to int and right variable have to be int-int, e.g "40 isbetween 30-50"
241
ison / check if ($nick ison $channel) nick is the channel
242
isop / check if ($nick isop $channel) is operator on the channel
243
ishop / check if ($nick ishop $channel) is half operator on the channel
244
issop / check if ($nick issop $channel) is special operator on the channel
245
isowner / check if ($nick isowner $channel) is channel owner
246
hasvoice / check if ($nick hasvoice $channel) have voice on the channel
247
inchan / check if i am in chan (#channel inchan) (#channel !inchan)
248
isnum / check something is a number (5 isnum) (5 !isnum)
249 65 Per Amundsen
</pre>
250
251 53 Per Amundsen
A complete rewrite of the parser logic is done, introducing the "else" keyword, and you can now use any nested length of "if" "else if" and "else" e.g:
252
253
<pre>
254 54 Per Amundsen
OnEvent if ($event == PRIVMSG) 
255
{ 
256 55 Per Amundsen
	if (%test == null) { 
257
		/msg Hello world; 
258
		if (%test == null) 
259
		{ 
260 56 Per Amundsen
			/msg Hello world; 
261
		} 
262 1 Per Amundsen
	} 
263
	else if (%test == null) 
264
	{ 
265 59 Per Amundsen
		/msg Hello world
266 1 Per Amundsen
	} 
267 55 Per Amundsen
	else (%test == null) 
268 54 Per Amundsen
	{ 
269 59 Per Amundsen
		/msg Hello world 
270 55 Per Amundsen
	} 
271
	if (%test == null) 
272
	{ 
273
		/msg Hello world 
274 54 Per Amundsen
	} 
275
}
276 53 Per Amundsen
</pre>
277
278 1 Per Amundsen
also ; is now useable like | for line ending.
279 54 Per Amundsen
280 57 Per Amundsen
Simple kickcounter script:
281
<pre>
282 64 Per Amundsen
OnBeforeEvent if ($event == OnCommand) 
283 57 Per Amundsen
{ 
284
	if ($0 == /kick) 
285
	{ 
286
		if (%kickcount == null) 
287
		{ 
288 1 Per Amundsen
			%kickcount = 0; 
289 88 Per Amundsen
		}
290
291
		%kickcount++;
292 57 Per Amundsen
		 
293 1 Per Amundsen
		if ($2 == null) 
294 58 Per Amundsen
		{ 
295
			/kick $channel $1 Kick number %kickcount;
296 99 Per Amundsen
			halt; 
297 57 Per Amundsen
		} 
298
	} 
299
}
300
</pre>
301
302 68 Per Amundsen
Added following variables for alias commands also:
303
304
<pre>
305
$network / the network the event occured on e.g Quakenet
306
$myident / my ident
307
$myhost / my host
308
$server / host from the server e.g irc.server.com
309
</pre>
310 69 Per Amundsen
311
You can now use "-" on $<number> variables to get all words from $<number> and after.
312
313
<pre>
314 85 Per Amundsen
OnEvent if ($event == OnCommand) { /echo $2- }
315 69 Per Amundsen
</pre>
316
317
When you type "/msg $me this is a test" you will get only "this is a test"
318
319
<pre>
320 85 Per Amundsen
OnEvent if ($event == OnCommand) { /echo $3- }
321 69 Per Amundsen
</pre>
322
323
When you type "/msg $me this is a test" you will get only "is a test"
324
325
<pre>
326 85 Per Amundsen
OnEvent if ($event == OnCommand) { /echo $0- }
327 1 Per Amundsen
</pre>
328
329
When you type "/msg $me this is a test" you will get "/msg $me this is a test"
330
331 100 Per Amundsen
$0- is now equal to $params and $msg, and $0 will return the first part e.g the command "/msg"
332 1 Per Amundsen
333
Also you can use $raw<number> like $raw0 $raw1 $raw0- to get parts of the raw irc message. This will likely be the default way when better parsing functions are added.
334 73 Per Amundsen
335 76 Per Amundsen
Several functions are added, they are all recursive and you can use any %variable or $variable as parameters:
336 79 Per Amundsen
They are also usable inside if () statements.
337 73 Per Amundsen
<pre>
338 74 Per Amundsen
$replace(text, text2, text3) / replace all occurrences of text2 in text with text3
339
$upper(text) / return text uppercase
340
$lower(text) return text lowercase
341
$mid(text, startpos, endpos) / return part of text from startpos to endpos
342
$substr(text, startpos, endpos) / return part of text from startpos to endpos
343
$left(text, pos) / return pos characters starting from left of the text
344
$right(text, pos) / return pos characters starting from right of the text
345
$remove(text, text2) / replace all occurrences of text2 from text
346
$len(text) / return length of text
347
$count(text, text2) / counts all occurrences of text2 in text
348
$pos(text, text2) / returns first occurrences position of text2 in text
349
$lastpos(text, text2) / returns last occurrences position of text2 in text
350
$strip(text) / removes all color and font tags
351
$repeat(text, times) / repeats text X times
352
$insert(text, text2, pos) / inserts text2 into pos of text
353 77 Per Amundsen
$calc(formula) / calculate any variation of +-*/
354
$formatdate(date, text) / formats a unix timestamp into date using date variables %d %m %y etc
355 96 Per Amundsen
$fdate(date, text) / formats a unix timestamp into date using date variables %d %m %y etc
356 78 Per Amundsen
$char(num) / returns ascii character from the number num
357 87 Per Amundsen
$chr(num) / returns ascii character from the number num
358 81 Per Amundsen
$host(nick) / returns the hostmask of nick
359
$ident(nick) / returns the ident of nick
360 73 Per Amundsen
</pre>
361 75 Per Amundsen
362
<pre>
363
OnEvent if ($event == JOIN) { /msg $channel $replace(this is a test, test, replaced test) }
364
</pre>
365
366
Shows "this is a replaced test"
367
368
<pre>
369
OnEvent if ($event == JOIN) { /msg $channel $replace($replace(this is a test, test, replaced test), replaced test, replaced again test) }
370
</pre>
371
372 82 Per Amundsen
Shows "this is a replaced again test"
373 83 Per Amundsen
374 1 Per Amundsen
Here is an fullblown kickban example script using the script editor
375
<pre>
376 82 Per Amundsen
OnBeforeEvent if ($event == OnCommand) {
377
	if ($0 == /kb) {
378
		if ($1 == null) {
379
			/echo /kb - Nick missing;
380
		}
381
		else 
382
		{
383 99 Per Amundsen
			# equal to if ($channel != null)
384
			if ($channel)
385 82 Per Amundsen
			{
386
				%msg = $2-;
387
				%chan = $channel;
388
			}
389
			else
390
			{	
391
				%msg = $3-;
392
				%chan = $2;
393
			}
394 86 Per Amundsen
			
395 82 Per Amundsen
			# Set this for default ban reason, or remove for no default reason
396
			if (%msg == null) {
397
				%msg = GTFO;
398
			}
399
400
			if ($me isop %chan) {
401 1 Per Amundsen
				/raw MODE %chan +b *!$ident($1)@$host($1);
402 82 Per Amundsen
				/raw KICK %chan $1 %msg;
403 84 Per Amundsen
			} else {
404
				/echo You are not oper on %chan;
405 82 Per Amundsen
			}
406 1 Per Amundsen
407
			%msg = null;
408
			%chan = null;
409
		}
410
411 99 Per Amundsen
		halt;
412 1 Per Amundsen
	}
413
}
414 86 Per Amundsen
</pre>
415
416
Simple calculator script:
417
<pre>
418
OnBeforeEvent if ($event == OnCommand) {
419 1 Per Amundsen
	if ($0 == /calc) {
420
		if ($1 == null) {
421
			/echo /calc - Parameters missing;
422 102 Per Amundsen
			halt;
423 1 Per Amundsen
		}
424 99 Per Amundsen
		
425
		# typing /calc -p <expression> sends output to channel
426
		if ($1 == -p) {
427
			/msg $channel Calculating : $2-;
428
			/msg $channel Result is : $calc($2-);
429
		} else {
430
			/echo Calculating : $1-;
431
			/echo Result is : $calc($1-);
432 1 Per Amundsen
		}
433 87 Per Amundsen
434 99 Per Amundsen
		halt;
435 87 Per Amundsen
	}
436
}
437
</pre>
438
439
Colored version
440
<pre>
441
OnBeforeEvent if ($event == OnCommand) {
442
	if ($0 == /calc) {
443
		if ($1 == null) {
444
			/echo /calc - Parameters missing;
445 102 Per Amundsen
			halt;
446 87 Per Amundsen
		}
447 99 Per Amundsen
		
448
		# typing /calc -p <expression> sends output to channel
449
		if ($1 == -p) {
450
			/msg $channel $chr(3)4Calculating : $2-;
451
			/msg $channel $chr(3)4Result is : $calc($2-);
452
		} else {
453
			/echo $chr(3)4Calculating : 4$1-;
454
			/echo $chr(3)4Result is : $calc($1-);
455 82 Per Amundsen
		}
456
457 99 Per Amundsen
		halt;
458 82 Per Amundsen
	}
459
}
460
</pre>
461 98 Per Amundsen
462
CTCP flood detection example
463
464
<pre>
465 99 Per Amundsen
OnEvent if ($event == OnCTCPRequest) {
466 98 Per Amundsen
		if (%count == null) {
467
			/set -u 10 %count 1;
468
		} else {
469
			/inc -u 10 %count 1;
470
		}
471
			
472
		if (%count > 4) {
473
			/ignore -u 30 -t $nick!$ident@$host;
474
		}
475
}
476
</pre>