FlashPioneer Video Chat Installation Documentation
Copyright (C) 2001-2006 SourceTec Software Co., LTD.
All Rights Reserved

----------------------------------------------------------------
Table of Contents
      
    * Installation of Client
    * Configuration via setting.xml
    * Creating the Installation Package for Client Program

----------------------------------------------------------------

Installation of Client

    1) Unzip file Chat_Client.zip to target folder

        Below is the file structure after unzip:

                ./chat.swf              --- swf file
                ./UserIcons.swf         --- user icon file
                ./setting.xml           --- configure file 
                ./themes/               --- style package
                ./lang/                 --- language package 
                ./cartoon/              --- emotion animation 

    2) Embed Chat Client into site page 

        Copy the file above into your website relative folder and add following 
        code to the site page you want to embed chat:

==================================================================
<object classid="clsid:d27cdb6e-ae6d-11cf-96b8-444553540000" codebase="http://download.macromedia.com/pub/shockwave/cabs/flash/swflash.cab#version=8,0,0,0" width="766" height="760" id="chat" align="middle">
<param name="allowScriptAccess" value="sameDomain" />
<param name="movie" value="chat.swf" />
<param name="quality" value="high" />
<param name="bgcolor" value="#ffffff" />
<embed src="chat.swf" quality="high" bgcolor="#ffffff" width="766" height="760" name="chat" align="middle" allowScriptAccess="sameDomain" type="application/x-shockwave-flash" pluginspage="http://www.macromedia.com/go/getflashplayer" />
</object>
==================================================================

        Note: You can change "Width" value and "Height" value in Object tag and 
        Embed tag to change the size of Chat window; and you also can visit SWF 
        file by the browser directly which can make the Chat window full size 
        the browser window.

        TIPS: As to the problem that the Flash control must be acivated by 
        mouse in IE explorer, it can be solved by javascript. there are two 
        ways at present: 
        activecontent_samples provided by Adobe:
        http://www.adobe.com/devnet/activecontent/articles/devletter.html
        and swfobject script offered by the third party:
        http://blog.deconcept.com/swfobject/

        Attention: Because of the Flash Player security policy, if the domain 
        name of SWF file is different from the external server's, they can't 
        link when SWF file communicates with the external server. For example, 
        E.g. if SWF is in http://www.aaa.com but the domain name of Red5 or FMS 
        server is www. bbb.com, the SWF can not link to the server.

        Solution: Place the domain name policy file crossdomain.xml in the web 
        root directory of the server. For e.g. 
            http://www.bbb.com/crossdomain.xml
        It must be the root directory of the web directory. You can find 
        crossdomain.xml on the list of the install file. For more information 
        and details of Flash Player privacy protection, please visit the 
        official website: 
        http://www.adobe.com/products/flashplayer/security/

    3) Configure Client

        Configure sever address and port. Use Notepad or other text tool to 
        open the file "setting.xml". Modify the server address and port 
        referring to the note in this file. About the detail of configuring 
        please see "Chat Configuration via setting.xml".

        Open the site page, and try to log in as a guest. If it successfully, 
        it means installation is successful

    4) Initialize the system information

        After the system is installed, the list of room is empty so you need to 
        add rooms through logging-in the admin panel background. Please log in 
        as administrator, whose user name is admin and password is admin. 
        Please change the administrator password at first time. On the manage 
        panel select room manage, then add rooms.


----------------------------------------------------------------

Configuration via setting.xml

    Edit file setting.xml using notepad or other text editor to set Client. 

    <?xml version="1.0" encoding="UTF-8" ?>

    <clientSet>

        <server url="localhost" port="1935" />
        Here input server's address and port. The address could be IP or 
        Server's name.
        The default port of Red5 Server and Flash Media Server is 1935. If you 
        changed it, please do relevant modification.

        <rootPath value="" /> 
        Root directory setting defines the root paths of language package and 
        skin package. By default, the current path is applied. You just leave 
        it empty.
        It could be defined as relative path or absolute path, for example: 
        ./flashchat/ or http://www.flashpioneer.com/. 
        Notice that the path must end with "/".

        <homePath value="http://www.flashpioneer.com" />
        Your web site address

        <helpPath value="http://www.flashpioneer.comonlinehelp/help.htm" />   
        The path of help file. The page will be opened when user click Help.

        <registerPath value="" />
        Register page is for new users. This configuring item works only when 
        Romoting data interface is used in the chatting program. Its function 
        is to integtat the existing register function on the website so to 
        provide more convenient interface.

        <language value="en" />
        Language package setting. Select the language for interface. Now we 
        provide following languages:
            en        -- English
            zh-CN     -- Chinese Simplified
            zh-TW     -- Chinese Traditional

        The language package is in the directory of <roomPath>/lang/ 
        You can also do translation according to the language package available 
        in the directory. You should save the translation file in the name of 
        language_***.xml into the directory of language package, and then 
        select language.
        If none language is selected, Client will automatically get the 
        language information of user's operating system, and then to get 
        relevant language package. 
        If a language has been selected, then this language package will be 
        loaded.

        <theme value="default" />
        Interface style file is in the directory of <rootPath>/themes/, and 
        each style is a directory named by this style. 
        We provides 6 different styles in the chat package, you can custom the 
        skin by yourself or let us to do it for you.

        <visibleMarquee value = "true" />
        Whether to show the scrolling news bar on the top. The scrolling news 
        bar on the top shows the news sent by administrator. If you don't want 
        to show it, set it to be "false".

        <visibleWhitePaper value="true" />
        Whether to show Doodle. If you don't want to use the module, set it to 
        be "false".

        <paperWidth value = "880" />
        <paperHeight value = "480" />
        Doodle window size setting

        <showMemberRoomForGuest value="true" />
        Whether to show Member-Only room when guest login.

        <autoJoinRoom value="true" /> 
        Whether to join room when only one room.

        <enableVideoInRoom value="true" />
        Whether to turn on the public video

        <enableVideoInPrivate value="true" />
        Whether to turn on the video in private chat

        <videoSizeInPrivate value = "small"/>
        Video size in private chat window
            small       --80x60
            middle      --100x75
            big         -- 120x90

        <enablePrivateChat value="true" />
        Whether show private chat interface

        If you open private chat interface, click the name in user list then 
        appears a menu including private chat. Through the private chat menu, 
        users can privately chat with someone and the conversation won't be 
        seen by others.
        If you want to disable the function, set to be "false".

        <videoSetting fps = "10" quality = "65"/>
        fps: 
        Number - The requested rate at which the camera should capture data, 
        in frames per second. The default value is 10 and it suggested to be 
        between 10 to 15. 

        quality: 
        Number - Specifies the required level of picture quality, 
        Acceptable values range from 1 (lowest quality) to 100 (highest 
        quality). 
        To specify that picture quality can vary as needed to avoid exceeding 
        bandwidth, pass 0 for quality. The default value is 65. 

        <maxPrivateWindow value="5" />
        Max windows number of private chat. Default is 5 and it suggested to be 
        between 1 to 8. 

        <enterRoomMsg value="true" />
        Whether to show the information of someone's entering. Default is 
        "true".

        <quitRoomMsg value="true" />
        Whether show the information of others' quit. Default is "true".

        <enterRoomSound value="false" />
        Whether play notice sound when someone enters room. Default is "false".

        <quitRoomSound value="false" />
        Whether play notice sound when someone quits room. Default is "false".

        <messageSound value="true" />
        Whether to play sound when receive new message. Default is "true".

        <noticeSound value="true" />
        Whether play notice sound when receive new broadcast news. Default is 
        "true".

        <visibleLoginAsGuest value="true" />
        Whether show the login as guest checkbox. If do, guest can login.

        <visibleRegisterButton value="true" />
        Whether show the register button. If do, everyone can register through 
        registration port. Default is "true".

        <enableUButton value="true" />
        Whether show Underline button in chat toolbar.

        <enableBButton value="true" /> 
        Whether show Bold button in chat toolbar.

        <enableIButton value="true" /> 
        Whether show Italic button in chat toolbar.

        <enableColorPicker value="true" />
        Whether show ColorPicker in chat toolbar.

        <enableSelectTextBack value="true" />
        Whether show Select Text Area Background button in chat toolbar.

        <enableSmiley value="true" />
        Whether show Smiley button in chat toolbar.

        <showSmileLimit value = "5" />
        The use of smiley is limited. Max number of smiley in one message can 
        be set. If you set it be 0, it means no limit. 

        <showTimeStamp value="true" /> 
        Whether show time stamp ahead of message.

        <parseURL value="true" />
        Whether automatically parse the URL in chat message to be hyperlink.

        <emotions enabled="true" column="5" autoPlay="false"> 

            <item name="Birthday" src="cartoon/movie/birthday.swf" 
            thumb="cartoon/preview/birthday-small.swf" duration="15"/>
            <item name="Boom" src="cartoon/movie/boom.swf" 
            thumb="cartoon/preview/boom-small.swf" duration="7"/>
            <item name="Bubble" src="cartoon/movie/bubble.swf" 
            thumb="cartoon/preview/bubble-small.swf" duration="7"/>
            <item name="Cry" src="cartoon/movie/cry.swf" 
            thumb="cartoon/preview/cry-small.swf" duration="9"/>
            <item name="Doggie" src="cartoon/movie/doggie.swf" 
            thumb="cartoon/preview/doggie-small.swf" duration="4"/>
            <item name="Greeting" src="cartoon/movie/greeting.swf" 
            thumb="cartoon/preview/greeting-small.swf" duration="10"/>
            <item name="Football" src="cartoon/movie/football.swf" 
            thumb="cartoon/preview/football-small.swf" duration="1.5"/>
            <item name="Bear.swf" src="cartoon/movie/bear.swf" 
            thumb="cartoon/preview/bear-small.swf" duration="7"/>
            <item name="Exercise" src="cartoon/movie/exercise.swf" 
            thumb="cartoon/preview/exercise-small.swf" duration="7"/>
            <item name="Ghost" src="cartoon/movie/ghost.swf" 
            thumb="cartoon/preview/ghost-small.swf" duration="7"/>
            <item name="Money" src="cartoon/movie/money.swf" 
            thumb="cartoon/preview/money-small.swf" duration="9"/>
            <item name="Meetgirl" src="cartoon/movie/meetgirl.swf" 
            thumb="cartoon/preview/meetgirl-small.swf" duration="4"/>
            <item name="Rose" src="cartoon/movie/rose.swf" 
            thumb="cartoon/preview/rose-small.swf" duration="10"/>
            <item name="UFO" src="cartoon/movie/UFO.swf" 
            thumb="cartoon/preview/UFO-small.swf" duration="7"/>

        </emotions>
        Animation panel in chat tool.
        enabled:   whether show the panel 
        column:    amount showed in each column 
        autoPlay:  whether play animation automatically.  

        You may add animation in the form of following format:
        <item name="Birthday" src="cartoon/movie/birthday.swf" 
        thumb="cartoon/preview/birthday-small.swf" duration="15"/>
        name:      animation name 
        src:       animation file path 
        thumb:     the path of abbreviated animation 
        duration:  playing duration 

        <preDefinedMsg enabled="true">

            <msg value="Hello,can I help you?"/>
            <msg value="May I have your name and E-Mail address please?"/>
            <msg value="Could you please give more detailed steps so that we 
            can reproduce the problem on our side?"/>
            <msg value="Wait a minute please; I am now checking the problem for 
            you."/>
            <msg value="I will send the relevant information to you via email; 
            please remember to check your mailbox for it."/>
            <msg value="My pleasure."/>

        </preDefinedMsg>
        Predefined Message : Frequently used messages.
        enabled: whether show the Predefined Message panel in chat tool.

        <fontSizeList enable="true" value="10,11,12,13,14,15,16,18,20,22" 
        defaultSize="12"/> 
        The font panel in chat toolbar. 
        enabled:       whether to show this panel.
        value:         available font size group, separated by "," .
        defaultSize:   default front size.

    </clientSet>


----------------------------------------------------------------

Creating the Installation Package for Client Program

    Since version 1.7, Chat provides the function that enables users to create 
    their own client installation file. So the chat users can just log in the 
    chatting system in desktop environment instead of logging in the web site 
    through browser. Moreover, during the installation, users can define skin 
    style and language. All these advantages accelerate a lot the Client’s 
    loading speed and visiting speed.

    Instructions:

    1) After unzipping the package, open the file "setting.xml" which is in the 
       directory "client" and configure it according to previous configuration 
       tutorial and set the relevant parameters of chat login in this file. 

    2) Enter directory "clientinstaller" and execute the program Generator.exe. 
       After finishing, the Client setup program--- "ClientSetup.exe" has been 
       generated under OutPut subdirectory. 

    Please offer this installation program to your client users.

    Notice:

    (1) Please make sure that client directory and clientinstaller directory 
        are in the same level so that Generator.exe can find the necessary 
	client installation file.

    (2) The script generated by this installation package is based on Nullsoft 
        install System, so it must be used under the Windows operating system.

    Tips: If you are familiar with the script of Nullsoft Install System, you 
    can edit setup.nsi file in clientinstaller directory to generate the client 
    installation program which meets your own needs.


END
