QUICK STARTUP:

(1) Edit 'Makefile' to specify your system.  Currently eggdrop is known
    to compile under:
      SunOS, NeXT, Linux, Ultrix, BSD/386(maybe), HP-UX(maybe)
(2) Edit 'src/eggdrop.h' to your liking if you're the hacker type.
(3) Rename 'egg.config.dist' to 'egg.config' and edit -- all the important
    things are specified here.
(4) Type 'make' from this directory.
(5) Run 'eggutil' and choose item 1 (create user file)
(6) To start the bot, just type 'eggdrop' and you're set!

UPGRADING:

--- 0.7j
    rename your 'config' file to 'egg.config'

--- 0.7p
    when you first load up the bot, type:
       .handle ban *ban
       .handle ignore *ignore

--- 0.8
    scan through 'egg.config.dist'; there may be new variable definitions you'd
    like to add to your bot

--- 0.8o
    do a '.match +tf'; the bots you have as "friends" need to become either
    +a (auto-connect), +s (user data sharing), or both: '+auto' & '+share'
    are the commands
    bots that are sharing user data: both bots ought to be upgraded at the
    same time

--- 0.9
    you should probably check the new 'egg.config.dist' file for new things


Type 'make eggdrop' from this directory.


WHAT DO I DO IF I GET THE ERROR "USER FILE NOT FOUND"?

(1) Run 'eggutil' and choose item 1 -- create a user file.
(2) Once your bot is online, add more users via 'hello' or '+user'.


WHAT DO I DO IF I GET A WARNING WHILE COMPILING THAT SAYS "ATOL REDEFINED"?

You must be using gcc.  Just ignore it, the redefinition of atol() is
intentional, because on some crappy BSD/386 systems, atol() is broken.


MY EGGDROP WON'T RUN; IT JUST SAYS "CAN'T FIND YOUR HOSTNAME!"

Your machine is set up strangely, and eggdrop can't figure out its network
hostname.  You can get around this by setting an environment variable called
HOSTNAME.  In sh or ksh:
  $ HOSTNAME=myhost.domain.edu
  $ export HOSTNAME
In csh or tcsh:
  % setenv HOSTNAME myhost.domain.edu
It should work after that.  You may want to bug your system administrator to
set up her /etc/hosts file correctly, or add those above commands to your
'.login' file (sh or ksh: '.profile').


Robey Pointer <robey@ulca10.residence.gatech.edu>



AUTO-RESTART PROGRAM

The auto-restart program I was running on Valis proved to be pretty popular,
so it's now packaged with the bot.  The two files are "botchk" and "autore.c".
The first file is a csh script which checks the machine's process list for
an eggdrop bot running, and if it can't find one, loads eggdrop.  The second
file is in C and needs to be compiled; it listens at telnet port 1974, and,
whenever someone telnets to that port, it runs the csh script.

The csh script MUST BE EDITED FIRST!  You need to change the command line and
directories to point to your bot.  You may also want to edit the C file to
change the telnet port it listens to.  It's not a very user-friendly setup,
so if you're a novice at this stuff, you probably shouldn't try to run the
auto-restart program.

The "botchk" script, by itself, might be a good candidate for your crontab
file.  If you don't know what that is, don't worry about it.


DISTRIBUTION

The latest version of eggdrop code is always available on Valis (irc bot)
in the root dcc directory.  If you do not have file access on Valis, make
sure it knows who you are (/msg it 'hello'), and you should get automatic
file access.  If not, send email to:
   robey@ulca10.residenca.gatech.edu
and I will give you file access.  I like to know who's running the bot, so
please drop me an email sometime!  The code on Valis is guaranteed not to
have any (known) "back doors", etc...  I can't vouch for code you get any-
where else.

A new and beta-testing way to get the bot is to type:
   % telnet maverick.math.uic.edu 1994 | sh
When it's done, you should have a file like 'eggdrop0.9.tar.gz' (or the
lastest version) in your current directory.

I copyright the code, but grant anyone permission to use it, so long as
the copyright notices stay in place.  You may modify the code for your own
purposes in any way you choose, but you may not distribute the bot, or any
entire file of it, after you have modified it.  This is because, even though
I'm sure *most* people are probably better coders than I am, I don't want
any code being spread around with my name on it, that isn't by me.  If you
make handy modifications, distribute them in "patch" format (and send them
to the mailing list while you're at it!).  Oh yeah, the file "reg.c" isn't
by me, so I don't claim any rights to it or anything.  Do what you want to
with that one.


MAILING LIST

The mailing list is defunct.  It was just running of somebody's PC, so it was
really slow anyway.  If anyone wants to volunteer to start a new mailing list,
that would be cool!


WARRANTY

There is none, implied or whatever.  Especially since this is pre-release
stuff.  The bot's not even done yet.  I bet there are *lots* of nasty things
in there that I still have to fix.


DOCUMENTATION

The documentation in the docs/ directory was written during the late creta-
ceous period, and, in many places, has nothing to do with reality.  Nobody
recently has had the patience to write new ones... until Moander came along.
He's hard at work on new docs, and has my undying gratitude for it!  His
email address (for suggestions) is:
   psi@connected.com
In the meantime, I have been trying hard to keep the online documentation (in
the help/ directory) fairly up-to-date.  You can browse around through there
for some handy tips.


robey
                       _
  ___   __ _  __ _  __| |_ __  ___  _ __
 / _ \ / _` |/ _` |/ _` | '__|/ _ \| '_ \
|  __/| (_| | (_| | (_| | |  | (_) | |_) |
 \___| \__, |\__, |\__,_|_|   \___/| .__/
       |___/ |___/                 |_|
