/[cvs]/botnetop.mod/README
ViewVC logotype

Contents of /botnetop.mod/README

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


Revision 1.11 - (show annotations) (download)
Sat Nov 11 17:40:50 2000 UTC (18 years, 7 months ago) by sup
Branch: MAIN
Changes since 1.10: +236 -236 lines
1.0.0 release

1 _
2 | |__ ___ _____ _ __ ___ _____ ___ _ __
3 | ยด_ \ / _ \|_ _| `_ \/ _ \|_ _|/ _ \| '_ \
4 | |_) | (_) | | | | | | | __/ | | | (_) | |_) |
5 |_.__/ \___/ |_| |_| |_|\___| |_| \___/| .__/
6 |_| v1.0
7
8 by Teemu Hjelt <temex@iki.fi>
9
10
11 At least glance over this document before doing anything with
12 botnetop.mod. If you don't have earlier experiences of eggdrop
13 modules you should read this file through very carefully.
14
15
16 Table of Contents
17 ==================
18
19 1. Introduction
20 2. Installation
21 3. FAQ
22 4. Tcl commands
23 5. Tcl variables
24 6. Feedback
25 7. Latest version
26 8. Credits
27 9. License
28
29
30 1. Introduction
31 ================
32
33 botnetop.mod is based on botnetop.tcl written by slennox and was written in C from
34 scratch by Teemu Hjelt. botnetop.mod allows linked bots to request and give ops to
35 each other. It can also invite linked bots to invite-only channels, share keys with
36 them, raise channels' limits and unban them. botnetop.mod is fully compatible with
37 the botnetop.tcl script and the netbots.tcl's botnetop.tcl component (you can even
38 use your netset.tcl to configure botnetop.mod). In addition you can use other botnet
39 opping scripts (e.g, getops.tcl) simultaneously with botnetop.mod.
40
41
42 2. Installation
43 ================
44
45 botnetop.mod requires at least eggdrop 1.5.4 (1.6.0 or better recommended)
46 and you need to have the irc, the server and the channel modules loaded.
47 You also need the source code of eggdrop to compile the module.
48
49 1. Go to the directory where you have the eggdrop source code.
50 (Normally the directory where you have extracted the eggdrop tarball)
51 2. Go to src/mod/ directory and copy the botnetop.mod tarball there.
52 3. Type "tar zxvf botnetop.mod-x.x.x.tar.gz"
53 (If that doesn't work type first "gzip -d botnetop.mod-x.x.x.tar.gz"
54 and then "tar -xvf botnetop.mod-x.x.x.tar")
55 4. Configure and compile eggdrop like you would normally do it.
56 (e.g, ./configure ; make config ; make ; make install)
57
58 All botnetop.mod settings can be found in the botnetop.conf file.
59 You can either copy it to your eggdrop directory, edit it to fit
60 your needs and then add line "source botnetop.conf" to your eggdrop
61 config file or you can just copy the contents of the file to your
62 eggdrop config file. If you want to use the default settings all you
63 need to do is to add line "loadmodule botnetop" to your eggdrop config
64 file. The last thing is to (re)start or rehash your bot and hope for
65 the best :)
66
67
68 3. FAQ
69 =======
70
71 1. Q: Are you ever going to make the module compatible with 1.4 serie?
72
73 A: Probably not, because 1.4 serie is lacking the need bindings
74 and tandbot isn't exported for modules. I've planned to make
75 a patch for 1.4 that exports tandbot for modules but I don't
76 know whether I'm going to carry it out or not.
77
78 2. Q: I get "`H_need' undeclared (first use in this function)" or
79 "`tandbot' undeclared (first use this function)" everytime I
80 try to compile eggdrop with botnetop.mod. What should I do?
81
82 Q: When trying to load the module I get "botnetop: Error loading
83 module: /home/foobar/eggdrop/modules/botnetop.so: undefined symbol:
84 tandbot". How can I fix this?
85
86 A: These two errors are caused because you have too old version of eggdrop
87 that doesn't have support for need bindings and doesn't export tandbot
88 for modules. You need at least eggdrop 1.5.4 to use botnetop.mod.
89
90 3. Q: I often get messages like "botnetop.mod: new delay record created
91 for #foobar (address: 135705504)". What do they mean?
92
93 A: They are special debugging messages that help me track bugs in
94 memory allocating and freeing. They are nothing serious and if
95 you don't want to see them anymore, type ".console -d" on the
96 partyline.
97
98 4. Q: Are you going to add support for language files?
99
100 A: Maybe. I've planned to carry out it as soon as the development
101 team decides what kind of language file format they will use in
102 the future releases.
103
104 5. Q: Are you going to make botnetop.mod compatible with getops.tcl
105 and/or other similar scripts?
106
107 A: I have thought about it. I'm not sure yet how I should do it
108 because I wouldn't like to make botnetop.mod more bloated
109 than it currently is.
110
111 6. Q: Can I get botnetop.mod for windrops?
112
113 A: Yes, if you compile it yourself in Cygwin. I have never tested
114 how the module works under Windows so I can't offer any kind of
115 support.
116
117 7. Q: What kind of versioning policy are you using?
118
119 A: Version 1.0.0 is the first stable version that should be very much
120 alike with botnetop.tcl. The 1.0 tree is intended for fixing bugs
121 in 1.0.0. When I'm satisfied with the 1.0 serie I will start a new
122 1.1 serie which is intended for adding new features and fixing flaws
123 in botnetop.tcl.
124
125 8. Q: My bot crashed. What should I do?
126
127 A: Check the BUG-REPORT file in your bot's doc/ directory and follow
128 the instructions given. Instead of just sending the bug-report to
129 eggheads@eggheads.org send it also to temex@iki.fi.
130
131
132 4. Tcl commands
133 ================
134
135 There are currently two Tcl commands:
136
137 bop_reqop <channel>
138 Makes the bot request ops for <channel> from
139 bots who are currently opped and linked.
140
141 bop_letmein <needthis> <channel>
142 Makes the bot request <needthis> for <channel> from all
143 linked bots. <needthis> can be needinvite, needlimit
144 needkey or needunban.
145
146
147 5. Tcl variables
148 =================
149
150 There are currently eight Tcl variables:
151
152 bop_delay
153 Maximum number of seconds to delay before asking a non-opped bot
154 if it needs ops. Set to 0 to disable.
155
156 bop_maxreq
157 Maximum number of bots to request ops from at a time. Set to 0
158 to disable.
159
160 bop_modeop [0/1]
161 Make the bot send an op request when it sees a bot become opped on a
162 channel? This will make your bot get ops sooner when another bot is
163 given ops.
164
165 bop_linkop [0/1]
166 Make the bot send an op request when a bot links? This will make your bot
167 get ops sooner if linking is delayed, and provides a better chance of the
168 bots opping one another if there are linking problems.
169
170 bop_icheck [0/1]
171 Check bot's userhost before inviting it to a channel?
172
173 bop_osync [0/1]
174 Make the bot give ops to a bot even if it looks like it's already opped
175 on the channel?
176
177 bop_addhost [0/1]
178 Make the bot to try add new hostmasks for bots?
179
180 bop_log [0/1/2]
181 Set this to 2 to enable all logging, 1 to disable logging of ops/op
182 requests and 0 to disable all logging.
183
184
185 6. Feedback
186 ============
187
188 You can contact the author at temex@iki.fi. All kinds of questions, suggestions,
189 comments and bug-reports are welcome and highly appreciated. Please feel free to
190 send also patches. Patches should be in -bur format. Before sending any questions
191 etc. please read through this document, especially the FAQ.
192
193
194 7. Latest version
195 ==================
196
197 The main site for botnetop.mod is:
198 http://www.iki.fi/temex/eggdrop/
199
200 You can obtain the latest version from the site above
201 or via CVS by typing the following lines to your shell:
202 1. cvs -d :pserver:anonymous@cvs.eggheads.org:/usr/local/eggheads login
203 (when CVS asks for a password just press enter)
204 2. cvs -d :pserver:anonymous@cvs.eggheads.org:/usr/local/eggheads checkout botnetop.mod
205
206 The CVS web is available at:
207 http://www.eggheads.org/cgi-bin/cvsweb/botnetop.mod/?cvsroot=Eggheads
208
209
210 8. Credits
211 ===========
212
213 The author wants to thank the following people (in alphabetical order):
214
215 * Abraham for beta testing and breaking everything.
216 * daimonic for (lazy) beta testing.
217 * Fabian for helping whenever I needed help.
218 * G`Quann for helping solve few problems.
219 * guppy for solving few problems and setting up the CVS.
220 * guruz for beta testing and telling bad jokes.
221 * Johoho for beta testing.
222 * NML_375 for helping with pointers.
223 * slennox for coding botnetop.tcl
224 * SuperS for ideas, suggestions and beta testing.
225 * Wull for helping with structures.
226
227
228 9. License
229 ===========
230
231 botnetop.mod is written by Teemu Hjelt and is released to the public under
232 the terms of the GNU General Public License. For the complete license please
233 see the file called COPYING in your eggdrop directory.
234
235
236 Copyright (C) 2000 Teemu Hjelt <temex@iki.fi>

webmaster@eggheads.org
ViewVC Help
Powered by ViewVC 1.1.23