**************************************************************************
** Zikula: Web Portal System                                            **
** Module for 123 Flash Chat Server software                            **
** ==============================================                       **
**                                                                      **
** Copyright (c) by TopCMM 					        **
** Daniel Jiang (support@123flashchat.com)          			**
** http://www.topcmm.com						**
** http://www.123flashchat.com                                          **
** http://www.Zikula.org/                                               **
**                                                                      **
**************************************************************************



####################################################################################################################
## Notes:                                                                                                         ##
##                                                                                                                ##
##     IMPORTANT!!!!                                                                                              ##
##     If you need to use the chat service on a local machine, before installing this module, please              ##
##     download 123FlashChat Server software first from this page:                                                ##
##     http://www.123flashchat.com/download.html                                                                  ##
##     You may get the latest free demo version of 123 flash chat server software at there.                       ##
##                                                                                                                ## 
##     And get professional support from: http://www.123flashchat.com/support.html                                ##
##     We provide online forum support, email support, online live support, and phone support                     ##
##     etc.                                                                                                       ##
##                                                                                                                ##
##     Good luck and have a nice day!                                                                             ##
##                                                                                                                ##
####################################################################################################################
## Before Adding This MOD To Your Zikula, You Should Backup All The Files Related To This MOD                     ##
####################################################################################################################


Step 1, Install the module in the Site admin panel

            1. OPEN Admin panel -> System -> Modules manager -> click "Regenerate modules list"
                                                                                 
            2. FIND "123 Flash Chat" (in the "Internal name") -> click "Install" (in the "Actions") -> Enabled it



Step 2, Click "chat" (in the "Display name"), and configure chat module's running mode:
        
        1). Please choose the running mode according to your needs.

              Configure the following parameters:
                                                     running mode

        2). Configure the parameters of the running mode you chose.


            1. Chat server is hosted by your own.
            
                 If your chat is hosted by your own, 123FlashChat server software should be installed at first, 
                 please download 123FlashChat:  http://www.123flashchat.com/download.html. 

               Configure the following parameters:
                                                  
                                                      Chat group
                                                      Chat client width
                                                      Chat client height
                                                      Chat data path
                                                      Client location
                                                     
                            
               Configuration reference:
                                                      Chat group            =  "default";
                                                      Chat client width     =  634;
                                                      Chat client height    =  476;
                                                      Chat data path        =  "<123flashchat install directory>/server/data/default/";  
                                                      Client location       =  "http://www.123flashchat.com/";
                                                     



             2. Chat server is hosted by 123flashchat.com.

                 If your chat is hosted by 123Flashchat.com, no 123FlashChat server software is needed to be installed; 
                 you may connect to your host chat room directly.

               Configure the following parameters:

                                                      Client location  
                                                      Chat client width
                                                      Chat client height

               Configuration reference:
                                                      Client location       =  "http://www.123flashchat.com/groupname/";
                                                      Chat client width     =  634;
                                                      Chat client height    =  476;

 
             3. Chat server is hosted by 123flashchat.com free of charge .

                 If you need to use this service, no 123FlashChat server software is needed to be installed, 
                 we will provide you free chat room, and you can choose the room name as you want.
            

               Configure the following parameters:

                                                      Chat room name 
                                                      Chat client width
                                                      Chat client height

               Configuration reference:
                                                      Chat room name         =  "YourRoomName";
                                                      Chat client width     =  634;
                                                      Chat client height    =  476;

                                                      (If you leave room name as blank, the default room name's value will be your domain's name.)






Step 3, Integrate your chat with Zikula user database

        If you choose running mode 1 or mode 2, integration is needed, you may achieve this by following the instructions below.

            1. Log in the Admin Panel of your 123FlashChat server
               OPEN: System Settings -> Integrate Panel
 
            2. Find: DataBase -> SELECT: URL -> edit 
      
            3. Change URL:
                 http://<Zikula install directory>/login_chat.php?username=%username%&password=%password%

            4. Press OK to save your setting.