Read Me

===========================================================================================
 Gaimer
===========================================================================================

  Gaimer is a text-based game platform for AIM chat rooms.  As such Gaimer is set out to
  provide a smart and reliable way to provide some simple entertainment to AIM chat rooms.
  The basic functionality of Gaimer itself is rather basic:
  
    1. Facilitate the connecting, disconnecting, chatting, and reading of AIM chat rooms.
    2. Acknowledge and parse specific commands to initiate/destroy games.
    3. Provide text-based games (written in Ruby) the necassary tools to communicate with,
        and read from, AIM chat rooms.
    4. Do all of this as automated and as modularly as possible.
   
   Gaimer is written by Bobby Hensley (mailto: bob@bobbyhensley.com) and licensed under the
   Simplified BSD License.
   

===========================================================================================
 What You Have Downloaded
===========================================================================================

  The source code shipped with this README is not, by any stretch of the imagination,
  production-quality code.  Realistically this source code is alpha, maybe even borderline
  pre-alpha quality.  As such expect crashes, bugs, and things quite simply not working as
  they should.
  
  While the basic functionality ought to be there, no guarantees are made.
  
  With this source code should also come one or two rudamentary games to show Gaimer's
  functionality and to facilitate testing.  At the time of this writing the game being
  packaged with Gaimer is a trivia game, written by Bobby Hensley.
  
  
===========================================================================================
 Using Gaimer
===========================================================================================

  A basic list of what Gaimer requires to be run:
  
    1. Ruby (Gaimer was written on 1.8.6)
    
    2. RubyGems
    
    3. The Net::TOC gem
    
      >$ gem install -r net-toc
      
    4. An AIM account- preferably not your primary account
    
  Suggesting you have everything required then you'll need to modify some constants inside
  the source code (gaimer.rb).  These are all documented within the source.
  
  At this point just open up your terminal/console/command prompt/whatever, navigate to the
  directory containing Gaimer, and issue the command:

    >$ ruby gaimer.rb
    
  Current the trivia game is installed and accepts the following command to begin:
  
    >$ trivia: start
    
  The game start command should be issued by the bot's admin account within the chat room itself.