Project

General

Profile

Scripting » History » Version 98

Per Amundsen, 03/19/2012 10:36 AM

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 51 Per Amundsen
<pre>
200 73 Per Amundsen
OnLoad / Called when the script is loaded
201
OnUnload / Called when the script is unloaded
202
OnReload / Called when the script is reloaded
203
OnConnecting / Called when a server is connecting
204
OnLookingUp / Called when a server is looking up the hostname
205
OnConnected / Called when a server is connected
206
OnDisconnect / Called when a server gets disconnected
207
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)
208 51 Per Amundsen
</pre>
209
210
A few examples using these.
211
212 52 Per Amundsen
<pre>
213 51 Per Amundsen
OnEvent if ($event == OnLoad) { %myvariable = This was set at startup }
214
OnEvent if ($event == OnUnLoad) { .msgbox varible set at startup was %myvariable }
215 67 Per Amundsen
OnEvent if ($event == OnReLoad) { .msgbox Script reloaded }
216 51 Per Amundsen
OnEvent if ($event == OnConnecting) { .msgbox i r conecting }
217
OnEvent if ($event == OnLookingUp ) { .msgbox i r looking up hostname }
218
OnEvent if ($event == OnConnected ) { .msgbox i r connected }
219
OnEvent if ($event == OnDisconnect) { .msgbox i r disconnected }
220
OnEvent if ($event == OnCommand) { if ($0 == /me) { .msgbox i typed /me } }
221
OnEvent if ($event == OnCommand) { .msgbox i typed $0, full command was $msg }
222 52 Per Amundsen
</pre>
223 53 Per Amundsen
224 65 Per Amundsen
New Operators
225
226
<pre>
227
> - Will try and cast left and right variable to int and try "int1 greater than int2"
228
< - Will try and cast left and right variable to int and try "int1 lower than int2"
229
>= - Will try and cast left and right variable to int and try "int1 greater than or equal to int2"
230
<= - Will try and cast left and right variable to int and try "int1 lower than or equal to int2"
231 66 Per Amundsen
isbetween - Will try and cast left variable to int and right variable have to be int-int, e.g "40 isbetween 30-50"
232 65 Per Amundsen
ison - check if "$nick ison $channel" nick is the channel
233
isop - check if "$nick isop $channel" is operator on the channel
234
ishop - check if "$nick ishop $channel" is half operator on the channel
235
issop - check if "$nick issop $channel" is special operator on the channel
236
isowner - check if "$nick isowner $channel" is channel owner
237
hasvoice - check if "$nick hasvoice $channel" have voice on the channel
238
</pre>
239
240 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:
241
242
<pre>
243 54 Per Amundsen
OnEvent if ($event == PRIVMSG) 
244
{ 
245 55 Per Amundsen
	if (%test == null) { 
246
		/msg Hello world; 
247
		if (%test == null) 
248
		{ 
249 56 Per Amundsen
			/msg Hello world; 
250
		} 
251 1 Per Amundsen
	} 
252
	else if (%test == null) 
253
	{ 
254 59 Per Amundsen
		/msg Hello world
255 1 Per Amundsen
	} 
256 55 Per Amundsen
	else (%test == null) 
257 54 Per Amundsen
	{ 
258 59 Per Amundsen
		/msg Hello world 
259 55 Per Amundsen
	} 
260
	if (%test == null) 
261
	{ 
262
		/msg Hello world 
263 54 Per Amundsen
	} 
264
}
265 53 Per Amundsen
</pre>
266
267 1 Per Amundsen
also ; is now useable like | for line ending.
268 54 Per Amundsen
269 57 Per Amundsen
Simple kickcounter script:
270
<pre>
271 64 Per Amundsen
OnBeforeEvent if ($event == OnCommand) 
272 57 Per Amundsen
{ 
273
	if ($0 == /kick) 
274
	{ 
275
		if (%kickcount == null) 
276
		{ 
277
			%kickcount = 0; 
278 88 Per Amundsen
		}
279
280
		%kickcount++;
281 57 Per Amundsen
		 
282 1 Per Amundsen
		if ($2 == null) 
283 58 Per Amundsen
		{ 
284
			/kick $channel $1 Kick number %kickcount;
285
			.eat all; 
286 57 Per Amundsen
		} 
287
	} 
288
}
289
</pre>
290
291 68 Per Amundsen
Added following variables for alias commands also:
292
293
<pre>
294
$network / the network the event occured on e.g Quakenet
295
$myident / my ident
296
$myhost / my host
297
$server / host from the server e.g irc.server.com
298
</pre>
299 69 Per Amundsen
300
You can now use "-" on $<number> variables to get all words from $<number> and after.
301
302
<pre>
303 85 Per Amundsen
OnEvent if ($event == OnCommand) { /echo $2- }
304 69 Per Amundsen
</pre>
305
306
When you type "/msg $me this is a test" you will get only "this is a test"
307
308
<pre>
309 85 Per Amundsen
OnEvent if ($event == OnCommand) { /echo $3- }
310 69 Per Amundsen
</pre>
311
312
When you type "/msg $me this is a test" you will get only "is a test"
313
314
<pre>
315 85 Per Amundsen
OnEvent if ($event == OnCommand) { /echo $0- }
316 1 Per Amundsen
</pre>
317
318
When you type "/msg $me this is a test" you will get "/msg $me this is a test"
319
320
$0- is now equal to $params, and $0 will return the first part e.g the command "/msg"
321
322
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.
323 73 Per Amundsen
324 76 Per Amundsen
Several functions are added, they are all recursive and you can use any %variable or $variable as parameters:
325 79 Per Amundsen
They are also usable inside if () statements.
326 73 Per Amundsen
<pre>
327 74 Per Amundsen
$replace(text, text2, text3) / replace all occurrences of text2 in text with text3
328
$upper(text) / return text uppercase
329
$lower(text) return text lowercase
330
$mid(text, startpos, endpos) / return part of text from startpos to endpos
331
$substr(text, startpos, endpos) / return part of text from startpos to endpos
332
$left(text, pos) / return pos characters starting from left of the text
333
$right(text, pos) / return pos characters starting from right of the text
334
$remove(text, text2) / replace all occurrences of text2 from text
335
$len(text) / return length of text
336
$count(text, text2) / counts all occurrences of text2 in text
337
$pos(text, text2) / returns first occurrences position of text2 in text
338
$lastpos(text, text2) / returns last occurrences position of text2 in text
339
$strip(text) / removes all color and font tags
340
$repeat(text, times) / repeats text X times
341
$insert(text, text2, pos) / inserts text2 into pos of text
342 77 Per Amundsen
$calc(formula) / calculate any variation of +-*/
343
$formatdate(date, text) / formats a unix timestamp into date using date variables %d %m %y etc
344 96 Per Amundsen
$fdate(date, text) / formats a unix timestamp into date using date variables %d %m %y etc
345 78 Per Amundsen
$char(num) / returns ascii character from the number num
346 87 Per Amundsen
$chr(num) / returns ascii character from the number num
347 81 Per Amundsen
$host(nick) / returns the hostmask of nick
348
$ident(nick) / returns the ident of nick
349 73 Per Amundsen
</pre>
350 75 Per Amundsen
351
<pre>
352
OnEvent if ($event == JOIN) { /msg $channel $replace(this is a test, test, replaced test) }
353
</pre>
354
355
Shows "this is a replaced test"
356
357
<pre>
358
OnEvent if ($event == JOIN) { /msg $channel $replace($replace(this is a test, test, replaced test), replaced test, replaced again test) }
359
</pre>
360
361
Shows "this is a replaced again test"
362 82 Per Amundsen
363 83 Per Amundsen
Here is an fullblown kickban example script using the script editor
364 82 Per Amundsen
<pre>
365
OnBeforeEvent if ($event == OnCommand) {
366
	if ($0 == /kb) {
367
		if ($1 == null) {
368
			/echo /kb - Nick missing;
369
		}
370
		else 
371
		{
372
			if ($channel != null)
373
			{
374
				%msg = $2-;
375
				%chan = $channel;
376
			}
377
			else
378
			{	
379
				%msg = $3-;
380
				%chan = $2;
381
			}
382 86 Per Amundsen
			
383
			# Set this for default ban reason, or remove for no default reason
384 82 Per Amundsen
			if (%msg == null) {
385
				%msg = GTFO;
386
			}
387
388
			if ($me isop %chan) {
389
				/raw MODE %chan +b *!$ident($1)@$host($1);
390
				/raw KICK %chan $1 %msg;
391 84 Per Amundsen
			} else {
392
				/echo You are not oper on %chan;
393 82 Per Amundsen
			}
394
395
			%msg = null;
396 1 Per Amundsen
			%chan = null;
397 86 Per Amundsen
		}
398
399
		.eat all;
400
	}
401
}
402
</pre>
403
404
Simple calculator script:
405
<pre>
406
OnBeforeEvent if ($event == OnCommand) {
407
	if ($0 == /calc) {
408
		if ($1 == null) {
409
			/echo /calc - Parameters missing;
410
		}
411
		else 
412
		{
413
				# typing /calc -p <expression> sends output to channel
414
				if ($1 == -p) {
415
					/msg $channel Calculating : $2-;
416
					/msg $channel Result is : $calc($2-);
417
				} else {
418
					/echo Calculating : $1-;
419
					/echo Result is : $calc($1-);
420 87 Per Amundsen
				}
421
		}
422
423
		.eat all;
424
	}
425
}
426
</pre>
427
428
Colored version
429
<pre>
430
OnBeforeEvent if ($event == OnCommand) {
431
	if ($0 == /calc) {
432
		if ($1 == null) {
433
			/echo /calc - Parameters missing;
434
		}
435
		else 
436
		{
437
				# typing /calc -p <expression> sends output to channel
438
				if ($1 == -p) {
439
					/msg $channel $chr(3)4Calculating : $2-;
440
					/msg $channel $chr(3)4Result is : $calc($2-);
441
				} else {
442
					/echo $chr(3)4Calculating : 4$1-;
443
					/echo $chr(3)4Result is : $calc($1-);
444 86 Per Amundsen
				}
445 82 Per Amundsen
		}
446
447
		.eat all;
448
	}
449
}
450
</pre>
451 98 Per Amundsen
452
CTCP flood detection example
453
454
<pre>
455
OnEvent if ($event == CTCPRequest) {
456
		if (%count == null) {
457
			/set -u 10 %count 1;
458
		} else {
459
			/inc -u 10 %count 1;
460
		}
461
			
462
		if (%count > 4) {
463
			/ignore -u 30 -t $nick!$ident@$host;
464
		}
465
}
466
</pre>