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

Contents of /eggdrop1.6/INSTALL

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


Revision 1.14 - (show 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 Compilation and Installation of Eggdrop
2 Last revised: March 08, 2002
3 ________________________________________________________________________
4
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
9 (1) WHAT IS EGGDROP?
10
11 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 this file without basic Eggdrop knowledge, you will NOT leave with a
14 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
19 (2) QUICK STARTUP
20
21 Eggdrop uses the GNU autoconfigure scripts to make things easier.
22
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
25 correctly compile Eggdrop. It will also try to find Tcl, which is
26 required to compile.
27
28 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
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
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 Eggdrop development.
43
44 4. Eggdrop must be installed in a directory somewhere. This is
45 accomplished by entering the unix command:
46
47 make install
48
49 This will install the Eggdrop in your home directory in a directory
50 called 'eggdrop' (i.e. /home/user/eggdrop).
51
52 If you want to install to a different directory, use:
53
54 make install DEST=<directory>
55
56 For example:
57
58 make install DEST=/home/user/otherdir
59
60 Note that you must use full path for every file to be correctly
61 installed.
62
63 [The following is performed from the directory installed above.]
64
65 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
68 6. Edit your config file completely.
69
70 7. Start the bot with the "-m" option to create a user file, i.e. './eggdrop
71 -m LamestBot.conf'.
72
73 8. When starting the bot in the future, drop the "-m". If you have edited
74 your config file correctly, you can type:
75
76 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
95 (3) MODULES
96
97 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 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 the rest of the Eggdrop source.
106
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 bot.
111
112 (3) FREQUENTLY ASKED QUESTIONS
113
114 (Q) What do I do if...?
115
116 (A) READ THE README FILE!
117
118 (Q) The readme does not answer...!
119
120 (A) READ THE README FILE AGAIN!
121
122 (Q) I still don't know how to...
123
124 (A) MEMORIZE THE README FILE!
125
126 (Q) But...
127
128 (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
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
136 Have fun with Eggdrop!
137
138 ________________________________________________________________________
139
140 Copyright (C) 1997 Robey Pointer
141 Copyright (C) 1999, 2000, 2001, 2002 Eggheads Development Team

webmaster@eggheads.org
ViewVC Help
Powered by ViewVC 1.1.23