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

Contents of /eggdrop1.4/INSTALL

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


Revision 1.3 - (show annotations) (download)
Wed Jan 12 20:43:21 2000 UTC (20 years, 5 months ago) by per
Branch: MAIN
CVS Tags: eggdrop10403RC1, eggdrop10402RC1, eggdrop10402
Changes since 1.2: +32 -11 lines
install and faq patch by wictor

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

webmaster@eggheads.org
ViewVC Help
Powered by ViewVC 1.1.23