Skip to content

Commit

Permalink
Update plaintext docs from rst files
Browse files Browse the repository at this point in the history
  • Loading branch information
@vanosg
vanosg committed Jul 17, 2016
1 parent 41b0279 commit 07c2075
Show file tree
Hide file tree
Showing 28 changed files with 5,226 additions and 4,365 deletions.
116 changes: 58 additions & 58 deletions doc/ABOUT
View file
Original file line number Diff line number Diff line change
@@ -1,66 +1,66 @@
About Eggdrop
Last revised: July 27, 2010
_____________________________________________________________________

About Eggdrop


Eggdrop was created around December 1993 to help stop the incessant wars
on #gayteen. It spawned from another bot that was in the process of being
written at the time called "Unrest". The purpose of Unrest was to answer
help requests from other bots. The first public release of Eggdrop was
version 0.6, and since then, it has grown into what you have before you.
About Eggdrop Last revised: July 27, 2010

Eggdrop is the World's most popular Internet Relay Chat (IRC) bot; it is
freely distributable under the GNU General Public License (GPL). Eggdrop
is a feature rich program designed to be easily used and expanded upon by
both novice and advanced IRC users on a variety of hardware and software
platforms.

An IRC bot is a program that sits on an IRC channel and performs automated
tasks while looking just like a normal user on the channel. Some of these
functions include protecting the channel from abuse, allowing privileged
users to gain op or voice status, logging channel events, providing
information, hosting games, etc.

One of the features that makes Eggdrop stand out from other bots is module
and Tcl scripting support. With scripts and modules, you can make the bot
perform almost any task you want. They can do anything from preventing
floods to greeting users and banning advertisers from channels.
About Eggdrop
=============

Eggdrop was created around December 1993 to help stop the incessant
wars on #gayteen. It spawned from another bot that was in the process
of being written at the time called "Unrest". The purpose of Unrest
was to answer help requests from other bots. The first public release
of Eggdrop was version 0.6, and since then, it has grown into what you
have before you.

Eggdrop is the World's most popular Internet Relay Chat (IRC) bot; it
is freely distributable under the GNU General Public License (GPL).
Eggdrop is a feature rich program designed to be easily used and
expanded upon by both novice and advanced IRC users on a variety of
hardware and software platforms.

An IRC bot is a program that sits on an IRC channel and performs
automated tasks while looking just like a normal user on the channel.
Some of these functions include protecting the channel from abuse,
allowing privileged users to gain op or voice status, logging channel
events, providing information, hosting games, etc.

One of the features that makes Eggdrop stand out from other bots is
module and Tcl scripting support. With scripts and modules, you can
make the bot perform almost any task you want. They can do anything
from preventing floods to greeting users and banning advertisers from
channels.

You can also link multiple Eggdrop bots together to form a botnet.
This can allow bots to op each other securely, control floods efficiently,
and even link channels across multiple IRC networks. It also allows the
Eggdrops share user lists, ban lists, exempt/invite lists, and ignore
lists with other bots if userfile sharing is enabled. This allows users
to have the same access on every bot on your botnet. It also allows the
bots to distribute tasks such as opping and banning users. See doc/BOTNET
for information on setting up a botnet.

Eggdrop is always being improved and adjusted because there are bugs to
be fixed and features to be added (if the users demand them, and they
make actually sense). In fact, it existed for several years as v0.7 -
v0.9 before finally going 1.0. This version of Eggdrop is part of the
1.8 tree. A valiant effort has been made to chase down and destroy bugs.
This can allow bots to op each other securely, control floods
efficiently, and even link channels across multiple IRC networks. It
also allows the Eggdrops share user lists, ban lists, exempt/invite
lists, and ignore lists with other bots if userfile sharing is
enabled. This allows users to have the same access on every bot on
your botnet. It also allows the bots to distribute tasks such as
opping and banning users. See doc/BOTNET for information on setting up
a botnet.

Eggdrop is always being improved and adjusted because there are bugs
to be fixed and features to be added (if the users demand them, and
they make actually sense). In fact, it existed for several years as
v0.7 -v0.9 before finally going 1.0. This version of Eggdrop is part
of the 1.8 tree. A valiant effort has been made to chase down and
destroy bugs.

To use Eggdrop, you need:

* Some sort of Unix account

* A pretty good knowledge of IRC and Unix, including how to compile
programs, how to read, and what DCC chat is, at absolute minimum.

* About 5-7 MB of disk space. The Eggdrop tarball is about 5.4 MB
unpacked.

* Tcl -- Eggdrop cannot compile without Tcl installed on your shell.

Before starting, ask yourself if you really need a bot. Most IRC servers
allow only a handful of bots, and some forbid them outright. The reason? Too
many people run bots as "toys" or as a means of destruction. If you want to
use Eggdrop for destructive purposes, go ahead and erase this directory now.
It's almost impossible to do what you want with this bot.

_____________________________________________________________________
- Some sort of Unix account
- A pretty good knowledge of IRC and Unix, including how to
compile programs, how to read, and what DCC chat is, at absolute
minimum.
- About 5-7 MB of disk space. The Eggdrop tarball is about 5.4 MB
unpacked.
- Tcl -- Eggdrop cannot compile without Tcl installed on your
shell.

Before starting, ask yourself if you really need a bot. Most IRC
servers allow only a handful of bots, and some forbid them outright.
The reason? Too many people run bots as "toys" or as a means of
destruction. If you want to use Eggdrop for destructive purposes, go
ahead and erase this directory now. It's almost impossible to do what
you want with this bot.

Copyright (C) 1999 - 2016 Eggheads Development Team
107 changes: 55 additions & 52 deletions doc/BANS
View file
Original file line number Diff line number Diff line change
@@ -1,68 +1,71 @@
Bans, Invites and Exempts
Last revised: March 07, 2002
_____________________________________________________________________
Bans, Invites and Exempts Last revised: March 07, 2002

Bans, Invites, and Exempts
Bans, Invites, and Exempts
==========================

I assume that you know how bans work on IRC. Eggdrop handles bans,
exempts and invites in various ways, and this file is intended to help
clarify how these modes are used within the bot. From here on, 'mode'
applies to all three modes (bans, exempts, and invites) unless
otherwise specified. There are three types of modes:

I assume that you know how bans work on IRC. Eggdrop handles bans, exempts
and invites in various ways, and this file is intended to help clarify how
these modes are used within the bot. From here on, 'mode' applies to all
three modes (bans, exempts, and invites) unless otherwise specified. There
are three types of modes:
Global modes
These modes will be active on every channel the bot monitors.
Some will "expire" after a while (be removed automatically).
Others are considered "permanent" and can only be removed by a
master.

Global modes These modes will be active on every channel the bot
monitors. Some will "expire" after a while (be removed
automatically). Others are considered "permanent" and
can only be removed by a master.
Channel modes
These modes are active only on one channel, and are almost
always temporary modes that expire after an hour or so
(depending on how long you've specified in the config file).
Usually they're created by a Tcl script of some sort.

Channel modes These modes are active only on one channel, and are almost
always temporary modes that expire after an hour or so
(depending on how long you've specified in the config
file). Usually they're created by a Tcl script of some
sort.

Non-bot modes These are modes that were not placed by the bot. They
can be removed by anyone on the channel. The other two
types of modes are protected by the bot (unless the
channel settings specify otherwise), and have to be
removed via the bot.
Non-bot modes
These are modes that were not placed by the bot. They can be
removed by anyone on the channel. The other two types of modes
are protected by the bot (unless the channel settings specify
otherwise), and have to be removed via the bot.

Bans can also be either sticky or unsticky:

Sticky These modes are usually set by a user using the ".stick"
command. Modes with this attribute are attempted to be kept
active on the channel at all times by the bot, even if the
channel is set to use dynamic modes. Obviously, if the channel
isn't set to use dynamic modes, this won't have any effect.
Sticky
These modes are usually set by a user using the ".stick"
command. Modes with this attribute are attempted to be kept
active on the channel at all times by the bot, even if the
channel is set to use dynamic modes. Obviously, if the channel
isn't set to use dynamic modes, this won't have any effect.

Un-sticky These modes are the style that Eggdrop sets by default when
a user uses one of the commands that result in a mode. This
attribute means that the ban will be removed if using dynamic
modes after a certain time. If a mode is "sticky" and you wish
to set it to be "un-sticky", use the ".unstick" command.
Un-sticky
These modes are the style that Eggdrop sets by default when a
user uses one of the commands that result in a mode. This
attribute means that the ban will be removed if using dynamic
modes after a certain time. If a mode is "sticky" and you wish
to set it to be "un-sticky", use the ".unstick" command.

Mode behavior:

Bans If the channel is supporting dynamic bans, then the ban is
set when a user with a matching hostmask joins the channel;
otherwise, the modes are permanently set. On a channel with
dynamic bans, the ban expires after 'ban-time' minutes (which
is specified in the config file).
Bans
If the channel is supporting dynamic bans, then the ban is set
when a user with a matching hostmask joins the channel;
otherwise, the modes are permanently set. On a channel with
dynamic bans, the ban expires after 'ban-time' minutes (which is
specified in the config file).

Exempts If the channel is not supporting dynamic exempts, then they
are set at all times. Otherwise, the exemption is set when a
ban is placed whose host includes that covered by the exempt.
The exempt will remain in place for at least 'exempt-time'
minutes (defined in config file) or until after the
corresponding ban has been removed, whichever happens last.
Exempts
If the channel is not supporting dynamic exempts, then they are
set at all times. Otherwise, the exemption is set when a ban is
placed whose host includes that covered by the exempt. The
exempt will remain in place for at least 'exempt-time' minutes
(defined in config file) or until after the corresponding ban
has been removed, whichever happens last.

Invites If the channel does not support dynamic invites, then they
are set at all times. Otherwise, the invite is set when the
channel is +i and a user requests an invite into the channel.
The invite then remains set for 'invite-time' minutes
(defined in config file) or until the channel goes -i again,
whichever happens last.
_____________________________________________________________________
Invites
If the channel does not support dynamic invites, then they are
set at all times. Otherwise, the invite is set when the channel
is +i and a user requests an invite into the channel. The invite
then remains set for 'invite-time' minutes (defined in config
file) or until the channel goes -i again, whichever happens
last.

Copyright (C) 1999 - 2016 Eggheads Development Team
Loading

0 comments on commit 07c2075

Please sign in to comment.