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