/[cvs]/eggdrop1.9/INSTALL
ViewVC logotype

Diff of /eggdrop1.9/INSTALL

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph | View Patch Patch

revision 1.15 by wcc, Thu Dec 11 00:49:10 2003 UTC revision 1.16 by wcc, Thu Dec 11 01:21:48 2003 UTC
# Line 1  Line 1 
1    $Id$
2    
3    Compilation and Installation of Eggdrop
4    Last revised: December 10, 2003
5         _________________________________________________________________
6    
7  Compilation and Installation of Eggdrop  Compilation and Installation of Eggdrop
   ------------------------------------------------------------------------  
8    
9  This is the quick install guide, if you have had little or no experience  
10  with unix or eggdrop, READ THE README FILE NOW! This file is only for    This is the quick install guide; if you have had little or no experience
11      with UNIX or Eggdrop, READ THE README FILE NOW! This file is only for
12  experienced users.  experienced users.
13    
14      Contents:
15        1. What is Eggdrop?
16        2. Compiling Eggdrop 1.7
17    
18    
19  (1) WHAT IS EGGDROP?  (1) WHAT IS EGGDROP?
20    
21       Please, read the file README before attempting to set up this      Please, read the README file before attempting to set up this bot. This
22       bot. It is NOT easy to use! This file is a quick setup guide, not      file is a quick setup guide, not a miracle worker. If you enter this file
23       a miracle worker. If you enter this file without basic eggdrop      without basic Eggdrop knowledge, you will NOT leave with a working bot!
24       knowledge, you will NOT leave with a working bot! Before asking      Before asking ANY questions, READ THE README FILE OR YOU WILL BE BURNED
25       ANY questions, READ THE README FILE OR YOU WILL BE BURNED TO A      TO A HORRIBLE DEATH! IF YOU DO NOT READ THAT FILE I WILL PERSONALLY WALK
26       HORRIBLE DEATH! IF YOU DO NOT READ THAT FILE I WILL PERSONALLY      TO YOUR TERMINAL AND BEAT IT WITH A SMELLY SNEAKER! By the way, read the
27       WALK TO YOUR TERMINAL AND BEAT IT WITH A SMELLY SNEAKER! By the      README file.
28       way, read README.  
29      (2) COMPILING EGGDROP 1.7
30  (2) QUICK STARTUP  
31        The build process will be simplified at a later time. For now, the basic
32       Eggdrop uses the GNU autoconfigure scripts, to make things      steps to compiling Eggdrop 1.7 are as follows.
33       easier.  
34          1. Install the following development tools on your system:
35    1. If you downloaded eggdrop from the CVS repository type './bootstrap' from             autoconf 2.52
36       the eggdrop directory. That script will prepare system configuration             automake 1.5
37       detection's scripts. For a successful run of bootstrap, your system needs             libtool  1.4.2
38       to satisfy some requirements (read bootstrap top contents to know which),  
39       otherwhise you need to get an already bootstrapped package from        2. Create the following symlinks in the Eggdrop 1.7 root directory:
40       ftp://ftp.eggheads.org/pub/eggdrop/source/current/.             ln -s acconfig/mkinstalldirs ./
41       If you don't know of what we are talking about in this step             ln -s configure.ac configure.in
42       it probably means you don't need to run the bootstrap script, so just  
43       ignore this step.        3. Run './bootstrap'.
44    
45    2. Type './configure' from the eggdrop directory.  That script will        4. Run './configure --prefix=<install path>'.
      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.  
      Or to force a statically linked module bot type './configure  
      --disable-shared'.  Otherwise the configure script will determin which  
      type of bot your system will support.  Dynamic is always the better way  
      to go if possible. There is also the option --enable-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. The bot will  
      take a little longer to build and will enlarge the binary a bit, but  
      it's worth if you want to support eggdrop development.  
   
   3. Type 'make' from the eggdrop directory.  
   
   4. Eggdrop must be installed in a directory somewhere.  This is  
      accomplished by entering the unix command:  
   
      make install  
      This will install the eggdrop in your home directory in a directory  
      called eggdrop (i.e. /home/user/eggdrop).  
   
      If you want to install to a different directory make sure you have run  
      './configure --prefix=<directory>' before the make process.  
      Example, if you ran './configure --prefix=/home/user/otherdir',  
      'make install' will install eggdrop in /home/user/otherdir.  
   
      [The following is performed from the directory installed above]  
   
   5. Copy the file 'eggdrop.complete.conf' to a new file, usually the same name  
      as the bot that will use it, e.g. "LamestBot.conf".  
   
   6. Edit your config file LamestBot.conf completely.  
   
   7. Start the bot with the "-m" option to create a user file, ie './eggdrop  
      -m LamestBot.conf'.  
   
   8. When starting the bot in the future, drop the "-m".  If you have  
      edited your bot script correctly, you can type:  
      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 eggdrop.  
   
   9. 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.  
   
  10. 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 seperatly 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 dont wish to be compiled.  Use  
      caution though most of the modules that come with eggdrop the are  
      required.  The exception is woobie.mod -- If you do not want this module  
      it is safe to delete it's directoy.  
   
   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  
      compatiable with the rest of the eggdrop source.  
   
   3. If you wish to add a module at a latter 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.  
   
 (3) FREQUENTLY ASKED QUESTIONS  
   
   1. WHAT DO I DO IF...?  
      READ THE README FILE!  
   
   2. THE README DOES NOT ANSWER...!  
      READ THE README FILE AGAIN!  
   
   3. I still don't know how to....  
      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 Eggheads  
      mailing list http://scrambled.eggheads.org/mailman/listinfo/eggheads  
46    
47  This is the end. If you read to this point, hopefully you have also read        5. Run 'make'.
 the README file. If not, then READ IT!&@#%@!  
48    
49  Have fun with Eggdrop!        6. Run 'make install'.
50      ________________________________________________________________________
51    
   ------------------------------------------------------------------------  
52  Copyright (C) 1997 Robey Pointer  Copyright (C) 1997 Robey Pointer
53  Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004 Eggheads Development Team  Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004 Eggheads Development Team

Legend:
Removed from v.1.15  
changed lines
  Added in v.1.16

webmaster@eggheads.org
ViewVC Help
Powered by ViewVC 1.1.23