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