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

Annotation of /eggdrop1.9/INSTALL

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


Revision 1.15 - (hide annotations) (download)
Thu Dec 11 00:49:10 2003 UTC (15 years, 10 months ago) by wcc
Branch: MAIN
Changes since 1.14: +1 -1 lines
* 2004 copyright.

1 fabian 1.3 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 segfault 1.1
8     (1) WHAT IS EGGDROP?
9    
10 fabian 1.3 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 segfault 1.1
19     (2) QUICK STARTUP
20    
21 fabian 1.3 Eggdrop uses the GNU autoconfigure scripts, to make things
22     easier.
23 segfault 1.1
24 ite 1.9 1. If you downloaded eggdrop from the CVS repository type './bootstrap' from
25     the eggdrop directory. That script will prepare system configuration
26 ite 1.11 detection's scripts. For a successful run of bootstrap, your system needs
27     to satisfy some requirements (read bootstrap top contents to know which),
28     otherwhise you need to get an already bootstrapped package from
29     ftp://ftp.eggheads.org/pub/eggdrop/source/current/.
30     If you don't know of what we are talking about in this step
31 ite 1.9 it probably means you don't need to run the bootstrap script, so just
32     ignore this step.
33    
34     2. Type './configure' from the eggdrop directory. That script will
35 fabian 1.3 determine how your system is set up, and figure out how to compile
36     eggdrop. It will also try to find Tcl, which is required to compile.
37 ite 1.11 Or to force a statically linked module bot type './configure
38     --disable-shared'. Otherwise the configure script will determin which
39     type of bot your system will support. Dynamic is always the better way
40     to go if possible. There is also the option --enable-debug which will
41     give more detailed output on (a highly unlikely :) crash. This might
42     help the devteam to track down the crash and fix the bug. The bot will
43     take a little longer to build and will enlarge the binary a bit, but
44     it's worth if you want to support eggdrop development.
45 fabian 1.3
46 ite 1.11 3. Type 'make' from the eggdrop directory.
47 fabian 1.3
48 ite 1.11 4. Eggdrop must be installed in a directory somewhere. This is
49 fabian 1.3 accomplished by entering the unix command:
50    
51 guppy 1.7 make install
52     This will install the eggdrop in your home directory in a directory
53 ite 1.12 called eggdrop (i.e. /home/user/eggdrop).
54 guppy 1.7
55 ite 1.11 If you want to install to a different directory make sure you have run
56     './configure --prefix=<directory>' before the make process.
57     Example, if you ran './configure --prefix=/home/user/otherdir',
58     'make install' will install eggdrop in /home/user/otherdir.
59 fabian 1.3
60     [The following is performed from the directory installed above]
61    
62 ite 1.11 5. Copy the file 'eggdrop.complete.conf' to a new file, usually the same name
63 guppy 1.7 as the bot that will use it, e.g. "LamestBot.conf".
64 fabian 1.3
65 ite 1.11 6. Edit your config file LamestBot.conf completely.
66 fabian 1.3
67 ite 1.11 7. Start the bot with the "-m" option to create a user file, ie './eggdrop
68 guppy 1.7 -m LamestBot.conf'.
69 fabian 1.3
70 ite 1.11 8. When starting the bot in the future, drop the "-m". If you have
71 fabian 1.3 edited your bot script correctly, you can type:
72     chmod u+x <my-bot-script-name>
73     e.g.
74     chmod u+x LamestBot
75    
76     and from then on, you will be able to run your bot directly from the
77     script. So you can just type "LamestBot" from your shell prompt to
78     start up your bot. For this to work, the top line of your script MUST
79     contain the correct path to eggdrop.
80    
81 ite 1.11 9. It's advisable to run your bot via crontab so that it will
82 fabian 1.3 automatically restart if the machine goes down or (heaven forbid) the
83     bot should crash. Look at the file 'scripts/botchk' and
84     'scripts/autobotchk' for a great start with crontabbing the bot.
85 segfault 1.1
86 ite 1.11 10. Smile, and if you haven't already read the README file in its
87 fabian 1.3 entirety, go take a long walk off a short pier.
88 segfault 1.1
89     (3) MODULES
90    
91 fabian 1.3 1. Modules are small pieces of code that can either be compiled into the
92     binary or can be compiled seperatly in a file. This allows for a much
93     smaller binary and a way of choosing which options you want installed
94     in the bot. Before you compile the bot you can remove any *.mod
95     directory in the src/mod that you dont wish to be compiled. Use
96     caution though most of the modules that come with eggdrop the are
97 guppy 1.8 required. The exception is woobie.mod -- If you do not want this module
98     it is safe to delete it's directoy.
99 fabian 1.3
100     2. If there are any personal modules that you have made or downloaded you
101     can add them to the bot by placing them in the /src/mod directory with
102     a mod extension. They will be automatically compiled during the make
103     for you. They must have a valid make file and of course be
104     compatiable with the rest of the eggdrop source.
105    
106     3. If you wish to add a module at a latter time follow the same steps in
107     paragraph 2. After you have moved the appropriate files you will only
108     need to type make modules to compile only the modules portion of the
109     bot.
110 segfault 1.1
111 fabian 1.3 (3) FREQUENTLY ASKED QUESTIONS
112 segfault 1.1
113 fabian 1.3 1. WHAT DO I DO IF...?
114     READ THE README FILE!
115 segfault 1.1
116 fabian 1.3 2. THE README DOES NOT ANSWER...!
117     READ THE README FILE AGAIN!
118 segfault 1.1
119 fabian 1.3 3. I still don't know how to....
120     Well, go to www.egghelp.org or www.eggheads.org and see if you can
121     find there what you're looking for. There're also lots of IRC help
122 tothwolf 1.10 channels (usually #eggdrop) and various mailing lists. Try Eggheads
123     mailing list http://scrambled.eggheads.org/mailman/listinfo/eggheads
124 segfault 1.1
125     This is the end. If you read to this point, hopefully you have also read
126     the README file. If not, then READ IT!&@#%@!
127 fabian 1.3
128     Have fun with Eggdrop!
129    
130     ------------------------------------------------------------------------
131 guppy 1.6 Copyright (C) 1997 Robey Pointer
132 wcc 1.15 Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004 Eggheads Development Team

webmaster@eggheads.org
ViewVC Help
Powered by ViewVC 1.1.23