[SimBot-commits] CVS: simbot INSTALL,1.23,1.24 TODO,1.16,1.17

[Kevin S. <ks...@us...>]

Update of /cvsroot/simbot/simbot
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv25029

Modified Files:
	INSTALL TODO 
Log Message:
Updating the TODO and the INSTALL.  The couple notes about LWP are important to look into.

Index: INSTALL
===================================================================
RCS file: /cvsroot/simbot/simbot/INSTALL,v
retrieving revision 1.23
retrieving revision 1.24
diff -u -d -p -r1.23 -r1.24
--- INSTALL	19 Jul 2005 02:33:28 -0000	1.23
+++ INSTALL	19 Jul 2005 12:29:28 -0000	1.24
@@ -2,54 +2,67 @@
 SimBot Installation
 ================================================
 
-SimBot itself requires no compilation of software.  The perl script comes
-ready to run with only minor changes to the config.ini file.
+SimBot is a collection of Perl script.  It does not need to be compiled, but
+it does require configuration and the installation of certain dependencies.
 
-You should copy the config.default.ini file to config.ini and customize the
-copy.  Keep the file in the same directory where you have the simbot.pl
-script installed.  The installation directory is completely up to you and
-is mostly irrelevant.
+Configuration is simple.  Copy the "config.default.ini" file to "config.ini"
+and customize the copy.  Many of the options in this file are already at
+sane defaults, but you will likely want to customize at least the first
+section to identify your bot uniquely.  Keep the file in the same directory
+where you have the simbot.pl script installed.  The installation directory
+is completely up to you.
 
-You need the POE::Component::IRC and Encode Perl modules installed before
-SimBot will function correctly.  If you have Perl 5.8.0 or higher installed
-you should already have a working Encode.  If you do not, you will need to
-install it.  You may also install these additional modules for extra
-features in SimBot:
+It is strongly recommended that you install Perl version 5.8.0 or higher
+when using SimBot.  Versions below 5.8.0 will not be officially supported,
+but should still work.  Compatibility fixes will be accepted if users
+choose to submit them.  If you do not have Perl 5.8.0, please be sure to
+install the Encode perl module as well as other dependencies.
 
-	POE::Component::Client::HTTP:
-		For weather.pl, rss.pl
+You need the POE::Component::IRC Perl module installed before SimBot will
+function at all.  You should also install the following modules if you
+intend to use any of the stock plugins provided with SimBot:
 
-	LWP: (libwwwperl)
-		For google.pl, tinyurl.pl
+[ LWP ] (libwww-perl) version 5.802 or higher:
 
-	HTML::Entities:
-		For google.pl, rss.pl
+	If you wish to use any stock plugins, you should install LWP.  It
+	is a dependency of several other modules and provides the framework
+	for accessing web-based content.  v5.802 or later is required to
+	handle gzipped content properly in several plugins and utility scripts.
 
-	DBD::SQLite:
-		For sqlite-logger.pl, weather.pl, rss.pl
+[ POE::Component::Client::HTTP ]
 
-	XML::Simple:
-		For weather.pl
+	* Required by: weather, rss
 
-	XML::RSS:
-		For rss.pl
+[ HTML::Entities ]
 
-	Net::Dict:
-		For dict.pl
+	* Required by: google, rss
 
-	Text::Aspell:
-		For aspell.pl
-		
-	SOAP::Lite:
-		For currency.pl
-		
-	DateTime:
-		For time.pl
+[ DBD::SQLite ]
 
-This all, of course, requires that you have Perl installed.
+	* Required by: sqlite-logger, weather, rss
+
+[ XML::Simple ]
+
+	* Required by: weather
+
+[ XML::RSS ]
+
+	* Required by: rss
+
+[ Net::Dict ]
+
+	* Required by: dict
+
+[ Text::Aspell]
+
+	* Required by: aspell
+
+[ DateTime ]
+
+	* Required by: time
 
 All of these modules are available in the CPAN repository, so you can
-install them in most Perl installations by running:
+install them in most Perl environments by running:
 
 	perl -MCPAN -e shell;
 
@@ -60,7 +73,7 @@ most recent version of each module, type
 
 For example:
 
-	install POE::Component::IRC Encode LWP
+	install POE::Component::IRC LWP
 
 CPAN will do what it needs to install the necessary package and you'll be
 on your way.  If you are unsure how to answer the questions it asks, it is

Index: TODO
===================================================================
RCS file: /cvsroot/simbot/simbot/TODO,v
retrieving revision 1.16
retrieving revision 1.17
diff -u -d -p -r1.16 -r1.17
--- TODO	19 Jul 2005 02:33:28 -0000	1.16
+++ TODO	19 Jul 2005 12:29:28 -0000	1.17
@@ -8,24 +8,25 @@ Targets for 1.0 Beta
 - Implement automatic database backups.
 - Implement learning ignore by hostmask/nickname.
 - Implement autokick plugin.
-- Make interesting word calculation adaptive by db size, because over time, 5000 is not enough, and lots of words become uninteresting.
+- Make interesting word base score adaptive by db size, because over time a constant is not enough, and lots of words become uninteresting.
 - Improve data storage format by converting to DBD-SQLite.
 - Convert all private messaging to private notices, to comply better with RFC 2812 section 3.3.2.
+- Verify backwards compatibility with LWP < 5.802.  We should never offer to accept gzipped content if we can't decode it.
 
 Targets for 1.0 Final
 ======================
 
-- Test dalnet and chanserv style services plugins.
-- Polish the documentation (what documentation?).
+- Test dalnet and chanserv style services plugins.  Preferrably, merge these two services plugins, unless it's absolutely impossible.
+- Polish (as in make better, not Poland) the documentation.
 - Standardize and clean up the debug output.
-- Crush evil bugs!
+- Test the hell out of every feature.
 
 Targets for Beyond 1.0
 ======================
-- Use POE better, blocking less and using more events.
-- RSS plugin desperately needs to handle all links/guids changing.
-- Make sentence generation bonus __BEGIN/__END as sentence gets longer to reduce the chance of (but not obliterate) excessively long sentences.
-- Redefine Plugin API using POE or related Perl 6 functionality.
+- RSS plugin should handle all links/guids changing somehow that doesn't involve printing the entire feed to the channel.
+- Make sentence generation give a bonus to __BEGIN/__END tags as the sentence gets longer in order to reduce the chance of excessively long sentences.
+- Rework the Plugin API using POE or related Perl 6 functionality.
+- Eliminate all unnecessary synchronous operations that might slow normal operations.
 - Allow the user to specify a custom data directory.
 
 Wish List
@@ -34,3 +35,4 @@ Wish List
 - Implement authentication for bot administration.
 - Eventually recognize the possibility of joining 2 or more channels.
 - Allow for media other than IRC (connection plugins).
+- Eventually port to the OOB functionality in Perl 6.