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