Eggdrop Documentation: Starting Out

Starting Out

Obviously the first thing you want to do is compile the bot. The README file tells you what to do and answers some frequently-asked questions about compiling. If you're in a rush and you know what you're doing, you don't have to read this at all -- the README file tells you how to quickly compile and start up the bot.

If you've read this far, then, I'll assume you have successfully compiled Eggdrop and edited the config file.

First of all, Eggdrop has some command-line options -- not many, because most things should be defined through the config file. However sometimes you may want to start up the bot in a different mode, and the command-line options let you do that. Basically, the command line for Eggdrop is:

> % eggdrop <options> <config-file>

The options available are:

> -n

>   Don't background. Normally Eggdrop will move itself into the background when you start it up, meaning you'll get another shell prompt and you can do other things while the bot is going. With -n, you won't return to the shell prompt until the bot exits (which won't normally happen until it's killed). By default, -n will send all log entries to the console.

> -nt

>   Don't background, use terminal. This is just like -n, except that instead of seeing log entries, your console will simulate a DCC chat with the bot.

> -nc

>   Don't background, show channel info. This is just like -n, except that instead of seeing log entries, every 10 seconds your screen will clear and you will see the current channel status, sort of like "top".

> -m

>   Create userfile. If you don't have a userfile, this will make Eggdrop create one, and give master/owner status to the first person that introduces himself or herself to it. You'll need to do this when you first set up your bot, and never again.

> -h

>   Show help.

> -v

>   Show version info, then quit.

Most people never use any of the options except -m, and you only need to use that once.

It's STRONGLY recommended to run your bot from its own directory. That way upgrading to a new version is somewhat painless, and you won't have any troubles from language files and the like being in the wrong location. You can put your config file and user file in that directory, and then when you compile a new version of Eggdrop, you just have to do:

> make DEST="directory" install

and it will copy all the necessary files.

The config file that comes with Eggdrop is called "eggdrop.conf.dist". You need to copy this file to "eggdrop.conf" and edit that file and change almost everything. It specifies the bot's nickname, server list, and pretty much everything else about how your bot will work. You should also rename it from "eggdrop.conf" to something resembling your bot's name, for convenience. I call mine "sisko" since my bot is "Sisko".

You can execute the script to start the bot. For example, I use:

> chmod u+x sisko

to make the "sisko" script executable. Then I edited the first line of the script to say:

> #!./eggdrop

which tells the operating system which program to run when executing this script. (Obviously, it needs to run Eggdrop.) If you're too lazy to do this, or just don't feel like it, you can still start up your bot this way:

> eggdrop <options> <config-file>

For example:

> eggdrop -nt sisko

After you've edited your config file and set the directories up the way you want them, start the bot with the -m option. That will make it create a user file. As soon as you've started up the bot, you need to go to IRC and introduce yourself to the bot. Typically this is done by sending it the /msg "hello", although many people change that greeting to something else (read the config file for more info about that).

When started with the -m option, the first person to introduce themselves to the bot will become the master/owner. You want to be that person. Once you are recognized as the owner, you have full access to the commands and abilities of the bot.

Copyright © 1997 Robey Pointer
Copyright © 1999 - 2006 Eggheads Development Team Eggheads Development Team