Eggdrop 1.10.1rc2 documentation

# Modules included with Eggdrop

- Assoc Module
- Blowfish Module
- Channels Module
  - Channel Settings
    - Value-based Channel Settings
    - Enable/Disable Channel Settings
  - Default Channel Values
- Compress Module
- Console Module
- CTCP Module
- DNS Module
- Filesys Module
  - Config file setup
  - Partyline usage
    - .files
    - .cancel <file> [file] …
    - .cd <directory>
    - .cp <source> <dst>
    - .desc <file> <description>
    - .filestats <user> [clear]
    - .stats
    - .get <filename> [nickname]
    - .hide <file> [files] …
    - .ln <bot:filepath> <localfile>
    - .ls [filemask]
    - .mkdir <dir> [flags [channel]]
    - .mv <source> <dest>
    - .pending
    - .pwd
    - .quit
    - rm <file> [files] …
    - .rmdir <dir>
    - .share <file> [files] …
    - .optimize
    - .unhide
    - .unshare <file> [file] …
    - .filesys module
- Ident Module
- IRC Module
- Notes Module
- PBKDF2 Module
- Python Module
  - System Requirements
  - Loading Python
  - Partyline Commands
    - python <expression>
    - .binds python
  - Tcl Commands
    - pysource <path/to/file>
- Seen Module
- Server Module
- Share Module
- Transfer Module
- Twitch Module
  - Limitations
  - Tcl API
  - Partyline commands
- Woobie Module
- Uptime Module

Assoc Module

  This module provides assoc support, i.e. naming channels on the botnet.

Blowfish Module

  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.

Channels Module

  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.

Compress Module

  This module provides support for file compression. This allows the bot to transfer compressed user files and, therefore, save a significant amount of bandwidth.

Console Module

  This module provides storage of console settings when you exit the bot or type .store on the partyline.

CTCP Module

  This module provides the normal ctcp replies that you’d expect. Without it loaded, CTCP CHAT will not work.

DNS Module

  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.

Filesys Module

  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.

Ident Module

  This module adds Eggdrop support for the externally-provided oident service, or alternatively the ability for Eggdrop to act as its own ident daemon.

IRC Module

  This module provides basic IRC support for your bot. You have to load this if you want your bot to come on IRC.

Notes Module

  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.

PBKDF2 Module

  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.

Python Module

  This module adds a python interpreter to Eggdrop, enabling you to run python scripts on your Eggdrop!

Seen Module

  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 https://github.com/michaelortmann/gseen.mod

Server Module

  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.

Share Module

  This module provides userfile sharing support between two directly linked bots.

Transfer Module

  The transfer module provides DCC SEND/GET support and userfile transfer support for userfile sharing.

Twitch Module

  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.

Uptime Module

  This module reports uptime statistics to the uptime contest web site at https://www.eggheads.org/uptime. 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.

Woobie Module

  This is for demonstrative purposes only. If you are looking for starting point in writing modules, woobie is the right thing.