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

Annotation of /eggdrop1.4/FEATURES

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


Revision 1.1 - (hide annotations) (download)
Wed Jun 23 19:51:22 1999 UTC (20 years, 11 months ago) by segfault
Branch: MAIN
Branch point for: eggdev
Initial revision

1 segfault 1.1 EGGDROP -- AN IRC BOT
2    
3     Eggdrop is the most advanced IRC robot available. It has been under
4     development since December 1993, and, unlike most other bots, it is
5     still regularly updated. Its features include:
6    
7     * completely different channel user lists like having a seperate bot for
8     each channel.
9    
10     * complete channel protection, customizable via config file: permanently
11     store a ban list with comments, etc
12    
13     * user records saved on disk and alterable via dcc chat: each user can
14     have a password (encrypted), a list of valid hostmasks, a set of access
15     flags, etc
16    
17     * the ability to "learn" new users (if you choose to have the bot do so)
18     by letting users /MSG the bot "hello" and granting them automatic access
19     of whatever type you specify (or even no access at all)
20    
21     * a "party line" available through dcc chat or telnet, with multiple
22     channels, giving you the ability to talk to people without being affected
23     by netsplits
24    
25     * console mode: you can view each channel through dcc chat or telnet,
26     selectively looking at mode changes, joins and parts, channel talk, or
27     any combination of the above
28    
29     * a file system where people can upload and download files, in an
30     environment that looks and acts (for the most part) like a typical
31     unix system -- plus the ability to mark directories as hidden/
32     unaccessable to people without certain user flags
33    
34     * bot network: link two or more bots together for a party line that can
35     stretch not only across channels, but across irc networks (one bot on
36     EFnet, one bot on Undernet, etc)
37    
38     * script language: commands and features can be added to the bot on the
39     fly, by means of the TCL script language, giving you the power of TOTAL
40     customization of your bot -- similar to ircII script
41    
42     !!! WARNING !!!
43    
44     Eggdrop is NOT a simple bot to use. It is an advanced bot for people who
45     know IRC and know what they're doing. If you don't know what DCC CHAT is
46     or how to use it -- if you don't know the difference between #channels and
47     &channels -- if you don't know what a clonebot or CTCP avalanche is -- then
48     this bot is not for you. Choose a simpler bot like Vladbot or Baloobot or
49     ComBot, or find one of the many scriptbots to use.
50    
51     This is the 1.3.x branch of the Eggdrop Bot.
52    
53     *** NOTE:
54    
55     This bot is NOT intended for users of very limited MEMORY or DISK
56     shell accounts. The development of this latest design of Eggdrop
57     is geared towards features and flexibility. If you have restraints
58     on the resources allowed to run your bot, then you should instead
59     consider the 1.0 Eggdrop version.
60    
61     ***
62    
63     This latest development of Eggdrop is now compilable in either of two
64     configurations:
65    
66     MODULE - dynamic
67    
68     The MODULE version of Eggdrop 1.3.x provides for the on-the-fly
69     loading of extensions to the bot code without having to recompile
70     the entire bot. This is available on OS platforms which support
71     dynamically linked/shared libraries in their run-time and TCL
72     libraries. It allows for functionality of the bot to be loaded
73     and unloaded at any time.
74    
75     The base loadable modules distributed with this Eggdrop version
76     are:
77     assoc This is the functionality of the `assoc'
78     command for naming party `chat' lines. It
79     also serves as an example for writing your
80     own modules.
81     blowfish The standard Eggdrop encrypting routines
82     for passwords and other encrytions. This
83     can be replaced with a user-written module
84     to perform their own encrypting algorithms.
85     channels This allows eggdrop to have channel info stored
86     and used on that server that you allowed for with
87     the server module.
88     console This provides storage of console settings when you
89     exit the bot (or .store).
90     ctcp This provides the normal ctcp replies that you'd
91     expect.
92     filesys This module performs the file-system
93     operation for DCC file transfers to and from
94     the BOT over via IRC DCC commands.
95     irc This controls all other irc related stuff. Not
96     loading it is the equivalent of the old NO_IRC
97     setting.
98     notes This provides support for storing of notes for
99     users from each other. Notes between currently
100     online users is supported in the core, this is
101     only for storing the notes for later retrieval,
102     direct user->user notes are built-in.
103     seen This provides seen commands via msg, on channel or
104     via dcc, similar to the various scripts.
105     server This allows eggdrop to connect to a server, but
106     that's about it.
107     share This provides the userfile sharing support (this
108     requires the channels & transfer modules).
109     transfer This module performs the bot-to-bot userfile
110     sharing necessary for sharebots. It is
111     loaded automatically when filesys is loaded.
112     wire This provides an encrypted partyline
113     communication.
114     woobie This is a example/skeletal module for writing
115     your own module.
116    
117     MODULE - static
118    
119     The STATIC-MODULE version of Eggdrop 1.3.x is pretty much the same
120     as the module bot, except each individual module is linked into the
121     excutable. You still need to 'loadmodule <module>' to turn them on.
122    
123     See the file doc/MODULES for more specific MODULE information.
124     New to 1.3.0:
125    
126     **** BOTNET
127    
128     Major protocol changes, lots less messages & bytes used.
129    
130     You WILL get double messages if you link OLD<->NEW<->NEW<->OLD
131     (or any number of NEW's between them).
132     To prevent this, have all your new bots on 1 side of the botnet, and
133     all the old ones on the other (although OLD<->NEW<->OLD should be ok).
134    
135     The order of the version and handshake messages has reversed this means
136     on a new botlink between an OLD & a NEW, but you must .link from the OLD
137     or the NEW wont know the password.
138    
139     **** USERLIST
140    
141     If you want to have the option of going back to an old version SAVE your
142     userlist!! This is a new version userlist, and it's not backwards
143     compatible once written (it can still READ old userlists take note).
144    
145     **** FLAGS
146    
147     Flags have multiplied & split up: normal user/channel flags still exist
148     and are setable by .chattr. You can also now use .chattr +o|-o #channel.
149     New are the "user-defined" flags which are all of A-Z for users & channels.
150     Also, bot attributes are seperated now and are set using .botattr.
151     Bots have "user-defined" flags 0-9.
152     The old 0-9 user defined flags will be converted to A-J when you upgrade your
153     userfile.
154    
155     **** SHARING
156    
157     *BIG CHANGE* well, big in use, small in code ;)
158    
159     There are now 2 sharing flags, +p = passive share, +s = aggressive share.
160     Your bot will only accept sharing with passively with 1 bot at a time,
161     although any number of aggressive shares is fine.
162    
163     Consider the botnet:
164    
165     HubBotA
166     |-+LeafBotA
167     `-+HubBotB
168     |-+LeafBotB
169     `-or `-+LeafBotC
170    
171     Flags would be set as such:
172    
173     HubBotA has:
174     LeafBotA: +sl
175     HubBotB : +s
176     LeafBotC: +sl
177     LeafBotA has:
178     HubBotA : +ph
179     HubBotB has:
180     LeafBotB: +sl
181     LeafBotC: +sl
182     LeafBotB has:
183     HubBotB : +ph
184     LeafBotC has:
185     HubBotB : +ph
186     HubBotA : +ph
187    
188     how's that look? :)
189     **** Installation
190    
191     Putegg has been relegated to the obsolete/ directory. Use
192     make install DEST=<directory>
193     now.

webmaster@eggheads.org
ViewVC Help
Powered by ViewVC 1.1.23