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