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