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

webmaster@eggheads.org
ViewVC Help
Powered by ViewVC 1.1.23