Compilation and Installation

This is the quick install guide, if you have had little or no experience with UNIX or Eggdrop, READ THE README FILE NOW! This file is only for experienced users.

Contents

  1. What is Eggdrop?
  2. Quick startup
  3. Modules
  4. Frequently asked questions

1. What is Eggdrop?

Please, read the file README before attempting to set up this bot. It is NOT easy to use! This file is a quick setup guide, not a miracle worker. If you enter this file without basic Eggdrop knowledge, you will NOT leave with a working bot! Before asking ANY questions, READ THE README FILE OR YOU WILL BE BURNED TO A HORRIBLE DEATH! IF YOU DO NOT READ THAT FILE I WILL PERSONALLY WALK TO YOUR TERMINAL AND BEAT IT WITH A SMELLY SNEAKER! By the way, read README.

2. Quick startup

Eggdrop uses the GNU auto configure scripts, to make things easier.

  1. Type './configure' from the Eggdrop directory. That script will determine how your system is set up, and figure out how to compile Eggdrop. It will also try to find Tcl, which is required to compile.

  2. Type 'make' from the Eggdrop directory. Or to force a statically linked module bot type 'make static'. Otherwise the Makefile will determine which type of bot your system will support. Dynamic is always the better way to go if possible. There are also the options debug and sdebug (static-debug) which will give more detailed output on (a highly unlikely :) crash. This might help the devteam to track down the crash and fix the bug. Debug and sdebug will take a little longer to compile and will enlarge the binary a bit, but it's worth if you want to support Eggdrop development.

  3. Eggdrop must be installed in a directory somewhere. This is accomplished by entering the Unix command:

  4. make install DEST="<directory>"
    example make install DEST="/home/egguser/eggdrop"
    (note you must use full path for every file to be correctly installed) [The following is performed from the directory installed above]

  5. Copy the file 'eggdrop.conf.dist' to a new file, usually the same name as the bot that will use it, e.g. "Lamestbot".

  6. Edit your config file Lamestbot completely.

  7. Start the bot with the "-m" option to create a user file, ie 'eggdrop -m Lamestbot'.

  8. When starting the bot in the future, drop the "-m". If you have edited your bot script correctly, you can type:

  9. chmod u+x <my-bot-script-name>
    e.g.
    chmod u+x Lamestbot

    and from then on, you will be able to run your bot directly from the script. So you can just type "Lamestbot" from your shell prompt to start up your bot. For this to work, the top line of your script MUST contain the correct path to the eggdrop binary.

  10. It's advisable to run your bot via crontab so that it will automatically restart if the machine goes down or (heaven forbid) the bot should crash. Look at the file 'scripts/botchk' and 'scripts/autobotchk' for a great start with crontabbing the bot.
  11. Smile, and if you haven't already read the README file in its entirety, go take a long walk off a short pier.

3. Modules

  1. Modules are small pieces of code that can either be compiled into the binary or can be compiled separately in a file. This allows for a much smaller binary and a way of choosing which options you want installed in the bot. Before you compile the bot you can remove any *.mod directory in the src/mod that you don't wish to be compiled. Use caution though most of the modules that come with Eggdrop are required. The exception is woobie.mod and seen.mod. If you do not want these modules it is safe to delete those directories.
  2. If there are any personal modules that you have made or downloaded you can add them to the bot by placing them in the /src/mod directory with a mod extension. They will be automatically compiled during the make for you. They must have a valid make file and of course be compatible with the rest of the Eggdrop source.
  3. If you wish to add a module at a later time follow the same steps in paragraph 2. After you have moved the appropriate files you will only need to type make modules to compile only the modules portion of the bot.

4. Frequently asked questions

  1. What do I do if...?
  2. READ THE README FILE!
  3. The readme does not answer...!
  4. READ THE README FILE AGAIN!
  5. I still don't know how to...
  6. Well, go to www.egghelp.org or www.eggheads.org and see if you can find there what you're looking for. There're also lots of IRC help channels (usually #eggdrop) and various mailing lists. Try the Eggheads mailing list

This is the end. If you read to this point, hopefully you have also read the README file. If not, then READ IT!

Have fun with Eggdrop!

© 1997 Robey Pointer
© 1999,2000 Eggheads