/[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.14 - (hide annotations) (download)
Tue Jun 4 05:11:10 2002 UTC (16 years, 10 months ago) by wcc
Branch: MAIN
Changes since 1.13: +9 -9 lines
More doc updates..

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

webmaster@eggheads.org
ViewVC Help
Powered by ViewVC 1.1.23