*********************************************************
MOODLE COURSE MANAGEMENT SYSTEM INTEGRATION FOR FLASHCHAT
*********************************************************

This file describes the steps required to integrate FlashChat into a Moodle installation. The normal installation procedure, as described in the FlashChat readme.txt file, does NOT apply in this case.

YOU MUST FOLLOW THESE STEPS PRECISELY!


STEP 1:
Open the "common.php" file within the "inc" folder of your FlashChat distribution, and make sure that "moodleCMS.php" is the ONLY uncommented line relating to CMS integration. I recommend that you use TextPad (www.textpad.com) as your plain text editor - NOT Windows Notepad or WordPad.

Thus, the common.php file will have something similar to this:

//include_once(INC_DIR . 'cmses/defaultCMS.php');
//include_once(INC_DIR . 'cmses/statelessCMS.php');
//include_once(INC_DIR . 'cmses/phpNukeCMS.php');
//include_once(INC_DIR . 'cmses/postNukeCMS.php');
//include_once(INC_DIR . 'cmses/xoopsCMS.php');
//include_once(INC_DIR . 'cmses/vbulletinCMS.php');
//include_once(INC_DIR . 'cmses/xmbCMS.php');
//include_once(INC_DIR . 'cmses/ipbCMS.php');
//include_once(INC_DIR . 'cmses/wowCMS.php');
include_once(INC_DIR . 'cmses/moodleCMS.php');

Thus, "//" appears before all the CMS references EXCEPT for the Moodle reference. Double slashes are how programmers "comment-out" a line, thus deactivating it.


STEP 2:
On your web server, create a new folder called "FlashChat" as a sub-folder of the Moodle directory (the directory that contains Moodle's index.php file). Copy all of the files in the "chat" folder from your FlashChat download to the newly created FlashChat directory.

In other words, you should now have a folder called "FlashChat" main directory of Moodle, and within the "FlashChat" directory you have the actual FlashChat files... for example:

.../upload/FlashChat/index.php
.../upload/FlashChat/install.php
.../upload/FlashChat/inc/
.../upload/FlashChat/sql/
.../upload/FlashChat/templates/
...etc for other files in the "chat" folder of your FlashChat distribution.

CHMOD the /FlashChat/inc/config.srv.php file to a world-writable format, like 777. This will ensure that the FlashChat installer can write configuration data to the config.srv.php file. If you are unsure of how to do this, please contact your website administrator.


STEP 3:
Using your web browser, open the ./FlashChat/install.php file, and accept the provided values. These values will probably look familiar to you since they should draw from your current Moodle configuration. If the values do not look familiar, then go back to steps 1-3 and make sure that you have done those steps correctly.

If the values are correct, submit the form to create database tables that are required for FlashChat.


STEP 4:
Go back to the the Moodle folder on your web server

Go to 'theme/standard' directory.

Open header.html, and find the following text:

    <td align="right" valign="top" class="headerhomemenu"><?php echo $menu ?></td>

Replace it with:

    <td align="right" valign="top" class="headerhomemenu"><?php echo $menu ?>
    <?php if (!empty($USER->id)) { ?><br /><font size="1"><a href="<?php echo "$CFG->wwwroot/FlashChat/flashchat.php" ?>">FlashChat</a></font><?php } ?></td>

A few lines after that, find this text:

    <td align="right" valign="top" class="headermenu"><?php echo $menu ?></td>
    
Replace it with:

    <td align="right" valign="top" class="headermenu"><?php echo $menu ?>
    <?php if (!empty($USER->id)) { ?><br /><font size="1"><a href="<?php echo "$CFG->wwwroot/FlashChat/flashchat.php" ?>">FlashChat</a></font><?php } ?></td>

Be very careful that you paste this text correctly, since this is a very easy place to introduce PHP syntax errors, which could make your entire Moodle setup stop running. It is strongly recommended that you backup these files before making changes to them! Note: this procedure applies only to the 'standard' theme. However, the procedure for other themes should be very similar.


STEP 5:
Close all instances of your web browser.

Then, restart your browser, and open the Moodle main page - upon logging in, you'll see the FlashChat link under the "You're logged in as..." text. Logging in as a standard Moodle user will now auto-login to FlashChat, and logging into Moodle as an administrator will auto-login to FlashChat as a chat moderator.


If you notice any errors in these steps, or have any suggestions for improvement, please post a message on the TUFaT.com support forum, located at http://www.tufat.com

Thank you for using FlashChat!