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
|
<!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>Modules included with Eggdrop — 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="Assoc Module" href="mod/assoc.html" />
<link rel="prev" title="Eggdrop Module Information" href="index.html" />
</head><body>
<div class="header-wrapper" role="banner">
<div class="header">
<div class="headertitle"><a
href="../index.html">Eggdrop 1.10.1rc2 documentation</a></div>
<div class="rel" role="navigation" aria-label="related navigation">
<a href="index.html" title="Eggdrop Module Information"
accesskey="P">previous</a> |
<a href="mod/assoc.html" title="Assoc Module"
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 class="current">
<li class="toctree-l1"><a class="reference internal" href="index.html">Eggdrop Module Information</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Modules included with Eggdrop</a><ul>
<li class="toctree-l2"><a class="reference internal" href="mod/assoc.html">Assoc Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="mod/blowfish.html">Blowfish Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="mod/channels.html">Channels Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="mod/compress.html">Compress Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="mod/console.html">Console Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="mod/ctcp.html">CTCP Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="mod/dns.html">DNS Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="mod/filesys.html">Filesys Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="mod/ident.html">Ident Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="mod/irc.html">IRC Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="mod/notes.html">Notes Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="mod/pbkdf2.html">PBKDF2 Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="mod/python.html">Python Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="mod/seen.html">Seen Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="mod/server.html">Server Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="mod/share.html">Share Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="mod/transfer.html">Transfer Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="mod/twitch.html">Twitch Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="mod/woobie.html">Woobie Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="mod/uptime.html">Uptime Module</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="writing.html">How to Write an Eggdrop Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="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="modules-included-with-eggdrop">
<h1>Modules included with Eggdrop<a class="headerlink" href="#modules-included-with-eggdrop" title="Link to this heading">¶</a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="mod/assoc.html">Assoc Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="mod/blowfish.html">Blowfish Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="mod/channels.html">Channels Module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="mod/channels.html#channel-settings">Channel Settings</a><ul>
<li class="toctree-l3"><a class="reference internal" href="mod/channels.html#value-based-channel-settings">Value-based Channel Settings</a></li>
<li class="toctree-l3"><a class="reference internal" href="mod/channels.html#enable-disable-channel-settings">Enable/Disable Channel Settings</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="mod/channels.html#default-channel-values">Default Channel Values</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="mod/compress.html">Compress Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="mod/console.html">Console Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="mod/ctcp.html">CTCP Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="mod/dns.html">DNS Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="mod/filesys.html">Filesys Module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="mod/filesys.html#config-file-setup">Config file setup</a></li>
<li class="toctree-l2"><a class="reference internal" href="mod/filesys.html#partyline-usage">Partyline usage</a><ul>
<li class="toctree-l3"><a class="reference internal" href="mod/filesys.html#files">.files</a></li>
<li class="toctree-l3"><a class="reference internal" href="mod/filesys.html#cancel-file-file">.cancel <file> [file] …</a></li>
<li class="toctree-l3"><a class="reference internal" href="mod/filesys.html#cd-directory">.cd <directory></a></li>
<li class="toctree-l3"><a class="reference internal" href="mod/filesys.html#cp-source-dst">.cp <source> <dst></a></li>
<li class="toctree-l3"><a class="reference internal" href="mod/filesys.html#desc-file-description">.desc <file> <description></a></li>
<li class="toctree-l3"><a class="reference internal" href="mod/filesys.html#filestats-user-clear">.filestats <user> [clear]</a></li>
<li class="toctree-l3"><a class="reference internal" href="mod/filesys.html#stats">.stats</a></li>
<li class="toctree-l3"><a class="reference internal" href="mod/filesys.html#get-filename-nickname">.get <filename> [nickname]</a></li>
<li class="toctree-l3"><a class="reference internal" href="mod/filesys.html#hide-file-files">.hide <file> [files] …</a></li>
<li class="toctree-l3"><a class="reference internal" href="mod/filesys.html#ln-bot-filepath-localfile">.ln <bot:filepath> <localfile></a></li>
<li class="toctree-l3"><a class="reference internal" href="mod/filesys.html#ls-filemask">.ls [filemask]</a></li>
<li class="toctree-l3"><a class="reference internal" href="mod/filesys.html#mkdir-dir-flags-channel">.mkdir <dir> [flags [channel]]</a></li>
<li class="toctree-l3"><a class="reference internal" href="mod/filesys.html#mv-source-dest">.mv <source> <dest></a></li>
<li class="toctree-l3"><a class="reference internal" href="mod/filesys.html#pending">.pending</a></li>
<li class="toctree-l3"><a class="reference internal" href="mod/filesys.html#pwd">.pwd</a></li>
<li class="toctree-l3"><a class="reference internal" href="mod/filesys.html#quit">.quit</a></li>
<li class="toctree-l3"><a class="reference internal" href="mod/filesys.html#rm-file-files">rm <file> [files] …</a></li>
<li class="toctree-l3"><a class="reference internal" href="mod/filesys.html#rmdir-dir">.rmdir <dir></a></li>
<li class="toctree-l3"><a class="reference internal" href="mod/filesys.html#share-file-files">.share <file> [files] …</a></li>
<li class="toctree-l3"><a class="reference internal" href="mod/filesys.html#optimize">.optimize</a></li>
<li class="toctree-l3"><a class="reference internal" href="mod/filesys.html#unhide">.unhide</a></li>
<li class="toctree-l3"><a class="reference internal" href="mod/filesys.html#unshare-file-file">.unshare <file> [file] …</a></li>
<li class="toctree-l3"><a class="reference internal" href="mod/filesys.html#id1">.filesys module</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="mod/ident.html">Ident Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="mod/irc.html">IRC Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="mod/notes.html">Notes Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="mod/pbkdf2.html">PBKDF2 Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="mod/python.html">Python Module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="mod/python.html#system-requirements">System Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="mod/python.html#loading-python">Loading Python</a></li>
<li class="toctree-l2"><a class="reference internal" href="mod/python.html#partyline-commands">Partyline Commands</a><ul>
<li class="toctree-l3"><a class="reference internal" href="mod/python.html#python-expression">python <expression></a></li>
<li class="toctree-l3"><a class="reference internal" href="mod/python.html#binds-python">.binds python</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="mod/python.html#tcl-commands">Tcl Commands</a><ul>
<li class="toctree-l3"><a class="reference internal" href="mod/python.html#pysource-path-to-file">pysource <path/to/file></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="mod/seen.html">Seen Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="mod/server.html">Server Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="mod/share.html">Share Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="mod/transfer.html">Transfer Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="mod/twitch.html">Twitch Module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="mod/twitch.html#limitations">Limitations</a></li>
<li class="toctree-l2"><a class="reference internal" href="mod/twitch.html#tcl-api">Tcl API</a></li>
<li class="toctree-l2"><a class="reference internal" href="mod/twitch.html#partyline-commands">Partyline commands</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="mod/woobie.html">Woobie Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="mod/uptime.html">Uptime Module</a></li>
</ul>
</div>
<dl class="simple">
<dt><a class="reference internal" href="mod/assoc.html#assoc"><span class="std std-ref">Assoc Module</span></a></dt><dd><p>This module provides assoc support, i.e. naming channels on the
botnet.</p>
</dd>
<dt><a class="reference internal" href="mod/blowfish.html#blowfish"><span class="std std-ref">Blowfish Module</span></a></dt><dd><p>This module has been deprecated in favor of the pbkdf2 module for hashing purposes, such as passwords in the userfile. However, it is still required for encrypting/decrypting strings.</p>
</dd>
<dt><a class="reference internal" href="mod/channels.html#channels"><span class="std std-ref">Channels Module</span></a></dt><dd><p>This module provides channel related support for the bot.
Without it, you won’t be able to make the bot join a channel
or save channel specific userfile information.</p>
</dd>
<dt><a class="reference internal" href="mod/compress.html#compress"><span class="std std-ref">Compress Module</span></a></dt><dd><p>This module provides support for file compression. This
allows the bot to transfer compressed user files and, therefore,
save a significant amount of bandwidth.</p>
</dd>
<dt><a class="reference internal" href="mod/console.html#console"><span class="std std-ref">Console Module</span></a></dt><dd><p>This module provides storage of console settings when you exit
the bot or type .store on the partyline.</p>
</dd>
<dt><a class="reference internal" href="mod/ctcp.html#ctcp"><span class="std std-ref">CTCP Module</span></a></dt><dd><p>This module provides the normal ctcp replies that you’d expect.
Without it loaded, CTCP CHAT will not work.</p>
</dd>
<dt><a class="reference internal" href="mod/dns.html#dns"><span class="std std-ref">DNS Module</span></a></dt><dd><p>This module provides asynchronous dns support. This will avoid
long periods where the bot just hangs there, waiting for a
hostname to resolve, which will often let it timeout on all
other connections.</p>
</dd>
<dt><a class="reference internal" href="mod/filesys.html#filesys"><span class="std std-ref">Filesys Module</span></a></dt><dd><p>This module provides an area within the bot where users can store
and manage files. With this module, the bot is usable as a file
server.</p>
</dd>
<dt><a class="reference internal" href="mod/ident.html#ident"><span class="std std-ref">Ident Module</span></a></dt><dd><p>This module adds Eggdrop support for the externally-provided oident service, or alternatively the ability for Eggdrop to act as its own ident daemon.</p>
</dd>
<dt><a class="reference internal" href="mod/irc.html#irc"><span class="std std-ref">IRC Module</span></a></dt><dd><p>This module provides basic IRC support for your bot. You have to
load this if you want your bot to come on IRC.</p>
</dd>
<dt><a class="reference internal" href="mod/notes.html#notes"><span class="std std-ref">Notes Module</span></a></dt><dd><p>This module provides support for storing of notes for users from
each other. Note sending between currently online users is
supported in the core, this is only for storing the notes for
later retrieval.</p>
</dd>
<dt><a class="reference internal" href="mod/pbkdf2.html#pbkdf2"><span class="std std-ref">PBKDF2 Module</span></a></dt><dd><p>This modules updates Eggdrop to use PBKDF2 for hashing purposes, such as for userfile passwords. It was specifically designed to work with the blowfish module to make the transition from blowfish to pbkdf2 password hashing as easy as possible. If you are transitioning a userfile from 1.8 or earlier, you should load this AND the blowfish module. By doing so, Eggdrop will seamlessly update the old blowfish hashes to the new PBKDF2 hashes once a user logs in for the first time, and allow you to (eventually) remove the blowfish module altogether. For new bots, you should load this module by itself and not use the blowfish module. The blowfish module is still required if you use Tcl to encrypt/decrypt strings in Tcl (ie, some scripts). Eggdrop will not start without a password-hashing module loaded.</p>
</dd>
<dt><a class="reference internal" href="mod/python.html#python"><span class="std std-ref">Python Module</span></a></dt><dd><p>This module adds a python interpreter to Eggdrop, enabling you to run python scripts on your Eggdrop!</p>
</dd>
<dt><a class="reference internal" href="mod/seen.html#seen"><span class="std std-ref">Seen Module</span></a></dt><dd><p>This module provides very basic seen commands via msg, on channel
or via dcc. This module works only for users in the bot’s
userlist. If you are looking for a better and more advanced seen
module, try the gseen module, originally written by G’Quann and forked/updated for modern Eggdrop by mortmann. You can find it at <a class="reference external" href="https://github.com/michaelortmann/gseen.mod">https://github.com/michaelortmann/gseen.mod</a></p>
</dd>
<dt><a class="reference internal" href="mod/server.html#server"><span class="std std-ref">Server Module</span></a></dt><dd><p>This module provides the core server support. You have to load
this if you want your bot to come on IRC. Not loading this is
equivalent to the old NO_IRC define.</p>
</dd>
<dt><a class="reference internal" href="mod/share.html#share"><span class="std std-ref">Share Module</span></a></dt><dd><p>This module provides userfile sharing support between two
directly linked bots.</p>
</dd>
<dt><a class="reference internal" href="mod/transfer.html#transfer"><span class="std std-ref">Transfer Module</span></a></dt><dd><p>The transfer module provides DCC SEND/GET support and userfile
transfer support for userfile sharing.</p>
</dd>
<dt><a class="reference internal" href="mod/twitch.html#twitch"><span class="std std-ref">Twitch Module</span></a></dt><dd><p>The Twitch module modifies Eggdrop to interact with the Twitch service. Twitch uses a modified implementation of IRC so not all functionality will be present. Please read doc/TWITCH for specifics on how to best use the Tiwtch module.</p>
</dd>
<dt><a class="reference internal" href="mod/uptime.html#uptime"><span class="std std-ref">Uptime Module</span></a></dt><dd><p>This module reports uptime statistics to the uptime contest
web site at <a class="reference external" href="https://www.eggheads.org/uptime">https://www.eggheads.org/uptime</a>. Go look and see what
your uptime is! It takes about 9 hours to show up, so if your
bot isn’t listed, try again later. See doc/settings/mod.uptime
for more information, including details on what information is
sent to the uptime server.</p>
</dd>
<dt><a class="reference internal" href="mod/woobie.html#woobie"><span class="std std-ref">Woobie Module</span></a></dt><dd><p>This is for demonstrative purposes only. If you are looking for
starting point in writing modules, woobie is the right thing.</p>
</dd>
</dl>
</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="index.html" title="Eggdrop Module Information"
>previous</a> |
<a href="mod/assoc.html" title="Assoc Module"
>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>
|
