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