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