Eggdrop

• Eggdrop is the world's most popular open source IRC Bot.

"..designed for flexibility and ease of use, and is freely distributable under the GNU General Public License (GPL).

Eggdrop was originally developed by Robey Pointer; however, he no longer works on Eggdrop so please do not contact him for help solving a problem or bug.

Some features of Eggdrop

• Designed to run on Linux, *BSD, SunOs, Windows, MacOS X, etc ...

• Extendable with tcl scripts and/or C modules

• Support for the big five IRC Networks (UnderNet, DALnet, EfNet, IrcNet, and QuakeNet)

• The ability to form botnets and share partylines and userfiles between bots

Some benefits of Eggdrop

• The oldest IRC bot still in active development (Eggdrop was created in 1993)

• Established IRC help channels and web sites dedicated to Eggdrop

• Thousands of premade tcl scripts and C modules

• Best of all ... It's FREE!

How to install an Eggdrop

The Short Short & Updated Version

• ssh to the shell.

• wget or ftp the source from [[1]]

• UnPack it ( tar zxvf eggdrop1.6.17.tar.gz )

• Switch to the directory ( cd eggdrop1.6.17 )

• Start the config script ( ./configure )

• Compile the modules ,either all ( make config ) or select some of them ( make iconfig ).

• Compile the bot ( make )

• Create botdir ( mkdir /home/name/botdir )

• Install it to a directory of your choice ( make install DEST=/home/name/botdir or try make eggdrop install DEST=/home/name/botdir ).

• Switch to the botdir and edit the sample config file eggdrop.conf, then rename it to something appropriate (e.g. botnick.conf).

• Start the bot up in user-creation mode (only the first time) ( ./eggdrop -m <config file> ).

• Telnet to the port you chose in the config file and type "NEW" as user. Setup your real user name and password.

• Now you are owner of the bot , and from now on you start it without the -m option , just (./eggdrop <config file>).

• If you dont see it appearing on IRC right away, Telnet to the Partyline and try .jump irc.someserver.com

• You should have setup your channels in the config, but if you activated dynamic channels you can now use .+chan #channel on the partyline to make your bot join additional channels.

• Now learn the partyline commands to setup users and give them the flags you want. (.+user , .adduser , .chattr) and generally .help . All partyline commands beging with a "." Enjoy.

Note: Eggdrop requires tcl to compile. If the server does not have tcl installed, you will need to download and [install] it.

Hint: You might want to set your $LD_LIBRARY_PATH enviromental varible i.e. "export LD_LIBRARY_PATH; LD_LIBRARY_PATH=/usr/local/lib" or where ever your libary is. If you get a error like this...

./eggdrop: error while loading shared libraries: libtcl8.4.so: cannot open shared object file: No such file or directory

Settinng Up botchk

botchk is a nice little cron script that will start your bot for you if its not running. e.g if the bot die's or the is box restarted. be carefull though, as it will just keep starting up the bot no matter why it dies, make shore you box admin alows the use of botchk.

in the eggdrop/scripts dir run this command

./autobotchk <config> -dir /home/botdir -noemail

where <config> is the name of your bots config file and /home/botdir is the dir of you bot .

channel settings

A complete list of all available channel settings:

enforcebans

When a ban is set, kick people who are on the channel and match the ban?

dynamicbans

Only activate bans on the channel when necessary? This keeps the channel's ban list from getting excessively long. The bot still remembers every ban, but it only activates a ban on the channel when it sees someone join who matches that ban.

userbans

Allow bans to be made by users directly? If turned off, the bot will require all bans to be made through the bot's console.

dynamicexempts

Only activate exempts on the channel when necessary? This keeps the channel's exempt list from getting excessively long. The bot still remembers every exempt, but it only activates a exempt on the channel when it sees a ban set that matches the exempt. The exempt remains active on the channel for as long as the ban is still active.

userexempts

Allow exempts to be made by users directly? If turned off, the bot will require all exempts to be made through the bot's console.

dynamicinvites

Only activate invites on the channel when necessary? This keeps the channel's invite list from getting excessively long. The bot still remembers every invite, but the invites are only activated when the channel is set to invite only and a user joins after requesting an invite. Once set, the invite remains until the channel goes to -i.

userinvites

Allow invites to be made by users directly? If turned off, the bot will require all invites to be made through the bot's console.

autoop

Op users with the +o flag as soon as they join the channel? This is highly insecure and not at all recommended.

autohalfop

Halfop users with the +l flag as soon as they join the channel? This is also insecure and not recommended.

bitch

Only let users with +o| flag be opped on the channel?

greet

Say a user's info line when they join the channel?

protectops

Re-op a user with the +o flag if they get deopped?

protecthalfops

Re-halfop a user with the +l flag if they get dehalfopped?

protectfriends

Re-op a user with the +f flag if they get deopped?

statuslog

Log the channel status line every 5 minutes? This shows the bot's status on the channel (op, voice, etc.), the channel's modes, and the number of +m/+o/+v/+n/+b/+e/+I users on the channel. A sample status line follows:

[01:40] @#lamest (+istn) : [m/1 o/1 v/4 n/7 b/1 e/5 I/7]

revenge

Remember people who deop/kick/ban the bot, valid ops, or friends and punish them? Users with the +f flag are exempt from revenge.

revengebot

This is similar to to the 'revenge' option, but it only triggers if a bot gets deopped, kicked or banned.

autovoice

Voice users with the +v flag when they join the channel?

secret

Prevent this channel from being listed on the botnet?

shared

Share channel-related user info for this channel?

cycle

Cycle the channel when it has no ops?

dontkickops

Do you want the bot not to be able to kick users who have the +o flag, letting them kick-flood for instance to protect the channel against clone attacks.

inactive

This prevents the bot from joining the channel (or makes it leave the channel if it is already there). It can be useful to make the bot leave a channel without losing its settings, channel-specific user flags, channel bans, and without affecting sharing.

seen

Respond to seen requests in the channel? The seen module must be loaded for this to work.

nodesynch

Allow non-ops to perform channel modes? This can stop the bot from fighting with services such as chanserv, or from kicking IRCops when setting channel modes without having ops.

User Flags

n (owner) - user has absolute control. Only give this flag to people you trust completely.

m (master) - user has access to almost every feature of the bot.

t (botnet-master) - user has access to all features dealing with the botnet.

a (auto-op) - user is opped automatically upon joining a channel.

o (op) - user has op access to all of the bot's channels.

y (auto-halfop) - user is halfopped automatically upon joining a channel.

l (halfop) - user has halfop access to all of the bot's channels.

g (auto-voice) - user is voiced automatically upon joining a channel.

v (voice) - user gets +v automatically on +autovoice channels.

f (friend) - user is not punished for flooding, etc.

p (party) - user has access to the partyline.

q (quiet) - user does not get voice on +autovoice channels.

r (dehalfop) - user cannot gain halfops on any of the bot's channels.

d (deop) - user cannot gain ops on any of the bot's channels.

k (auto-kick) - user is kicked and banned automatically.

x (xfer) -user has access to the file transfer area of the bot (if it exists) and can send and receive files to/from the bot.

j (janitor) - user can perform maintenance in the file area of the bot (if it exists) -- like a "master" of the file area. Janitors have complete access to the filesystem.

c (common) - this marks a user who is connecting from a public site from which any number of people can use IRC. The user will now be recognized by NICKNAME.

b (bot) - user is a bot.

w (wasop-test) - user needs wasop test for +stopnethack procedure.

z (washalfop-test) - user needs washalfop test for +stopnethack procedure.

e (nethack-exempt) - user is exempted from stopnethack protection.

u (unshared) - user record is not sent to other bots.

h (highlight) - use bold text in help/text files.

Extensions / Scripts

Eggdrops can be heavily extended using tcl scripts.

• [Eggdrop Tricks]

Question / Answer

QuakeNet Auth

Need to know how to make your eggdrop auth to Q on QuakeNet?

Check Eggdrop/QuakeAuth

Unleaflike Behaviour

Get botnet disconnects because of "unleaflike behavior" ? It happens when you link 1.6.17 eggdrops to older versions. Read here why and how.

Upgrade all bots to 1.6.17, OR :

chattr all your bots -o and -l
do a .save
set private-globals "l" in your config (that's l as in L, not a one)
give your bots +o for the channel's they need it on 

Misc / News

[ 23 Aug 2004 ]: Eggdrop 1.6.17 released

Links

• http://www.eggheads.org/

• http://www.egghelp.org/

• ftp://ftp.eggheads.org/pub/eggdrop/

• http://www.egghelp.org/files.htm

• http://www.baschny.de/eggdrop/faq/faq-b.html

• The Tao of Eggdrop

IRC support

• To get support via IRC: join #egghelp (eggdrop questions), #eggtcl (scripting questions), #bots (test channel where you can let your bot join) on EfNet.