1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
|
<!DOCTYPE html>
<html lang="en" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Eggdrop, an open source IRC bot — Eggdrop 1.10.1rc2 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
<link rel="stylesheet" type="text/css" href="_static/eggdrop.css?v=ab48a1b6" />
<script src="_static/documentation_options.js?v=290de6c6"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="README" href="install/readme.html" />
</head><body>
<div class="header-wrapper" role="banner">
<div class="header">
<div class="headertitle"><a
href="#">Eggdrop 1.10.1rc2 documentation</a></div>
<div class="rel" role="navigation" aria-label="related navigation">
<a href="install/readme.html" title="README"
accesskey="N">next</a>
</div>
</div>
</div>
<div class="content-wrapper">
<div class="content">
<div class="sidebar">
<h3>Table of Contents</h3>
<p class="caption" role="heading"><span class="caption-text">Installing Eggdrop</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="install/readme.html">README</a></li>
<li class="toctree-l1"><a class="reference internal" href="install/install.html">Installing Eggdrop</a></li>
<li class="toctree-l1"><a class="reference internal" href="install/upgrading.html">Upgrading Eggdrop</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Using Eggdrop</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="using/features.html">Eggdrop Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="using/core.html">Eggdrop Core Settings</a></li>
<li class="toctree-l1"><a class="reference internal" href="using/partyline.html">The Party Line</a></li>
<li class="toctree-l1"><a class="reference internal" href="using/autoscripts.html">Eggdrop Autoscripts</a></li>
<li class="toctree-l1"><a class="reference internal" href="using/users.html">Users and Flags</a></li>
<li class="toctree-l1"><a class="reference internal" href="using/bans.html">Bans, Invites, and Exempts</a></li>
<li class="toctree-l1"><a class="reference internal" href="using/botnet.html">Botnet Sharing and Linking</a></li>
<li class="toctree-l1"><a class="reference internal" href="using/ipv6.html">IPv6 support</a></li>
<li class="toctree-l1"><a class="reference internal" href="using/tls.html">TLS support</a></li>
<li class="toctree-l1"><a class="reference internal" href="using/ircv3.html">IRCv3 support</a></li>
<li class="toctree-l1"><a class="reference internal" href="using/accounts.html">Account tracking in Eggdrop</a></li>
<li class="toctree-l1"><a class="reference internal" href="using/pbkdf2info.html">Encryption/Hashing</a></li>
<li class="toctree-l1"><a class="reference internal" href="using/python.html">Using the Python Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="using/twitchinfo.html">Twitch</a></li>
<li class="toctree-l1"><a class="reference internal" href="using/tricks.html">Advanced Tips</a></li>
<li class="toctree-l1"><a class="reference internal" href="using/text-sub.html">Textfile Substitutions</a></li>
<li class="toctree-l1"><a class="reference internal" href="using/tcl-commands.html">Eggdrop Tcl Commands</a></li>
<li class="toctree-l1"><a class="reference internal" href="using/twitch-tcl-commands.html">Eggdrop Twitch Tcl Commands</a></li>
<li class="toctree-l1"><a class="reference internal" href="using/patch.html">Patching Eggdrop</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="tutorials/setup.html">Setting Up Eggdrop</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorials/firststeps.html">Common First Steps</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorials/tlssetup.html">Enabling TLS Security on Eggdrop</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorials/userfilesharing.html">Sharing Userfiles</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorials/firstscript.html">Writing an Eggdrop Tcl Script</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorials/module.html">Writing a Basic Eggdrop Module</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Eggdrop Modules</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="modules/index.html">Eggdrop Module Information</a></li>
<li class="toctree-l1"><a class="reference internal" href="modules/included.html">Modules included with Eggdrop</a></li>
<li class="toctree-l1"><a class="reference internal" href="modules/writing.html">How to Write an Eggdrop Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="modules/internals.html">Eggdrop Bind Internals</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">About Eggdrop</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="about/about.html">About Eggdrop</a></li>
<li class="toctree-l1"><a class="reference internal" href="about/legal.html">Boring legal stuff</a></li>
</ul>
<div role="search">
<h3 style="margin-top: 1.5em;">Search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="eggdrop-an-open-source-irc-bot">
<h1>Eggdrop, an open source IRC bot<a class="headerlink" href="#eggdrop-an-open-source-irc-bot" title="Link to this heading">¶</a></h1>
<p>Eggdrop is a free, open source software program built to assist in managing an IRC channel. It is the world’s oldest actively-maintained IRC bot and was designed to be easily used and expanded on via it’s ability to run Tcl scripts. Eggdrop can join IRC channels and perorm automated tasks such as protecting the channel from abuse, assisting users obtain their op/voice status, provide information and greetings, host games, etc.</p>
<section id="some-things-you-can-do-with-eggdrop">
<h2>Some things you can do with Eggdrop<a class="headerlink" href="#some-things-you-can-do-with-eggdrop" title="Link to this heading">¶</a></h2>
<p>Eggdrop has a large number of features, such as:</p>
<ul class="simple">
<li><p><a class="reference external" href="using/users.html">Channel Management</a></p></li>
<li><p>Running Tcl Scripts</p></li>
<li><p><a class="reference external" href="using/ircv3.html">Integration of the most current IRCv3 capabilities</a></p></li>
<li><p><a class="reference external" href="using/botnet.html">The ability to link multiple Eggdrops together and share userfiles</a></p></li>
<li><p><a class="reference external" href="using/tls.html">TLS Support</a></p></li>
<li><p><a class="reference external" href="using/ipv6.html">IPv6 Support</a></p></li>
<li><p><a class="reference external" href="using/twitchinfo.html">Twitch Support</a></p></li>
<li><p>… and much much more!</p></li>
</ul>
</section>
<section id="how-to-get-eggdrop">
<h2>How to get Eggdrop<a class="headerlink" href="#how-to-get-eggdrop" title="Link to this heading">¶</a></h2>
<p>The Eggdrop project source code is hosted at <a class="reference external" href="https://github.com/eggheads/eggdrop">https://github.com/eggheads/eggdrop</a>. You can clone it via git, or alternatively a copy of the current stable snapshot is located at <a class="reference external" href="https://geteggdrop.com">https://geteggdrop.com</a>. Additional information can be found on the official Eggdrop webpage at <a class="reference external" href="https://www.eggheads.org">https://www.eggheads.org</a>. For more information, see <a class="reference external" href="install/install.html">Installing Eggdrop</a></p>
</section>
<section id="how-to-install-eggdrop">
<h2>How to install Eggdrop<a class="headerlink" href="#how-to-install-eggdrop" title="Link to this heading">¶</a></h2>
<section id="installation-pre-requisites">
<h3>Installation Pre-requisites<a class="headerlink" href="#installation-pre-requisites" title="Link to this heading">¶</a></h3>
<p>Eggdrop requires Tcl (and its development header files) to be present on the system it is compiled on. It is also strongly encouraged to install openssl (and its development header files) to enable TLS-protected network communication.</p>
</section>
<section id="installation">
<h3>Installation<a class="headerlink" href="#installation" title="Link to this heading">¶</a></h3>
<p>A guide to quickly installing Eggdrop can be found here.</p>
</section>
</section>
<section id="where-to-find-more-help">
<h2>Where to find more help<a class="headerlink" href="#where-to-find-more-help" title="Link to this heading">¶</a></h2>
<p>The Eggheads development team can be found lurking on #eggdrop on the Libera network (irc.libera.chat).</p>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">Installing Eggdrop</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="install/readme.html">README</a><ul>
<li class="toctree-l2"><a class="reference internal" href="install/readme.html#notice">Notice</a></li>
<li class="toctree-l2"><a class="reference internal" href="install/readme.html#what-is-eggdrop">What is Eggdrop?</a></li>
<li class="toctree-l2"><a class="reference internal" href="install/readme.html#how-to-get-eggdrop">How to Get Eggdrop</a></li>
<li class="toctree-l2"><a class="reference internal" href="install/readme.html#system-pre-requisites">System Pre-Requisites</a></li>
<li class="toctree-l2"><a class="reference internal" href="install/readme.html#minimum-requirements">Minimum Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="install/readme.html#quick-startup">Quick Startup</a></li>
<li class="toctree-l2"><a class="reference internal" href="install/readme.html#upgrading">Upgrading</a></li>
<li class="toctree-l2"><a class="reference internal" href="install/readme.html#command-line">Command Line</a></li>
<li class="toctree-l2"><a class="reference internal" href="install/readme.html#auto-starting-eggdrop">Auto-starting Eggdrop</a></li>
<li class="toctree-l2"><a class="reference internal" href="install/readme.html#documentation">Documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="install/readme.html#obtaining-help">Obtaining Help</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="install/install.html">Installing Eggdrop</a><ul>
<li class="toctree-l2"><a class="reference internal" href="install/install.html#quick-startup">Quick Startup</a></li>
<li class="toctree-l2"><a class="reference internal" href="install/install.html#cygwin-requirements-windows">Cygwin Requirements (Windows)</a></li>
<li class="toctree-l2"><a class="reference internal" href="install/install.html#modules">Modules</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="install/upgrading.html">Upgrading Eggdrop</a><ul>
<li class="toctree-l2"><a class="reference internal" href="install/upgrading.html#how-to-upgrade">How to Upgrade</a></li>
<li class="toctree-l2"><a class="reference internal" href="install/upgrading.html#must-read-changes-for-eggdrop-v1-10">Must-read changes for Eggdrop v1.10</a></li>
</ul>
</li>
</ul>
</div>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">Using Eggdrop</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="using/features.html">Eggdrop Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="using/core.html">Eggdrop Core Settings</a><ul>
<li class="toctree-l2"><a class="reference internal" href="using/core.html#executable-path">Executable Path</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/core.html#basic-settings">Basic Settings</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/core.html#log-files">Log Files</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/core.html#console-settings">Console Settings</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/core.html#file-and-directory-settings">File and Directory Settings</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/core.html#botnet-dcc-telnet-settings">Botnet/Dcc/Telnet Settings</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/core.html#advanced-settings">Advanced Settings</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/core.html#ssl-settings">SSL Settings</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/core.html#modules">Modules</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/core.html#scripts">Scripts</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="using/partyline.html">The Party Line</a></li>
<li class="toctree-l1"><a class="reference internal" href="using/autoscripts.html">Eggdrop Autoscripts</a><ul>
<li class="toctree-l2"><a class="reference internal" href="using/autoscripts.html#autoscripts-usage">Autoscripts usage</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/autoscripts.html#autoscripts-file-structure">Autoscripts File Structure</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/autoscripts.html#development-hints">Development hints</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/autoscripts.html#tcl-commands">Tcl Commands</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="using/users.html">Users and Flags</a></li>
<li class="toctree-l1"><a class="reference internal" href="using/bans.html">Bans, Invites, and Exempts</a></li>
<li class="toctree-l1"><a class="reference internal" href="using/botnet.html">Botnet Sharing and Linking</a><ul>
<li class="toctree-l2"><a class="reference internal" href="using/botnet.html#what-is-a-botnet">What is a botnet?</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/botnet.html#terms">Terms</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/botnet.html#example-bottrees">Example bottrees</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/botnet.html#bot-flags">Bot Flags</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/botnet.html#adding-and-linking-bots">Adding and linking bots</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/botnet.html#using-botflags">Using botflags</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/botnet.html#making-bots-share-user-records">Making bots share user records</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/botnet.html#using-certificates-to-authenticate-eggdrops">Using certificates to authenticate Eggdrops</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="using/ipv6.html">IPv6 support</a><ul>
<li class="toctree-l2"><a class="reference internal" href="using/ipv6.html#about">About</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/ipv6.html#installation">Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/ipv6.html#usage">Usage</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/ipv6.html#ctcp-chat-chat4-chat6">CTCP CHAT/CHAT4/CHAT6</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/ipv6.html#settings">Settings</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="using/tls.html">TLS support</a><ul>
<li class="toctree-l2"><a class="reference internal" href="using/tls.html#about">About</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/tls.html#installation">Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/tls.html#usage">Usage</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/tls.html#keys-certificates-and-authentication">Keys, certificates and authentication</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/tls.html#ssl-tls-settings">SSL/TLS Settings</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="using/ircv3.html">IRCv3 support</a><ul>
<li class="toctree-l2"><a class="reference internal" href="using/ircv3.html#about">About</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/ircv3.html#usage">Usage</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/ircv3.html#supported-cap-capabilities">Supported CAP capabilities</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/ircv3.html#errata">Errata</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="using/accounts.html">Account tracking in Eggdrop</a><ul>
<li class="toctree-l2"><a class="reference internal" href="using/accounts.html#required-server-capabilities">Required Server Capabilities</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/accounts.html#enabling-eggdrop-account-tracking">Enabling Eggdrop Account Tracking</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/accounts.html#checking-account-tracking-status">Checking Account-tracking Status</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/accounts.html#determining-if-a-server-supports-account-capabilities">Determining if a Server Supports Account Capabilities</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/accounts.html#best-effort-account-tracking">Best-Effort Account Tracking</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/accounts.html#using-accounts-with-tcl-scripts">Using Accounts with Tcl Scripts</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="using/pbkdf2info.html">Encryption/Hashing</a><ul>
<li class="toctree-l2"><a class="reference internal" href="using/pbkdf2info.html#background">Background</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/pbkdf2info.html#usage">Usage</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/pbkdf2info.html#tcl-interface">Tcl Interface</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="using/python.html">Using the Python Module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="using/python.html#system-requirements">System Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/python.html#loading-python">Loading Python</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/python.html#reloading-python-scripts">Reloading Python Scripts</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/python.html#multithreading-and-async">Multithreading and async</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/python.html#eggdrop-python-commands">Eggdrop Python Commands</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/python.html#writing-an-eggdrop-python-script">Writing an Eggdrop Python script</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="using/twitchinfo.html">Twitch</a><ul>
<li class="toctree-l2"><a class="reference internal" href="using/twitchinfo.html#disclaimer">Disclaimer</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/twitchinfo.html#registering-with-twitch">Registering with Twitch</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/twitchinfo.html#editing-the-config-file">Editing the config file</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/twitchinfo.html#twitch-web-ui-functions">Twitch web UI functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/twitchinfo.html#twitch-irc-limitations">Twitch IRC limitations</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="using/tricks.html">Advanced Tips</a><ul>
<li class="toctree-l2"><a class="reference internal" href="using/tricks.html#renaming-commands">Renaming commands</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/tricks.html#keeping-logs">Keeping Logs</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/tricks.html#self-logging">Self-logging</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/tricks.html#modifying-default-strings">Modifying Default Strings</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/tricks.html#modularizing-your-config-file">Modularizing Your Config File</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/tricks.html#variables-in-your-config">Variables in Your Config</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="using/text-sub.html">Textfile Substitutions</a></li>
<li class="toctree-l1"><a class="reference internal" href="using/tcl-commands.html">Eggdrop Tcl Commands</a><ul>
<li class="toctree-l2"><a class="reference internal" href="using/tcl-commands.html#output-commands">Output Commands</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/tcl-commands.html#user-record-manipulation-commands">User Record Manipulation Commands</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/tcl-commands.html#channel-commands">Channel Commands</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/tcl-commands.html#dcc-commands">DCC Commands</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/tcl-commands.html#notes-module">Notes Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/tcl-commands.html#assoc-module">Assoc Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/tcl-commands.html#compress-module">Compress Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/tcl-commands.html#filesys-module">Filesys Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/tcl-commands.html#pbkdf2-module">PBKDF2 Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/tcl-commands.html#miscellaneous-commands">Miscellaneous Commands</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/tcl-commands.html#global-variables">Global Variables</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/tcl-commands.html#binds">Binds</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/tcl-commands.html#control-procedures">Control Procedures</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/tcl-commands.html#tcp-connections">TCP Connections</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/tcl-commands.html#match-characters">Match Characters</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="using/twitch-tcl-commands.html">Eggdrop Twitch Tcl Commands</a><ul>
<li class="toctree-l2"><a class="reference internal" href="using/twitch-tcl-commands.html#commands">Commands</a></li>
<li class="toctree-l2"><a class="reference internal" href="using/twitch-tcl-commands.html#binds">Binds</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="using/patch.html">Patching Eggdrop</a><ul>
<li class="toctree-l2"><a class="reference internal" href="using/patch.html#submitting-a-patch-via-github">Submitting a patch via GitHub</a></li>
</ul>
</li>
</ul>
</div>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="tutorials/setup.html">Setting Up Eggdrop</a><ul>
<li class="toctree-l2"><a class="reference internal" href="tutorials/setup.html#prerequisites">Prerequisites</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials/setup.html#the-super-short-version">The super-short version</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials/setup.html#getting-the-source">Getting the source</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials/setup.html#installation">Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials/setup.html#configuration">Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials/setup.html#starting-the-eggdrop">Starting the Eggdrop</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tutorials/firststeps.html">Common First Steps</a><ul>
<li class="toctree-l2"><a class="reference internal" href="tutorials/firststeps.html#log-on-to-the-partyline">Log on to the partyline</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials/firststeps.html#id1">Common first steps</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials/firststeps.html#automatically-restarting-an-eggdrop">Automatically restarting an Eggdrop</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials/firststeps.html#authenticating-with-nickserv">Authenticating with NickServ</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials/firststeps.html#setting-up-sasl-authentication">Setting up SASL authentication</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tutorials/tlssetup.html">Enabling TLS Security on Eggdrop</a><ul>
<li class="toctree-l2"><a class="reference internal" href="tutorials/tlssetup.html#pre-requisites">Pre-requisites</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials/tlssetup.html#connecting-to-a-tls-enabled-irc-server">Connecting to a TLS-enabled IRC server</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials/tlssetup.html#protecting-botnet-communications">Protecting Botnet Communications</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials/tlssetup.html#additional-information">Additional Information</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tutorials/userfilesharing.html">Sharing Userfiles</a><ul>
<li class="toctree-l2"><a class="reference internal" href="tutorials/userfilesharing.html#how-to-share-userfiles-the-super-short-version">How to share userfiles- the super-short version</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials/userfilesharing.html#explaining-the-linking-sharing-process">Explaining the Linking/Sharing Process</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tutorials/firstscript.html">Writing an Eggdrop Tcl Script</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorials/module.html">Writing a Basic Eggdrop Module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="tutorials/module.html#module-header">Module Header</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials/module.html#required-code">Required Code</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials/module.html#adding-a-partyline-command">Adding a Partyline Command</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials/module.html#adding-a-tcl-command">Adding a Tcl Command</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials/module.html#adding-a-tcl-bind">Adding a Tcl Bind</a></li>
</ul>
</li>
</ul>
</div>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">Eggdrop Modules</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="modules/index.html">Eggdrop Module Information</a><ul>
<li class="toctree-l2"><a class="reference internal" href="modules/index.html#what-are-modules">What are modules?</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/index.html#how-to-install-a-module">How to install a module</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/index.html#can-i-compile-eggdrop-without-dynamic-modules-static-compile">Can I compile Eggdrop without dynamic modules? (Static compile)</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="modules/included.html">Modules included with Eggdrop</a><ul>
<li class="toctree-l2"><a class="reference internal" href="modules/mod/assoc.html">Assoc Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/mod/blowfish.html">Blowfish Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/mod/channels.html">Channels Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/mod/compress.html">Compress Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/mod/console.html">Console Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/mod/ctcp.html">CTCP Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/mod/dns.html">DNS Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/mod/filesys.html">Filesys Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/mod/ident.html">Ident Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/mod/irc.html">IRC Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/mod/notes.html">Notes Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/mod/pbkdf2.html">PBKDF2 Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/mod/python.html">Python Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/mod/seen.html">Seen Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/mod/server.html">Server Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/mod/share.html">Share Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/mod/transfer.html">Transfer Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/mod/twitch.html">Twitch Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/mod/woobie.html">Woobie Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/mod/uptime.html">Uptime Module</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="modules/writing.html">How to Write an Eggdrop Module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="modules/writing.html#module-requirements">Module requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/writing.html#what-to-do-with-a-module">What to do with a module?</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="modules/internals.html">Eggdrop Bind Internals</a><ul>
<li class="toctree-l2"><a class="reference internal" href="modules/internals.html#general-workflow-to-create-a-new-bind">General Workflow To Create a New Bind</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/internals.html#adding-a-new-bind-type-to-the-bind-table">Adding a New Bind Type to the Bind Table</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/internals.html#adding-bind-functionality">Adding Bind Functionality</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/internals.html#using-the-bind-in-tcl">Using the Bind in Tcl</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/internals.html#triggering-any-bind">Triggering any Bind</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/internals.html#c-binding">C Binding</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/internals.html#c-handler">C Handler</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/internals.html#summary">Summary</a></li>
</ul>
</li>
</ul>
</div>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">About Eggdrop</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="about/about.html">About Eggdrop</a></li>
<li class="toctree-l1"><a class="reference internal" href="about/legal.html">Boring legal stuff</a></li>
</ul>
</div>
</section>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
</div>
<div class="footer-wrapper">
<div class="footer">
<div class="left">
<div role="navigation" aria-label="related navigaton">
<a href="install/readme.html" title="README"
>next</a>
</div>
<div role="note" aria-label="source link">
</div>
</div>
<div class="right">
<div class="footer" role="contentinfo">
© Copyright 2025, Eggheads.
Last updated on Aug 15, 2025.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
</div>
</div>
<div class="clearer"></div>
</div>
</div>
</body>
</html>
|
