/[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.10 - (hide annotations) (download)
Wed Oct 10 13:15:58 2001 UTC (17 years, 7 months ago) by tothwolf
Branch: MAIN
Changes since 1.9: +2 -2 lines
documentation and misc updates from alpha tree

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

webmaster@eggheads.org
ViewVC Help
Powered by ViewVC 1.1.23