$Id

=========================================
AddonChat Integration Module for Drupal 6
=========================================

      ===========================
   1. INSTALLATION: UPLOAD MODULE
      ===========================

      As with the installation of any new module or theme, it is strongly
      recommended that you perform a complete backup of your current Drupal 
      installation before proceeding. 

      A. Copy the following files to your root Drupal folder (the folder
         which contains index.php and cron.php):

         addonchat_auth.php
         addonchat_exit.php

      B. Copy the addonchat folder to your sites/all/modules subdirectory in 
         your Drupal 6 folder.
      
      ===========================
   2. INSTALLATION: ENABLE MODULE
      ===========================

      You will need an AddonChat account to continue. If you do not already
      have an AddonChat account, you may register for a free account at 
      http://www.addonchat.com/signup.html

      A. Log in to your Drupal 6 content management system as an 
         admininstrator. 

      B. Click over to Administer -> Site building -> Modules from the main
         menu. 

      C. In the Modules list, a new 'Chat' section should be available listing
         the new 'AddonChat' module available for installation. Click the 
         checkbox next to 'AddonChat', scroll to the bottom of the page and 
         click 'Save configuration'

      ===============
   3. SETUP ADDONCHAT
      ===============

      A. As an admininstrator, click over to Admininster -> Site configuration
         -> AddonChat from the Drupal 6 main menu.

      B. You will be prompted to enter your AddonChat account ID (this is the 
         assigned account ID number that begins with SC-) and your AddonChat
         password that you used to register your AddonChat account. Enter
         these values now.

      C. If you have an AddonChat Professional PLUS or Enterprise account, you 
         will want to set 'Enable Drupal User Authentication' to 'Yes'. 

      D. Click the 'Lookup Account Settings' button to have your account 
         details automatically set. 
         
         i. If this function fails, you may need to manually enter your 
            assigned chat server (e.g., client0.addonchat.com) and your 
            assigned server port (which can be found in Settings -> Advanced 
            from your AddonChat control panel. Click 'Save configuration'
            to update any changes.

         ii. If you wish to use a different language than English, you may 
             select an alternate language from the 'Account Settings' section
             on this page. Click 'Save configuration' to update any changes.
            
      =============
   4. CONFIGURATION
      =============

      A. INTEGRATION

         You may specify various integration options from the Administer ->
         Site configuration -> AddonChat -> Integration Settings menu 
         option. The default values are typically good for most 
         installations.

      B. ADVANCED SETTINGS

         Advanced users may configure additional settings from Administer ->
         Site configuration -> AddonChat -> Advanced Settings

      C. CONTROL PANEL ACCESS

         We've made it easy for you to access your AddonChat account control
         panel to do additional customization. Simply click over to Administer
         -> Site configuration -> AddonChat -> Account Control Panel to launch
         your AddonChat control panel in a separate menu. 

      =====================
   5. CONFIGURATION: BLOCKS
      =====================

      You will find two new blocks available under Administer -> Site building
      -> Blocks:

         A. AddonChat Link: Click 'configure' to configure your AddonChat link
            used to launch your chat room. We recommend using the (default) 
            'Popup Link' option.

         B. AddonChat Who's Chatting List: This block feature allows you to 
            show who is currently logged in to your chat room. The Who's 
            Chatting database is updated once every five minutes, and is
            also updated whenever a user logs in to your chat room, or logs
            out when using the provided (default) Exit URL settings.

      ===============================
   6. CONFIGURATION: CHAT PERMISSIONS
      ===============================

      We've made it easy to control which privileges you and your users have
      access to in the chat room using Drupal's User management/permission 
      system.

         A. Click over to Administer -> User management -> Permissions to
            modify your 'addonchat module' permissions. The default settings
            are recommended and will usually work well for most users. 

         B. You may wish to add, edit, or delete User Roles from the Administer
            -> User management -> Roles menu. We've created four default roles
            (chat admin, chat guest speaker, chat moderator, and chat super 
            admin) which should be sufficient for all account levels. If you 
            do not have an Enterprise edition account, feel free to remove the
            'chat guest speaker' and 'chat moderator' Roles. 

      ============
   7. TEST IT OUT!
      ============

      Now that everything is in order, you can enter your chat room by clicking
      your chat link in your new 'Chat room' Drupal block. As an admininstrator
      you should be automatically logged in using your Drupal username and 
      password, and authenticated with admininstrative privileges in the chat
      room (Pro+ account or higher required for this functionality). 
      