28
24
<p><a name="config"></a>1. <strong>Config file settings</strong></p>
31
<p>Lines in <strong>bold</strong> are the lines that need to be
32
included in the Eggdrop config file if you want to use the share
33
module. Lines in <strong><em>bold italics</em></strong> are optional
34
and only required if you wish to change the default behaviour for
35
that particular feature.</p>
37
27
<p>This module provides the core server support. You have to load this
38
if you want your bot to come on irc.<br>
28
if you want your bot to come on IRC.<br>
41
31
<p>Put this line into your Eggdrop configuration file to load the
55
45
<p>What is your network?</p>
57
<p>0 = Efnet (non +e/+I hybrid)<br>
61
4 = Efnet +e/+I hybrid<br>
51
4 = +e/+I/max-bans 20 Hybrid<br>
65
55
<dt><strong>set nick "LamestBot"</strong></dt>
68
<p>Set the nick the bot uses on IRC, and on the botnet unless
58
<p>Set the nick the bot uses on IRC, and on the botnet unless
69
59
you specify a separate botnet-nick, here.</p>
72
62
<dt><strong>set altnick "LamestBot"</strong></dt>
75
<p>Set the alternative nick which the bot uses on IRC if the nick
76
specified by 'set nick' is unavailable. All '?'
65
<p>Set the alternative nick which the bot uses on IRC if the nick
66
specified by 'set nick' is unavailable. All '?'
77
67
characters will be replaced by random numbers.</p>
80
<dt><strong><em>set keep-nick 1</em></strong></dt>
70
<dt><strong>set keep-nick 1</strong></dt>
83
73
<p>This setting makes the bot try to get his original nickname back
84
74
if its primary nickname is already in use.</p>
87
<dt><strong>set realname "/msg LamestBot
88
hello"</strong></dt>
77
<dt><strong>set realname "/msg LamestBot hello"</strong></dt>
91
80
<p>Set here what to display in the real-name field for the bot.</p>
85
<strong>bind evnt - init-server evnt:init_server</strong><br>
86
<strong>proc evnt:init_server {type} {</strong><br>
87
<strong> global botnick</strong><br>
88
<strong> putquick "MODE $botnick +i-ws"</strong><br>
94
<p>This is a Tcl script to be run immediately after connecting to a
94
98
<dt><strong>set init-server { putserv "MODE $botnick +i-ws"
98
<p>Set here a script to run (if any) when first connecting to a
102
<dt><strong>set servers { irc.change.this:6667 irc.example.com:7000 }
102
<p>This is a Tcl script to be run immediately after connecting to a
103
server. It is limited to 120 characters, and is depriciated due to
104
the EVNT bind (see <a href="tcl-commands.html">Tcl Commands</a>).</p>
107
<dt><strong>set connect-server { putlog "Connecting to
108
server." }</strong></dt>
111
<p>This is a Tcl script to be run immediately before connecting to a
112
server. It is limited to 120 characters, and is depriciated due to
113
the EVNT bind (see <a href="tcl-commands.html">Tcl Commands</a>).</p>
116
<dt><strong>set disconnect-server { putlog "Disconnected from
117
server." }</strong></dt>
120
<p>This is a Tcl script to be run immediately after disconnecting
121
from a server. It is limited to 120 characters, and is depriciated
122
due to the EVNT bind (see <a href="tcl-commands.html">Tcl
126
<dt><strong>set servers {</strong></dt>
128
you.need.to.change.this:6667
129
another.example.com:7000:password
131
<p><strong>}</strong></p>
106
135
<p>This is the bot's server list. The bot will start at the first
128
157
with '.jump' or in 'set servers'.</p>
131
<dt><strong><em>set strict-servernames 0</em></strong></dt>
134
<p>Often, IRC servers call themselves a name other than their
135
actual hostname. If you want Eggdrop to replace your entry in the
136
config file with this name, set this to 1. If you set this setting
137
to 0, Eggdrop will keep a separate list of what IRC servers call
141
160
<dt><strong>set server-cycle-wait 60</strong></dt>
144
163
<p>This setting defines how long Eggdrop should wait before moving
145
from one server to another on disconnect. If you set 0 here,
164
from one server to another on disconnect. If you set 0 here,
146
165
Eggdrop will not wait at all and will connect instantly. Setting
147
166
this too low could result in your bot being K:Lined.</p>
199
<dt><strong><em>set use-console-r 0</em></strong></dt>
202
<p>This setting allows you the logging of all information received
203
from the server via console mode 'r'. <strong>NOTE:</strong>
204
This is a large security hole, allowing people to see user passwords.
205
This is now restricted to +n users only. Please choose your owners
209
<dt><strong><em>set debug-output 0</em></strong></dt>
212
<p>This setting allows you the logging of all information sent
213
to the server via console mode 'v'. <strong>NOTE:</strong>
214
This is a large security hole, allowing people to see passwords.
215
This is now restricted to +n users only. Please choose your owners
219
<dt><strong><em>set strict-host 0</em></strong></dt>
222
<p>Set this to 1 if you don't want your the bot to strip a
218
<dt><strong>set raw-log 0</strong></dt>
221
<p>This setting allows you the logging of raw incoming server
222
traffic via console/log flag 'r', raw outgoing server
223
traffic via console/log mode 'v', raw botnet traffic via
224
console/log mode 't', and raw share traffic via console/log
225
mode 'h'. These flags can create a large security hole,
226
allowing people to see user passwords. This is now restricted to +n
227
users only. Please choose your owners with care.</p>
230
<dt><strong>set strict-host 0</strong></dt>
233
<p>Set this to 1 if you don't want your the bot to strip a
223
234
leading '~'on user@hosts.</p>
226
<dt><strong><em>set quiet-reject 1</em></strong></dt>
237
<dt><strong>set quiet-reject 1</strong></dt>
229
<p>This setting makes the bot squelch the error message when
230
rejecting a DCC CHAT or SEND. Normally it tells the DCC user that
231
the CHAT or SEND has been rejected because they don't have
232
access. Please note, sometimes IRC server operators detect bots
240
<p>This setting makes the bot squelch the error message when
241
rejecting a DCC CHAT, SEND or message command. Normally,
242
Eggdrop notifies the user that the command has been rejected
243
because they don't have access. Note that sometimes IRC
244
server operators detect bots that way.</p>
236
247
<dt><strong>set flood-msg 5:60</strong></dt>
239
<p>Set here how many msgs in how many seconds from one host
250
<p>Set here how many msgs in how many seconds from one host
240
251
constitutes a flood. If you set this to 0:0, msg flood protection
241
252
will be disabled.</p>
255
266
<p>Set how many ctcps should be answered at once here.</p>
258
<dt><strong><em>set lowercase-ctcp 0</em></strong></dt>
269
<dt><strong>set lowercase-ctcp 0</strong></dt>
261
<p>If you want your bot to answer lower case ctcp requests (non
272
<p>If you want your bot to answer lower case ctcp requests (non
262
273
rfc-compliant), set this setting to 1. mIRC will do this, most
263
274
other clients will not.</p>
266
<dt><strong><em>set trigger-on-ignore 0</em></strong></dt>
277
<dt><strong>set trigger-on-ignore 0</strong></dt>
269
<p>If you want Eggdrop to trigger binds for ignored users, set
280
<p>If you want Eggdrop to trigger binds for ignored users, set
296
307
<p>This enables Eggdrop's penalty calculation. Every command
297
308
Eggdrop sends to the IRC server raises it's penalty points.
298
If Eggdrop reaches a server limit, it gets disconnected with
299
"excess flood" message. Eggdrop is able to count internal those
309
If Eggdrop reaches a server limit, it gets disconnected with
310
"excess flood" message. Eggdrop is able to count internal those
300
311
penalty points, too and take measures against excess flooding.
301
312
Note: it's highly advised to turn this on!</p>
304
<dt><strong><em>set optimize-kicks 1</em></strong></dt>
315
<dt><strong>set optimize-kicks 1</strong></dt>
307
<p>This optimizes the kick queue. It also traces nick changes
318
<p>This optimizes the kick queue. It also traces nick changes
308
319
and parts in the channel and changes the kick queue accordingly.
309
320
There are three different options for this setting:</p>
337
348
and set to 1 for net-type 1.</p>
340
<dt><strong><em>set nick-len 9</em></strong></dt>
351
<dt><strong>set nick-len 9</strong></dt>
343
354
<p>This setting allows you to specify the maximum nick-length
344
supported by your network. The default setting is 9. The
355
supported by your network. The default setting is 9. The
345
356
maximum supported length by Eggdrop is 32.</p>
351
<p><a name="tclcmds"></a>2. <strong>Tcl commands</strong></p>
353
<p>See doc/tcl-commands.doc for information on each of these
358
<li><strong>putserv <text></strong></li>
360
<li><strong>putquick <text></strong></li>
362
<li><strong>puthelp <text></strong></li>
364
<li><strong>queuesize [queue]</strong></li>
366
<li><strong>clearqueue <queue></strong></li>
368
<li><strong>dumpfile <nick> <filename></strong></li>
370
<li><strong>jump [server [port [password]]]</strong></li>
374
<p><a name="tclvars"></a>3. <strong>Tcl variables</strong></p>
378
<dt><strong>botnick</strong></dt>
381
<p>This is the current nickname the bot is using, i.e.
382
'Sisko' or 'Sisko0', etc.</p>
385
<dt><strong>botname</strong></dt>
388
<p>This is the current nick!user@host that the server sees, i.e.
389
'Sisko!ikaney@uk.defiant.org'.</p>
392
<dt><strong>isjuped</strong></dt>
395
<p>The value of this variable is 1 if bots nick is juped(437); 0
399
<dt><strong>server</strong></dt>
402
<p>This is the current server the bot is using, i.e.
403
'irc.math.ufl.edu:6667'.</p>
406
<dt><strong>server-online</strong></dt>
409
<p>This is the uunixtime value for when the bot connected to its
416
362
<p><em>Copyright © 1997 Robey Pointer<br>
417
Copyright © 1999, 2000, 2001, 2002 <a href="http://www.eggheads.org/">
418
Eggheads Development Team</a></em></p>
363
Copyright © 1999, 2000, 2001, 2002, 2003, 2004
364
<a href="http://www.eggheads.org/"> Eggheads Development Team</a></em></p>