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

Annotation of /eggdrop1.6/INSTALL

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


Revision 1.12 - (hide annotations) (download)
Thu Jan 3 01:05:42 2002 UTC (17 years, 3 months ago) by guppy
Branch: MAIN
Changes since 1.11: +1 -0 lines
added Wcc's latest doc (wasn't sent via email since his stmp is busted)

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

webmaster@eggheads.org
ViewVC Help
Powered by ViewVC 1.1.23