1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!-- $Id: starting.html,v 1.13 2006-03-27 06:48:58 wcc Exp $ -->
<html>
<head>
<title>Eggdrop Documentation: Starting Out</title>
</head>
<body>
<div align="center">
<p><strong>Starting Out</strong></p>
</div>
<hr>
<p>Obviously the first thing you want to do is compile the bot. The
README file tells you what to do and answers some frequently-asked
questions about compiling. If you're in a rush and you know what
you're doing, you don't have to read this at all -- the README
file tells you how to quickly compile and start up the bot.</p>
<p>If you've read this far, then, I'll assume you have
successfully compiled Eggdrop and edited the config file.</p>
<p>First of all, Eggdrop has some command-line options -- not many,
because most things should be defined through the config file. However
sometimes you may want to start up the bot in a different mode, and the
command-line options let you do that. Basically, the command line for
Eggdrop is:</p>
<blockquote>
<p><em>% eggdrop <options> <config-file></em></p>
</blockquote>
<p>The options available are:</p>
<blockquote>
<dl>
<dt><strong>-n</strong></dt>
<dd>
<p>Don't background. Normally Eggdrop will move itself into the
background when you start it up, meaning you'll get another
shell prompt and you can do other things while the bot is going.
With -n, you won't return to the shell prompt until the bot
exits (which won't normally happen until it's killed). By
default, -n will send all log entries to the console.</p>
</dd>
<dt><strong>-nt</strong></dt>
<dd>
<p>Don't background, use terminal. This is just like -n, except
that instead of seeing log entries, your console will simulate a
DCC chat with the bot.</p>
</dd>
<dt><strong>-nc</strong></dt>
<dd>
<p>Don't background, show channel info. This is just like -n,
except that instead of seeing log entries, every 10 seconds your
screen will clear and you will see the current channel status, sort
of like "top".</p>
</dd>
<dt><strong>-m</strong></dt>
<dd>
<p>Create userfile. If you don't have a userfile, this will
make Eggdrop create one, and give master/owner status to the first
person that introduces himself or herself to it. You'll need to
do this when you first set up your bot, and never again.</p>
</dd>
<dt><strong>-h</strong></dt>
<dd>
<p>Show help.</p>
</dd>
<dt><strong>-v</strong></dt>
<dd>
<p>Show version info, then quit.</p>
</dd>
</dl>
</blockquote>
<p>Most people never use any of the options except -m, and you only need
to use that once.</p>
<p>It's <strong> STRONGLY</strong> recommended to run your bot from
its own directory. That way upgrading to a new version is somewhat
painless, and you won't have any troubles from language files and the
like being in the wrong location. You can put your config file and user
file in that directory, and then when you compile a new version of
Eggdrop, you just have to do:</p>
<blockquote>
<p><em>make DEST="directory" install</em></p>
</blockquote>
<p>and it will copy all the necessary files.</p>
<p>The config file that comes with Eggdrop is called
"eggdrop.conf.dist". You need to copy this file to
"eggdrop.conf" and edit that file and change almost everything.
It specifies the bot's nickname, server list, and pretty much
everything else about how your bot will work. You should also rename it
from "eggdrop.conf" to something resembling your bot's
name, for convenience. I call mine "sisko" since my bot is
"Sisko".</p>
<p>You can execute the script to start the bot. For example, I use:</p>
<blockquote>
<p><em>chmod u+x sisko</em></p>
</blockquote>
<p>to make the "sisko" script executable. Then I edited the
first line of the script to say:</p>
<blockquote>
<p><em> #!./eggdrop</em></p>
</blockquote>
<p>which tells the operating system which program to run when executing
this script. (Obviously, it needs to run Eggdrop.) If you're too lazy
to do this, or just don't feel like it, you can still start up your
bot this way:</p>
<blockquote>
<p><em>eggdrop <options> <config-file></em></p>
</blockquote>
<p>For example:</p>
<blockquote>
<em>eggdrop -nt sisko</em>
</blockquote>
<p>After you've edited your config file and set the directories up
the way you want them, start the bot with the -m option. That will make
it create a user file. As soon as you've started up the bot, you need
to go to IRC and introduce yourself to the bot. Typically this is done by
sending it the /msg "hello", although many people change that
greeting to something else (read the config file for more info about
that).</p>
<p>When started with the -m option, the first person to introduce
themselves to the bot will become the master/owner. You want to be that
person. Once you are recognized as the owner, you have full access to the
commands and abilities of the bot.</p>
<hr>
<p><em>Copyright © 1997 Robey Pointer<br>
Copyright © 1999 - 2006 Eggheads Development Team
<a href="http://www.eggheads.org/"> Eggheads Development Team</a></em></p>
</body>
</html>
|