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