[project @ 2005-07-05 07:24:59 by unknown_lamer]
[clinton/bobotpp.git] / NEWS
1 (-*- text -*-)
2 User Visible Changes In Bobot++
3
4 IMPORTANT NOTES:
5 As of version 1.98 unknown_lamer is the new maintainer. Also as of
6 version 1.98, you must have Guile 1.5.6+ or 1.6.x in order to
7 compile scripting support.
8
9 =====================================================================
10 ====== The News =====================================================
11 =====================================================================
12
13 Version 2.1.9:
14 - Scripting
15 + hooks/disconnect now takes an additonal argument that specifies
16 whether the disconnect was intentional or not.
17 + The deprecated scripting procedure and hook names are now in a
18 `begin-deprecated' block. If your guile is built without
19 deprecated feature support, they will not be available.
20 - Documention
21 + Reorganized a few sections
22 + Every hook is now documented
23 + Using bot section is now much more usable
24 - The code was cleaned up a bit
25
26 Version 2.1.8:
27 - Scripting
28 + Hooks
29 * Added bot:protection/[none|ban|kick|deop] and bot:aop/[yes|no]
30 constants to the Scheme scripting interface
31 * hooks/timer argument is now zero padded instead of space padded
32 (e.g. "11:01" instead of "11: 1")
33 * hooks/disconnect is now called when the bot is disconnected from the
34 server unintentionally (network connection timeout, server died,
35 etc.)
36 * hooks/action is now passed the user's nick instead of the full
37 address like all other hooks
38 + Message Sending
39 * Implemented bot:notice
40 * bot:msg and bot:say may both send to channels and users (instead
41 of bot:msg for users and bot:say for channels)
42 * Renamed bot:send-CTCP to bot:send-ctcp
43 * Added bot:send-ctcp-reply to send a ctcp-reply
44 + Misc
45 * Added (bobotpp bot) module that modules may use to gain access
46 to the bobot++ functions
47 + Debugging
48 * The debugging evaluator is now enabled when --debug is passed to
49 the bot
50 * New command line option: --debug-scripts enabled the debugging
51 evaluator while running everything else normally
52 * Merged error handling patch from Dale Smith. This adds detailed
53 errors and backtraces when --debug/--debug-scripts is passed to
54 Bobot++.
55 - Documentation
56 + Merged documentation patch from Dale Smith (thanks)
57 - Misc
58 + NOTICEs and PRIVMSGs are now sent correctly if they contain an
59 embedded newline
60 + Max nick length is now configurable via 'maxnicklength' option in
61 bot.conf (defaults to 9)
62 - The bot now builds with --disable-scripting again (this is my fault,
63 I haven't built without it in a long time)
64
65
66 Version 2.1.7:
67 - Fixed a number of small bugs and corner cases
68 - Should compile without warnings (GCC 3.4)
69
70 Version 2.1.6:
71 - The String class implementation has been redone and replaced by one
72 based on std::string (eventually String will be gone entirely, but
73 it a lot of work)
74 - Patches from Jos Hulzink <josh@stack.nl> were applied which fix a
75 few major bugs in the StringTokenizer (thanks)
76
77 Version 2.1.5: Cleanups
78 - A DCC CHAT with the bot may now only be initiated if the user is a
79 Friend of the bot
80 - Implemented bot:ctcp-quote
81 - The Bot Configuration section of the manual has been completed.
82 - Fixed a potential (but unlikely) buffer overflow in Utils::strToTime
83 (if there were more than 512 digits in part of the string form of
84 the time the buffer would overflow)
85 - Misc. Bugfixes
86
87 Version 2.1.4: DCC Support Enhancements
88 - Internal Change: DCCConnection is now an abstract class
89 - Internal Change: DCCChatConnection provides the functionality of
90 the old DCCConnection so that DCC FILE support can be added
91 - New Scheme Procedure: (bot:sent-to-me? message), checks to see if a
92 message was addressed to the bot. This is better than using
93 bot:match-to-me because the hook will continue to function if the
94 bot's nick changes. The only downside to using it is that there may
95 be an increased overhead of calling more hooks than could be called,
96 but that shouldn't be much of a problem.
97 - New Scheme Procedure: (bot:change-command-level command level),
98 changes the level a user command to allow a user of `level' level or
99 above to run it.
100
101 Version 2.1.3: Something
102 - The flood rate can now be set using !setfloodrate INTEGER. The
103 default is two messages per second before the bot will ignore
104 you. (thanks to Björn Gustavsson for requesting this)
105 - The flood rate may also be set from Scheme using (bot:setfloodrate
106 integer)
107 - A very large crash bug has been fixed. Previously, if an undefined
108 command was called, any attempts to call a subsequent command would
109 cause the bot to crash. Now the bot doesn't crash.
110
111 Version 2.1.2: Llama
112
113 - match-to-me and match-not-channel are now bot:match-to-me and
114 bot:match-not-channel. Just use perl -pi -e
115 "s/match-to-me/bot:match-to-me" SCRIPTS (change to match-not-channel
116 for match-not-channel).
117 - Each script is now loaded into its own module so namespace clashes
118 should no longer occur
119 - New procedure: (bot:load-module INTERFACE-SPEC) will load a "bot
120 module" with the specified INTERFACE-SPEC (e.g. (foo bar)). A bot
121 module is the same as a system module except that you don't use
122 define-module to define it. The %bot:loadpath is searched for
123 INTERFACE-SPEC (when converted to a string) with an extension in
124 %bot:load-extensions. E.g. (foo bar) becomes "foo/bar".
125 - New procedure: (bot:use-module INTERFACE-SPEC) is the same as
126 bot:load-module except it will make the exported bindings from
127 INTERFACE-SPEC available in the current-module.
128 - Updated example bot and new example scripts included with the bot.
129
130 Version 2.1.1: foom
131
132 - Host masks are now case insensitive when matched. At least one other
133 person thought this was a good idea since IRC is case preserving but
134 not case sensitive.
135 - You can now "name" a hook using an extra arg to bot:addhook. This
136 name can be used to have multiple hooks of the same type with the
137 same regexp. The default name is "DEFAULT" so don't use that as the
138 name for your hooks.
139 - Logging now works again (oops, I didn't realize I broke it until I
140 started to work on DCC).
141 - DCC CHAT now "works." You can connect to the bot and talk to to it
142 and use Scheme hooks to talk to the user.
143 - New hooks: hooks/dcc/chat-begin and hooks/dcc/chat-message. These
144 are called when a new DCC Chat begin and when the user sends a
145 message.
146 - New Function: bot:dcc-chat-send TO MESSAGE, sends a MESSAGE to the
147 person at address TO
148 - New hooks: hooks/send/... where ... is one of action, ctcp, public,
149 or message. These are triggered when the bot does an
150 ACTION, sends a CTCP (_not_ a ctcp-reply), sends a PRIVMSG to a
151 channel, or sends a PRIVMSG to another user, respectively. There
152 will be more send hooks added later.
153 - New hooks: hooks/dcc/chat-begin and
154 hooks/dcc/chat-message. chat-begin is called when the chat starts
155 and has one argument: the address (in user!nick@host
156 format). chat-message has two arguments: from (user!nick@host) and
157 message, which is the raw message (since there is no real protocol
158 for DCC). chat-start hooks are matched against the address and
159 chat-message hooks are matched against the text "ADDRESS MESSAGE"
160 where ADDRESS is the sender's address and MESSAGE is the message.
161
162 Version 2.1.0: Zug Zug
163 - Hooks can now be fallthrough or non fallthrough. You can set a hooks
164 priority and whether or not it falls through (i.e. continues hook
165 matching after it has been executed) using two optional args to
166 (bot-addhook). The new args are pri (integer priority) and fallthru
167 (#t or #f) and are at the end. Higher priority hooks are executed
168 before lower priority hooks, and fallthrough hooks are executed
169 before non-fallthrough hooks.
170 - The default config is read from ~/.bobotpp/config/default/ or
171 /etc/bobotpp/default/ if the user config is not found. Put your
172 default config in either dir. You may also specify a specific config
173 under these dirs using the --config or -c arg to bobotpp (see
174 bobotpp --help for the full list of commands you may use and how to
175 use them).
176 - Scripts are now stored in ~/.bobotpp/scripts/ or
177 PREFIX/share/bobotpp/scripts/ (where PREFIX is /usr/local unless you
178 changed it with the --prefix arg to configure). The new function
179 bot-load will take a filename and load it from these dirs, returning
180 #t if the file was loaded and #f if it wasn't. You can modify the
181 search list by appending to %bot-loadpath.
182 - bobot-utils.scm is now autoloaded, so you don't need to
183 load it if you want to use its functions.
184 - Logs are now in ~/.bobotpp/logs/
185 - bot-* procedures in Scheme are now bot:*. The old bot-* functions
186 are defined as aliases in bobot-utils.scm
187 - You can now use lambda's for new commands (oops, I wasn't protecting
188 the objects from garbage collection)
189
190
191 Version 2.0: Stable release / CVS merges
192 - Merged stuff from Etienne Bernard's dev tree that he was working on
193 before I took over (not much)
194 - bot-adduser and bot-addshit now work from Scheme
195
196 Version 1.99: Configure joy
197 - You can now disable scripting using --disable-scripting or
198 --enable-scripting=no
199 - Crypt can also be disabled with --disable-crypt or --enable-crypt=no
200 - Old hooks behavior has been restored (new hooks are added to the end
201 of the hooks list and processing does not stop at the first matched
202 hook). The hook behavior will change radically in 2.1.
203
204 Version 1.98: Unknown_lamer made a large number of changes
205 - Code is now ISO C++ and compiles with GCC 3.1
206 - Converted makefile system to use automake
207 - configure.ac now requires autoconf 2.50 (this is only a problem if
208 you modify it, but I should be the only one doing that)
209 - Transition to new Guile 1.6 API has begun
210 - Scripting must always be enabled for now (known "bug")
211 - first hook of a given type to match is the only hook executed, all
212 others are ignored. Note that the last hook to be registered is the
213 first in the list!
214
215
216 Version 1.97: lots of changes, especially guile's scripting support, which
217 is not yet documented. See in the scripts/ directory for
218 examples, and in Interp.C (the Startup() function) for the
219 list of all available commands.
220
221 Version 1.30: Syntax change for "channel =" in bot.conf. See examples/bot.conf.
222 Rewrite of ident/password system. Should be more secure and
223 flexible.