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