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

Contents of /eggdrop1.6/FEATURES

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


Revision 1.10 - (show annotations) (download)
Wed Jan 2 03:46:32 2002 UTC (17 years, 9 months ago) by guppy
Branch: MAIN
Changes since 1.9: +5 -3 lines
added Wcc's even_more_docs patch

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

webmaster@eggheads.org
ViewVC Help
Powered by ViewVC 1.1.23