/[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.1 - (show annotations) (download)
Mon Sep 13 14:18:32 1999 UTC (19 years, 9 months ago) by segfault
Branch: MAIN
Initial stuff (.29 cvs)

1 _
2 ___ __ _ __ _ __| |_ __ ___ _ __
3 / _ \ / _` |/ _` |/ _` | '__|/ _ \| '_ \
4 | __/| (_| | (_| | (_| | | | (_) | |_) |
5 \___| \__, |\__, |\__,_|_| \___/| .__/
6 |___/ |___/ |_| v1.3
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 aways the better way to go if possible. And for the brave with
35 off the wall operating systems you can type 'make eggmod' but be
36 warned that it might not work. If it does please contact the dev
37 team and let them know it did or/and what you did to make it work.
38
39 3. Eggdrop must be installed in a directory somewhere. This is
40 accomplished by entering the unix command:
41 make install DEST=<directory>
42 example make install DEST=/home/egguser/eggdrop
43
44 [The following is performed from the directory installed above]
45
46 4. Copy the file 'eggdrop.conf.dist' to a new file, usually the
47 same name as the bot that will use it, e.g. "LamestBot".
48
49 5. Start the bot with the "-m" option to create a user file, ie
50 'eggdrop -m LamestBot'.
51
52 6. When starting the bot in the future, drop the "-m". If you have
53 edited your bot script correctly, you can type:
54 chmod u+x <my-bot-script-name>
55 e.g.
56 chmod u+x LamestBot
57 and from then on, you will be able to run your bot directly from the
58 script. So you can just type "LamestBot" from your shell prompt to
59 start up your bot. For this to work, the top line of your script MUST
60 contain the correct path to eggdrop.
61
62 7. It's advisable to run your bot via crontab so that it will automatic-
63 ally restart if the machine goes down or (heaven forbid) the bot
64 should crash. Look at the file 'scripts/botchk' for a great start
65 with crontabbing the bot.
66
67 8. Smile, and if you haven't already read the README file in its
68 entirety, go take a long walk off a short pier.
69
70
71 (3) MODULES
72
73 1. Modules are small pieces of code that can either be compiled into
74 the binary or can be compiled seperatly in a file. This allows for a much
75 smaller binary and a way of choosing which options you want installed in
76 the bot. Before you compile the bot you can remove any *.mod directory in
77 the src/mod that you dont wish to be compiled. Use caution though most of
78 the modules that come with eggdrop the are required. The exception is
79 woobie.mod and seen.mod. If you do not want these modules it is safe
80 to delete those directories.
81
82 2. If there are any personal modules that you have made or downloaded
83 you can add them to the bot by placing them in the /src/mod directory with
84 a mod extension. They will be automatically compiled during the make for
85 you. They must have a valid make file and of course be compatiable with
86 the rest of the eggdrop source.
87
88 3. If you wish to add a module at a latter time follow the same steps
89 in paragraph 2. After you have moved the appropriate files you will only
90 need to type make modules to compile only the modules portion of the bot.
91
92
93 (3) FREQUENTLY ASKED QUESTIONS
94
95 1. WHAT DO I DO IF...?
96
97 (1a) READ THE README FILE!
98
99 This is the end. If you read to this point, hopefully you have also read
100 the README file. If not, then READ IT!&@#%@!

webmaster@eggheads.org
ViewVC Help
Powered by ViewVC 1.1.23