********************************
PHPBB2 INTEGRATION FOR FLASHCHAT
********************************

This file describes the steps required to integrate FlashChat into a phpBB2 environment. 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:
Find the "mods" directory in phpBB2 document root. If it does not exist, create it.

STEP 2:
Create a subfolder in the "mods" directory of phpBB2, called "flashChat". Please note that the folder name MUST be "flashChat" (i.e., it's case-sensitive). Copy all of the FlashChat files to this directory using FTP, and be sure to upload your files in a "binary" mode (not ASCII). Thus, your directory structure will be something like:

http://www.yourdomain.com/{path to phpbb2}/mods/flashChat/index.php
http://www.yourdomain.com/{path to phpbb2}/mods/flashChat/inc/config.php
etc. with all other files...

STEP 3:
Open the "common.php" file located in the "inc" directory of your FlashChat distribution. You should be able to use any plain-text editor, like TextPad (www.textpad.com) or Windows Notepad. Find the group of PHP commands that relate to CMS integration. They will have the "cmses/" label in them:

//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' );
...etc...
include_once(INC_DIR . 'cmses/phpBB2CMS.php' );

As shown above, you must put double-slashes before ALL CMSES except for the "phpBB2CMS" line. This will deactivate all other CMS support except for phpBB2. Double-slashes are how programmers "comment-out" a line, thus deactivating it.

Thus, ONLY this line will NOT be commented:

include_once(INC_DIR . 'cmses/phpBB2CMS.php');

STEP 4:
Run the mods/flashChat/install.php file by opening this file in your web browser, and accept the provided database settings (they are copied directly from the phpBB2 config file, so you must not change them).

You will need to ensure that the "/inc/config.srv.php" file is writable. This means that you may need to "CHMOD" the file to a writable setting. If you do not know what that means, please contact your web server administrator. Most FTP clients, like AbsoluteFTP, CuteFTP, and WS_FTP have the ability to CHMOD files and folders.

STEP 5:
Locate the templates/subSilver subdirectory of the phpBB2 document root. If you are not using the subSilver template, then identify the directory of the template that you are using.

STEP 6:
Now, you will need to edit the "overall_header.tpl" file within the 'subSilver' template (or whichever template your are using).

Locate this text:

<!-- END switch_user_logged_out -->

And add the following text IMMEDIATELY after it:

<!-- BEGIN switch_user_logged_in -->
&nbsp;<a href="mods/flashChat/flashchat.php" class="mainmenu" target="flashchat"><img src="templates/subSilver/images/icon_mini_register.gif" width="12" height="13" border="0" alt="Start FlashChat" hspace="3" />FlashChat</a></span>&nbsp;
<!-- END switch_user_logged_in -->

STEP 7:
Save the modified overall_header.tpl file and upload it to your server in the appropriate directory (probably templates/subSilver).

STEP 8:
If you are logged-in to phpBB2, logout and clear your brower cache and cookies. Then, log back in. You should now see the "FlashChat" link at the top of the phpBB2 screen. Clicking on this link will load FlashChat in a separate window, using your phpBB2 username. phpBB2 administrators are automatically logged-in to FlashChat as chat moderators.

NOTE: If you get a blank screen (or a screen with only the Terminator 3 background), then make sure that you have correctly run install.php, and also make sure that you have uploaded the files in binary mode.

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!

(c) 1999-2004 Darren G. Gates