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

Contents of /eggdrop1.9/INSTALL

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


Revision 1.7 - (show annotations) (download)
Wed Jul 18 14:12:02 2001 UTC (18 years ago) by guppy
Branch: MAIN
CVS Tags: eggdrop1_6_6
Changes since 1.6: +21 -11 lines
applied Paladin's doc updates patch

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

webmaster@eggheads.org
ViewVC Help
Powered by ViewVC 1.1.23