/[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.16 - (show annotations) (download)
Thu Jun 6 18:15:51 2002 UTC (16 years, 10 months ago) by wcc
Branch: MAIN
CVS Tags: v2_0, eggdrop1_6_11
Changes since 1.15: +97 -91 lines
Ok.. this is all.. :P

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

webmaster@eggheads.org
ViewVC Help
Powered by ViewVC 1.1.23