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