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

Diff of /eggdrop1.6/INSTALL

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

revision 1.10 by guppy, Wed Nov 28 23:26:05 2001 UTC revision 1.11 by guppy, Wed Jan 2 03:46:32 2002 UTC
# Line 1  Line 1 
1  Compilation and Installation of Eggdrop  Compilation and Installation of Eggdrop
2    ------------------------------------------------------------------------    ________________________________________________________________________
3    
4  This is the quick install guide, if you have had little or no experience  This is the quick install guide, if you have had little or no experience
5  with unix or eggdrop, READ THE README FILE NOW! This file is only for  with unix or eggdrop, READ THE README FILE NOW! This file is only for
# Line 7  experienced users. Line 7  experienced users.
7    
8  (1) WHAT IS EGGDROP?  (1) WHAT IS EGGDROP?
9    
10       Please, read the file README before attempting to set up this       Please, read the README file before attempting to set up this bot.
11       bot. It is NOT easy to use! This file is a quick setup guide, not       It is NOT easy to use! This file is a quick setup guide, not a miracle
12       a miracle worker. If you enter this file without basic eggdrop       worker. If you enter this file without basic eggdrop knowledge, you
13       knowledge, you will NOT leave with a working bot! Before asking       will NOT leave with a working bot! Before asking ANY questions, READ
14       ANY questions, READ THE README FILE OR YOU WILL BE BURNED TO A       THE README FILE OR YOU WILL BE BURNED TO A HORRIBLE DEATH! IF YOU DO
15       HORRIBLE DEATH! IF YOU DO NOT READ THAT FILE I WILL PERSONALLY       NOT READ THAT FILE I WILL PERSONALLY WALK TO YOUR TERMINAL AND BEAT IT
16       WALK TO YOUR TERMINAL AND BEAT IT WITH A SMELLY SNEAKER! By the       WITH A SMELLY SNEAKER! By the way, read the README file.
      way, read README.  
17    
18  (2) QUICK STARTUP  (2) QUICK STARTUP
19    
20       Eggdrop uses the GNU autoconfigure scripts, to make things       Eggdrop uses the GNU autoconfigure scripts to make things easier.
      easier.  
21    
22    1. Type './configure' from the eggdrop directory.  That script will    1. Type './configure' from the eggdrop directory. The configure script
23       determine how your system is set up, and figure out how to compile       will determine how your system is set up and figure out how to correctly
24       eggdrop.  It will also try to find Tcl, which is required to compile.       compile eggdrop. It will also try to find Tcl, which is required to
25         compile.
26    
27    2. Type either 'make config' or 'make iconfig' to determine which modules    2. Type either 'make config' or 'make iconfig' to determine which modules
28       will be compiled.  'make config' creates the default modules.  If you       will be compiled. 'make config' compiles the default modules (everything
29       want to choose which modules to make use 'make iconfig'.       but woobie.mod). If you want to choose which modules to compile, use
30         'make iconfig'.
31    3. Type 'make' from the eggdrop directory.  Or to force a statically  
32       linked module bot type 'make static'.  Otherwise the Makefile will    3. Type 'make' from the eggdrop directory, or, to force a statically
33       determine which type of bot your system will support.  Dynamic is always       linked module bot, type 'make static'. Otherwise, the Makefile will
34       the better way to go if possible. There're also the options debug and       compile whatever type of bot the configure script determined your
35       sdebug (static-debug) which will give more detailed output on (a       system will support. Dynamic is always the better way to go if possible.
36       highly unlikely :) crash. This might help the devteam to track down       There are also the 'debug' and 'sdebug' (static-debug) options, which
37       the crash and fix the bug. Debug and sdebug will take a little longer       will give more detailed output on a (highly unlikely :) crash. This
38       to compile and will enlarge the binary a bit, but it's worth if you       will help the devteam track down the crash and fix the bug. Debug and
39       want to support eggdrop development.       sdebug will take a little longer to compile and will enlarge the binary
40         a bit, but it's worth it if you want to support eggdrop development.
41    
42    4. Eggdrop must be installed in a directory somewhere.  This is    4. Eggdrop must be installed in a directory somewhere.  This is
43       accomplished by entering the unix command:       accomplished by entering the unix command:
44    
45       make install       make install
46    
47       This will install the eggdrop in your home directory in a directory       This will install the eggdrop in your home directory in a directory
48       called eggdrop (i.e. /home/user/eggdrop).       called eggdrop (i.e. /home/user/eggdrop).
49    
50       If you want to install to a different directory use:       If you want to install to a different directory, use:
51    
52       make install DEST=<directory>       make install DEST=<directory>
      example make install DEST=/home/user/otherdir  
      (note you must use full path for every file to be correctly installed)  
53    
54       [The following is performed from the directory installed above]       For example: make install DEST=/home/user/otherdir
55         Note you must use full path for every file to be correctly installed.
56    
57         [The following is performed from the directory installed above.]
58    
59    5. Copy the file 'eggdrop.complete.conf' to a new file, usually the same name    5. Copy the file 'eggdrop.complete.conf' to a new file, usually the same name
60       as the bot that will use it, e.g. "LamestBot.conf".       as the bot that will use it, e.g. "LamestBot.conf".
61    
62    6. Edit your config file LamestBot.conf completely.    6. Edit your config file completely.
63    
64    7. Start the bot with the "-m" option to create a user file, i.e. './eggdrop    7. Start the bot with the "-m" option to create a user file, i.e. './eggdrop
65       -m LamestBot.conf'.       -m LamestBot.conf'.
66    
67    8. When starting the bot in the future, drop the "-m".  If you have    8. When starting the bot in the future, drop the "-m". If you have edited
68       edited your bot script correctly, you can type:       your config file correctly, you can type: chmod u+x <my-config-file-name>
69       chmod u+x <my-bot-script-name>       For example: chmod u+x LamestBot.conf
      e.g.  
      chmod u+x LamestBot  
70    
71       and from then on, you will be able to run your bot directly from the       From then on, you will be able to use your config file as a shell
72       script.  So you can just type "LamestBot" from your shell prompt to       script. You can just type "./LamestBot.conf" from your shell prompt to
73       start up your bot.  For this to work, the top line of your script MUST       start up your bot.  For this to work, the top line of your script MUST
74       contain the correct path to eggdrop.       contain the correct path to the Eggdrop executable.
75    
76    9. It's advisable to run your bot via crontab so that it will    9. It's advisable to run your bot via crontab, so that it will
77       automatically restart if the machine goes down or (heaven forbid) the       automatically restart if the machine goes down or (heaven forbid) the
78       bot should crash. Look at the file 'scripts/botchk' and       bot should crash. Look at 'scripts/botchk' and 'scripts/autobotchk'
79       'scripts/autobotchk' for a great start with crontabbing the bot.       for a great start with crontabbing the bot.
80    
81   10. Smile, and if you haven't already read the README file in its   10. Smile, and if you haven't already read the README file in its
82       entirety, go take a long walk off a short pier.       entirety, go take a long walk off a short pier.
83    
84  (3) MODULES  (3) MODULES
85    
86    1. Modules are small pieces of code that can either be compiled into the       Modules are small pieces of code that can either be compiled into the
87       binary or can be compiled separately in a file.  This allows for a much       binary or can be compiled separately into a file. This allows for a much
88       smaller binary and a way of choosing which options you want installed       smaller binary.
89       in the bot.  Before you compile the bot you can remove any *.mod  
90       directory in the src/mod that you don't wish to be compiled.  Use       If there are any modules that you have made or downloaded, you can add
91       caution though most of the modules that come with eggdrop the are       them to the bot by placing them in the /src/mod directory with a mod
92       required.  The exception is woobie.mod and seen.mod.  If you do not       extension. They will be automatically compiled during make for you.
93       want these modules it is safe to delete those directories.       They must have a valid Makefile and, of course, be compatible with
94         the rest of the eggdrop source.
95    2. If there are any personal modules that you have made or downloaded you  
96       can add them to the bot by placing them in the /src/mod directory with       If you wish to add a module at a later time, follow the same steps in
97       a mod extension.  They will be automatically compiled during the make       paragraph 2. After you have moved the appropriate files, you will only
98       for you.  They must have a valid make file and of course be       need to type 'make modules' to compile only the modules portion of the
      compatible 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  
99       bot.       bot.
100    
101  (3) FREQUENTLY ASKED QUESTIONS  (3) FREQUENTLY ASKED QUESTIONS
102    
103    1. WHAT DO I DO IF...?      (Q) What do I do if...?
104       READ THE README FILE!  
105        (A) READ THE README FILE!
106    
107        (Q) The readme does not answer...!
108    
109    2. THE README DOES NOT ANSWER...!      (A) READ THE README FILE AGAIN!
      READ THE README FILE AGAIN!  
110    
111    3. I still don't know how to....      (Q) I still don't know how to...
112       Well, go to www.egghelp.org or www.eggheads.org and see if you can  
113       find there what you're looking for. There're also lots of IRC help      (A) MEMORIZE THE README FILE!
114       channels (usually #eggdrop) and various mailing lists. Try Eggheads  
115       mailing list http://scrambled.eggheads.org/mailman/listinfo/eggheads      (Q) But...</p>
116    
117        (A) Well, go to www.egghelp.org or www.eggheads.org and see if you can
118            find there what you&#39;re looking for. There are also lots of IRC
119            help channels and various mailing lists, as seen in the README FILE.
120    
121  This is the end. If you read to this point, hopefully you have also read  This is the end. If you read to this point, hopefully you have also read
122  the README file. If not, then READ IT!&@#%@!  the README file. If not, then READ IT!&@#%@!
123    
124  Have fun with Eggdrop!  Have fun with Eggdrop!
125    
126    ------------------------------------------------------------------------    ________________________________________________________________________
127    
128  Copyright (C) 1997 Robey Pointer  Copyright (C) 1997 Robey Pointer
129  Copyright (C) 1999, 2000, 2001 Eggheads Development Team  Copyright (C) 1999, 2000, 2001, 2002 Eggheads Development Team

Legend:
Removed from v.1.10  
changed lines
  Added in v.1.11

webmaster@eggheads.org
ViewVC Help
Powered by ViewVC 1.1.23