Project

General

Profile

Scripting » History » Version 61

Per Amundsen, 11/01/2011 03:47 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
Announce to several channels with:
161
<pre>
162 45 Per Amundsen
OnEvent if ($event == OnSongChanged) { /nmsg <network> <channel/Nick> $msg|/nmsg <network> <channel/Nick> $msg }
163 42 Per Amundsen
</pre>
164 1 Per Amundsen
165 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.
166 46 Per Amundsen
167
Also added is better escaping, variables and a "null" variable, e.g
168
169
<pre>
170 47 Per Amundsen
OnEvent if ($event == PRIVMSG) { if (%test == null) { %test = SOMETHING|/msg $channel test is %test } }
171 46 Per Amundsen
</pre>
172
173 48 Per Amundsen
These variables are stored as long as the program is running, and you can change/use them in any OnEvent script.
174
175 49 Per Amundsen
Note also that all user set variables starts with % and client variables starts with $.
176
177 1 Per Amundsen
Variables is still work in progress, id love some feedback/ideas of what it can be used for.
178 50 Per Amundsen
179
New function is added .msgbox <message> e.g
180
181
<pre>
182
OnEvent if ($event == JOIN) { .msgbox $nick joined $channel }
183
</pre>
184
185
It will popup a messagebox with the message.
186 51 Per Amundsen
187
New events:
188
189
<pre>
190
OnLoad - Called when all commands are loaded the first time (ie when the program starts)
191
OnUnload - Called when all commands are unloaded (ie when the program exits)
192
OnReload - Called when all commands are reloaded (ie when you press apply in command editor)
193
OnConnecting - Called when a server is connecting
194
OnLookingUp - Called when a server is looking up the hostname
195
OnConnected - Called when a server is connected
196
OnDisconnect - Called when a server gets disconnected
197
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)
198
</pre>
199
200
A few examples using these.
201
202 52 Per Amundsen
<pre>
203 51 Per Amundsen
OnEvent if ($event == OnLoad) { %myvariable = This was set at startup }
204
OnEvent if ($event == OnUnLoad) { .msgbox varible set at startup was %myvariable }
205
OnEvent if ($event == OnReLoad) { .msgbox Commands reloaded }
206
OnEvent if ($event == OnConnecting) { .msgbox i r conecting }
207
OnEvent if ($event == OnLookingUp ) { .msgbox i r looking up hostname }
208
OnEvent if ($event == OnConnected ) { .msgbox i r connected }
209
OnEvent if ($event == OnDisconnect) { .msgbox i r disconnected }
210
OnEvent if ($event == OnCommand) { if ($0 == /me) { .msgbox i typed /me } }
211
OnEvent if ($event == OnCommand) { .msgbox i typed $0, full command was $msg }
212 52 Per Amundsen
</pre>
213 53 Per Amundsen
214
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:
215
216
<pre>
217 54 Per Amundsen
OnEvent if ($event == PRIVMSG) 
218
{ 
219 55 Per Amundsen
	if (%test == null) { 
220
		/msg Hello world; 
221
		if (%test == null) 
222
		{ 
223 56 Per Amundsen
			/msg Hello world; 
224
		} 
225 1 Per Amundsen
	} 
226
	else if (%test == null) 
227
	{ 
228 59 Per Amundsen
		/msg Hello world
229 1 Per Amundsen
	} 
230 55 Per Amundsen
	else (%test == null) 
231 54 Per Amundsen
	{ 
232 59 Per Amundsen
		/msg Hello world 
233 55 Per Amundsen
	} 
234
	if (%test == null) 
235
	{ 
236
		/msg Hello world 
237 54 Per Amundsen
	} 
238
}
239 53 Per Amundsen
</pre>
240
241 1 Per Amundsen
also ; is now useable like | for line ending.
242 54 Per Amundsen
243 57 Per Amundsen
Simple kickcounter script:
244
<pre>
245
OnEvent if ($event == OnCommand) 
246
{ 
247
	if ($0 == /kick) 
248
	{ 
249
		if (%kickcount == null) 
250
		{ 
251
			%kickcount = 0; 
252
		} 
253 58 Per Amundsen
		 
254 57 Per Amundsen
		if ($2 == null) 
255 1 Per Amundsen
		{ 
256 58 Per Amundsen
			%kickcount++;
257
			/kick $channel $1 Kick number %kickcount;
258
			.eat all; 
259 57 Per Amundsen
		} 
260
	} 
261
}
262
</pre>
263
264 54 Per Amundsen
A script editor will be the next step.