root/trunk/antimatter/tim/README

In this directory is a series of bots written by Bradley M. Kuhn
<bkuhn@softwarefreedom.org> of the Software Freedom Law Center to handle
various aspects of SFLC operations.

The most interesting of which is 'tim', the TimeTracker bot.

Here's a quick HOWTO to make tim run:

 -1. You may need some various Perl modules installed.  If you run Ubuntu,
     and they aren't packaged, you may be able to point to this apt-sources
     to find them:

       deb http://backports.softwarefreedom.org DIST main contrib

     where DIST is in { dapper, feisty, hardy }

  0. Modify Scripts/time-bot.plx to taste.  Note that it is currently
     configured to run as 'oldtimbot' on irc.freenode.net, and auto-join
     #antimatter.

  1. make a directory (I usually call mine TimeDB) under this directory.
     (It can actually be anywhere, but you'll need to adjust a few
     settings in time-box.plx and in the relative path names referenced
     below if you do that).

  2. Make a TimeDB/oldtimbot file that has an entry like:
           nick_password: PASSWORD

     if your time bot has a registered nick.

     (if it doesn't, you'll probably need to modify Scripts/time-bot.plx)

  3. cd TimeDB  # The rest of the instructions assume that's your cwd.

  4. perl -I ../Modules -I ../Bot-BasicBot/lib ../Scripts/create-db.plx

     # This will create an empty database .

  5. perl -I ../Modules -I ../Bot-BasicBot/lib ../Scripts/add-user.plx USERNAME

     # This will add a user


  6. To run the bot on the site:

        perl -I ../Modules -I ../Bot-BasicBot/lib ../Scripts/time-bot.plx


     This generates a lot of debugging messages to STDERR, and some status
     info to STDOUT, so you may want to save that somewhere, and nohup the
     process so that it stays running.

  OPTIONAL:
 
  7. perl -I ../Modules -I ../Bot-BasicBot/lib ../Scripts/create-category.plx /SOMETHING/HERE

      # By default, users are in "lawyer mode" and can use the "create
      # client" and create matter in CLIENT" commands to make new
      # categories.  If you want to make one that is not in that form, you
      # should use this command.





TODO: Instructions for Tem and Log bots.