/[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.31 - (show annotations) (download)
Sun Feb 13 14:19:32 2011 UTC (7 years, 9 months ago) by simple
Branch: MAIN
CVS Tags: HEAD
Changes since 1.30: +2 -2 lines
Freshened Copyrights to 2011

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

webmaster@eggheads.org
ViewVC Help
Powered by ViewVC 1.1.23