home *** CD-ROM | disk | FTP | other *** search
/ Java 1.2 How-To / JavaHowTo.iso / 3rdParty / Coocoo / Readme.txt < prev    next >
Text File  |  1998-04-18  |  20KB  |  560 lines
  1. *****************************************************************
  2. *                                                               *
  3. *                           CooCoo(F1.52)                       *
  4. *                            Java Applet                        *
  5. *                         Written by Mark Qian                  *
  6. *                                                               *
  7. *****************************************************************
  8.  
  9.    
  10.  
  11.  
  12. CooCoo is a cool web-communication machine.
  13. It allows its users to chat, call-to-chat, display ad, 
  14. news, and more... The AdWare version of CooCoo is FREE!
  15. Shareware version is also availabel. TOP 5% at JARS. 
  16.  
  17. This may not be the latest version.  Please get the latest
  18. version at CooCoo's home
  19.  
  20.   http://www.coolshare.com/html/app_coo.htm
  21.  
  22. Detail instructions for installation are available there.
  23.  
  24.  
  25. CooCoo is DFFERENT because:
  26.  
  27.  
  28.   A. Call-to-Chat - Call the person to chat
  29.  
  30.          CooCoo comes with a Call Center where you can "call"
  31.          people who are not currently in CooCoo's chatroom.
  32.          After placing a "chat call", you can switch to other
  33.          applications (you can also icon your CooCoo. Move
  34.          the browser to other pages? No problem! CooCoo will
  35.          live until you shut down the browser.) and CooCoo will
  36.          prompt you when the person you called logs in to CooCoo. 
  37.         
  38.  
  39.  
  40.   B. Easy Chat -  for most personal pages
  41.  
  42.           CooCoo's chat system does not requires a program
  43.           running in background(daemon) in the server(Most ISPs
  44.           do not allow their users run such a background
  45.           program).  This means CooCoo can be installed
  46.           on any personal home page where CGI and Perl 
  47.           are supported.
  48.  
  49.  
  50.   C. No firewall problem
  51.  
  52.          CooCoo's users will not be blocked by
  53.          firewalls since the communication is
  54.          done with https.          
  55.  
  56.  
  57.   D. Easy advertising banner with sound
  58.  
  59.          CooCoo displays an advertisement banner in a HTML
  60.          style. Ad images are fetched from the server periodically
  61.          in a random or specified order. It is "easy" because
  62.          it is not neccessary for the resource (image and sound files) 
  63.          to reside in your site. Only thing you need to provide
  64.          is their URLs.  This is great for most of personal sites
  65.          since it make CooCoo's ad is affordable to these sites with
  66.          limited bandwidth(MB/Day): the images and sound can be 
  67.          fetched from other's site instead of yous!
  68.  
  69.          Another great feature of HTML style is that gif anmation
  70.          is supported in the ad banner.
  71.  
  72.          In additional, a sound file (any sound format support by
  73.          your browser) can be easily attached to an ad image.
  74.  
  75.      E. Smart news
  76.  
  77.          CooCoo starts displaying news line by line automatically 
  78.          if there is no chat activity for a specified period.
  79.          The news will be stoped as soon as people start chating.
  80.          This feature can be turn off from CooCoo but users.
  81.  
  82.          Maintenace of these text files is easy: just place all the
  83.          news text files in a specified directory and
  84.          CooCoo will pick up one at a time randomly.
  85.  
  86.      F. Smart sleep capability
  87.  
  88.          Bandwidth and CPU usage are limited in
  89.          most personal pages.  To reduce their
  90.          usage, CooCoo comes with a sleep
  91.          function: CooCoo will sleep if there
  92.          is no user activity after a specified
  93.          period.  That is, CooCoo will not
  94.          update info such as chat log, news,
  95.          ad, and so on untill users do something
  96.          like moving their mouse.
  97.  
  98.  
  99.  
  100.  
  101. Parameters:
  102.  
  103.          cgibase  - The URL where coocoo.cgi resides
  104.  
  105.          adperiod  - determent the frequency of updating ad banner. Default is 9.
  106.  
  107.          callerperiod  - determent the frequency of checking calls. Default is 50.
  108.  
  109.          userlistperiod  - determent the frequency of updating user list. Default is 15.
  110.  
  111.          clearuserperiod - period to clear the user list.  It is neccessary
  112.                         to clear user list because some users may be
  113.                         disconnected before they log off.  CooCoo need to
  114.                         clear user list periodatically.  Note: if you set
  115.                         clearuserperiod < userlistperiod
  116.                         you will clear all the login users too.  So DON"T
  117.                         set clearuserperiod < userlistperiod !! 
  118.                         Default is 100.
  119.  
  120.          roomlistperiod - Similar to userlistperiod except it is for room list. 
  121.                          Default is 15. 
  122.  
  123.          clearroomperiod - Similar to clearuserperiod except it is for room list. 
  124.                          Default is 200.  
  125.  
  126.          maxRoom -      Maximum number of rooms.
  127.  
  128.          passwordfile - specify the file where passwords are stored.  Default is
  129.                         "password".              
  130.               
  131.          ownertips - content of tooltips on Call Site Owner button
  132.  
  133.          callcentertips - content of tooltips on Call Center button
  134.  
  135.          nonmemberbutt - label of button for non-member log on. Default is "Non-member log on".
  136.  
  137.          memberbutt - label of button for member log on. Default is "Member log on".
  138.  
  139.          memberon - show member log on button if 1. Hide the button if 0. Default is 1.
  140.  
  141.          nonmemberon - show non-member log on button if 1. Hide the button if 0. Default is 1.
  142.  
  143.          loginmsg - the message appear at the bottom of the log on screen. It can be a HTML text.
  144.                     Default is
  145.  
  146.                    <h3>Please enter a nick name and click at a connect button.<h3>You can test member log on with following password: <br><b>guest</b>"
  147.  
  148.                     
  149.                    Note: This message is not the one displayed initially in the lower part of CooCoo's
  150.                          screen.  The initial message is displayed in coo2.htm.
  151.  
  152.          logintitle - the title text displayed in log in screen.  Defualt is "CooCoo Chat".
  153.  
  154.          fgcolor - foreground color of CooCoo. It accept HTML color format
  155.                    such as "FFFFFF" for white and "000000" for black. 
  156.                    Default is black.
  157.  
  158.          bgcolor - background color of CooCoo. Default is light gray.
  159.                            
  160.          refreshperiod  - determent the frequency of updating chat log. 
  161.                    Default is 5.
  162.  
  163.          newsperiod  - determent the frequency of posting news. Default is 50.
  164.  
  165.          newswait    - determent how long the period from 
  166.                        no chating activity to launching news.Default is 100.
  167.  
  168.  
  169.          newsState  - determent the initial state of the News Check Box.
  170.                       1 - checked
  171.                       0 - unchecked
  172.  
  173.                       Default is 1.
  174.  
  175.          newson     - determent if the News Check Box is accessable.
  176.                       1 - enabled
  177.                       0 - disabled
  178.  
  179.                       Default is 1.
  180.  
  181.                       Note: the check box will disappear if newDir is ignore.
  182.  
  183.  
  184.          ownername   - Owner's login name. CooCoo will notice
  185.                        the user with this name as owner.
  186.                        If this parameter is ignore the "Call site owner now"
  187.                        button will disappear.
  188.  
  189.          owneremail  - Owner's email. Ignore this field if you
  190.                        don't want to have to Call Owner button.
  191.  
  192.                        If this parameter is ignore CooCoo won't send email 
  193.                         notice.
  194.  
  195.          waitsleep   - the period CooCoo will sleep if no uesr action. 
  196.                        Default is 50.
  197.  
  198.          newswait    - determent how long the period from 
  199.                        no chating activity to launching news.
  200.                        Default is 100.
  201.  
  202.          imageInfo  - name of the file where ad info is stored
  203.                        Default is "image_info".
  204.  
  205.          showSleeper - CooCoo will update user list while sleeping if set to 1.
  206.                        Otherwise not update user list - this will cause sleeping
  207.                        users disappear from the user list but save some CUP time
  208.                        and bandwidth in your server.
  209.                        Default is 1.
  210.  
  211.      
  212.          datadir  - Name of sub directory where data files reside.
  213.                     Since some ISPs don't allow the CGI directory
  214.                     to be set to writable. So it is recommended that
  215.                     you better create a sub directory right under
  216.                     your CGI directory where coocoo.cgi resides.
  217.                     (If you set datadir to "" or ignore it, the data
  218.                      files will be written in your CGI directory).
  219.                     
  220.  
  221.          imagedir     - a sub directory(includ the related path if
  222.                         it does not reside directly under cgibase)
  223.                         under cgibase to contain ad images and the 
  224.                         file specifed by m_imageInfo
  225.  
  226.                      Ignore it if you don't want ad.
  227.  
  228.          newsdir     - a sub directory(includ the related path if
  229.                         it does not reside directly under cgibase)
  230.                         under cgibase to contain text files which
  231.                         contains news text.
  232.  
  233.                         Ignore it if you don't want news.
  234.  
  235.         sleepupmax   - the period which CooCoo will update screen
  236.                        right after it is waken up if it sleep longer
  237.                        than sleepupmax. 
  238.                        Default is 300.
  239.  
  240.        soundstate    - Sound for ad if 1 and sound for chat if 2.
  241.                        No sound if 0.
  242.                        Default is 2.
  243.  
  244.         adwidth      - width of ad banner.
  245.                        Default is 550.
  246.  
  247.         adheight     - height of ad banner.
  248.                        Default is 300.
  249.  
  250.        
  251.          maxchatline - maximum number of line in chat log file.
  252.                        if the nummber of line in chat log file
  253.                        exceeds maxchatline, CooCoo will clear
  254.                        chat log file.
  255.                        Default is 100.
  256.  
  257.  
  258.          button1 - Specify the first "customized chat button"
  259.  
  260.          button2 - Specify the 2nd "customized chat button"
  261.  
  262.            ...
  263.  
  264.          buttonn - Specify the Nnd "customized chat button"
  265.  
  266.                    More details about "customized chat button":
  267.  
  268.                        CooCoo allow its own customize five buttons
  269.                        in "Click here" section under the chat window.
  270.  
  271.                        There are three fields in value of button1 through
  272.                        buttonN separated by delimitor "^#^":
  273.  
  274.                        1). button label  2). text to be post to chat log
  275.                        3). sound when post
  276.  
  277.                    Example:  
  278.  
  279.      <param name=button1 value="Hello^#^Hello, folks!^#^sound/SOUND22.AU">
  280.  
  281.      The "customized chat button" above has "Hello" as its button label,
  282.      "Hello, folks!" as posted test, and "sound/SOUND22.AU" as posted sound.
  283.  
  284.  
  285.  
  286.  
  287.  
  288. Detail Instructions for installation:
  289.                                              
  290.    1).  
  291.        Download coocoo.zip
  292.  
  293.    2). Unzip coocoo.zip in a temperary directory, say c:\tmp_coo, 
  294.        in your local machine.
  295.   
  296.       At this time, you should have following files in c:\tmp_coo
  297.        
  298.          sound25.au
  299.          sound22.au
  300.          laugh.au
  301.          FILE_ID.DIZ
  302.          Readme.txt
  303.          coo2.htm
  304.          coo.htm
  305.          coo1.htm
  306.          coocoo.cgi
  307.          coocoo.class
  308.          app_coo.htm
  309.          zzz*.class  (total 9 files with names started with "zzz")
  310.          
  311.            
  312.  
  313.    3). Upload all the class, au files and app_coo.htm above to the 
  314.        html diretory in you server, say my-html.
  315.  
  316.        Note: all the class and au files have to be uploaded with binary mode
  317.                  while htm file should be uploaded with ASCII mode.
  318.  
  319.        so far, you have following directory and files:
  320.  
  321.           my-html
  322.           my-html/sound22.au
  323.           my-html/sound25.au
  324.           my-html/laugh.au
  325.           my-html/app_coo.htm
  326.           my-html/coocoo.class
  327.           my-html/zzz*.class  (total 9 files with names started with "zzz")
  328.           
  329.           
  330.  
  331.  
  332.    4). Make sure CGI and Perl are enabled at the directory where
  333.        parameter "cgibase" points to, say my-cgi.  
  334.        And make sure my-cgi is readable and executable (750)
  335.        Upload coocoo.cgi to my-cgi and set its access attribute
  336.        to readable and executable(750).
  337.  
  338.        so far, you have following directory and files:
  339.  
  340.           my-html
  341.           my-html/sound22.au
  342.           my-html/sound25.au
  343.           my-html/laugh.au
  344.           my-html/app_coo.htm
  345.           my-html/coocoo.class
  346.           my-html/zzz*.class  (total 9 files with names started with "zzz")
  347.  
  348.           my-cgi
  349.           my-cgi/coocoo.cgi
  350.  
  351.  
  352.    5). Creat a sub directory right under my-cgi with value of 
  353.        datadir above as its name such as "data". 
  354.        Set the access attributes of "data" 
  355.        to readable, writable, and executable (770).
  356.  
  357.        VERY IMPORTANT: You have to set this directory to 
  358.                        readable, writable, and executable (770).
  359.  
  360.  
  361.        so far, you have following directory and files:
  362.  
  363.  
  364.           my-html
  365.           my-html/sound22.au
  366.           my-html/sound25.au
  367.           my-html/laugh.au
  368.           my-html/app_coo.htm
  369.           my-html/coocoo.class
  370.           my-html/zzz*.class  (total 9 files with names started with "zzz")
  371.  
  372.           my-cgi
  373.           my-cgi/coocoo.cgi
  374.           my-cgi/data
  375.  
  376.    6). Creat a sub directory right under "data" with value of 
  377.        imagedir above as its name such as "images"
  378.        and set it to readable and executable(750). 
  379.  
  380.        
  381.        so far, you have following directory and files:
  382.  
  383.  
  384.           my-html
  385.           my-html/sound22.au
  386.           my-html/sound25.au
  387.           my-html/laugh.au
  388.           my-html/app_coo.htm
  389.           my-html/coocoo.class
  390.           my-html/zzz*.class  (total 9 files with names started with "zzz")
  391.  
  392.           my-cgi
  393.           my-cgi/coocoo.cgi
  394.           my-cgi/data
  395.           my-cgi/data/images
  396.        
  397.  
  398.  
  399.    8). Create a file with value of imageinfo above as its 
  400.         name such as "image_info". Each line of this file has
  401.         three fields divided by delimitor "^#^":
  402.  
  403.         1). URL of the image  
  404.         2). URL of the link to be opened when clicking at the image
  405.         3). URL of the sound  
  406.  
  407.        Example of a single line in the file:  
  408.  
  409.        http://www.coolshare.comhtml/image/image1.gif^#^http://www.coolshare.com^#^http://www.coolshare.com/sound/au1.au
  410.  
  411.        will display image with url http://www.coolshare.comhtml/image/image1.gif
  412.        sound with url http://www.coolshare.com/sound/au1.au
  413.        and open http://www.coolshare.com/ when the image is clicked
  414.  
  415.        You also need to set this file to readable(740).
  416.  
  417.        so far, you have following directory and files:
  418.  
  419.  
  420.           my-html
  421.           my-html/sound22.au
  422.           my-html/sound25.au
  423.           my-html/laugh.au
  424.           my-html/app_coo.htm
  425.           my-html/coocoo.class
  426.           my-html/zzz*.class  (total 9 files with names started with "zzz")
  427.  
  428.           my-cgi
  429.           my-cgi/coocoo.cgi
  430.           my-cgi/data
  431.           my-cgi/data/images
  432.           my-cgi/data/images/image_info
  433.  
  434.    9). Creat a sub directory right under "data" with value of 
  435.        newsdir above as its name such as "news"
  436.        and set it to readable and executable(750). 
  437.  
  438.        Copy all the files (such as new1, new2, ... newX)
  439.        contains news text into this directory, "news", and
  440.        set them readable(740).
  441.  
  442.        
  443.        so far, you have following directory and files:
  444.  
  445.  
  446.           my-html
  447.           my-html/sound22.au
  448.           my-html/sound25.au
  449.           my-html/laugh.au
  450.           my-html/app_coo.htm
  451.           my-html/coocoo.class
  452.           my-html/zzz*.class  (total 9 files with names started with "zzz")
  453.  
  454.           my-cgi
  455.           my-cgi/coocoo.cgi
  456.           my-cgi/data
  457.           my-cgi/data/images
  458.           my-cgi/data/news
  459.           my-cgi/data/news/new1
  460.           my-cgi/data/news/new2
  461.           ...
  462.           my-cgi/data/news/newX
  463.  
  464.        
  465.  
  466.    10). Modify app_coo.htm:
  467.  
  468.         In the <SCRIPT> section at top of app_coo.htm, there is a Javascript
  469.         function
  470.  
  471.         function OpenCooCoo() {
  472.            Coo=window.open("http://www.coolshare.com/html/coo.htm","CooCoo", "width=560,height=425");
  473.         }
  474.  
  475.         Set the first parameter to the complete URL of coo.htm.
  476.         In our sample, it is http://.../my-html/coo.htm.
  477.  
  478.  
  479.    11). Modify coo1.htm:
  480.  
  481.          set the parameter, cgibase, to http://.../my-cgi
  482.  
  483.        Note: the value of cgibase has to be a complete URL.
  484.  
  485.    12). If you like to provide member password logon, you 
  486.         need to create a file named password under data directory
  487.         with following content
  488.  
  489.             yourpassword^#^anonymous 
  490.             ownerpassword^#^ownername 
  491.  
  492.         where yourpassword is the password for all members and
  493.         ownerpassword is the password for owner.
  494.  
  495.         The password for owner is neccessary if you like to log on
  496.         as an owner.
  497.  
  498.  
  499.         The memer logon of CooCoo in this version only support a
  500.         single password for all members.
  501.  
  502.  
  503.  
  504.    13). Test CooCoo:
  505.  
  506.        Browse app_coo.htm to test it.
  507.  
  508.        You may want to make sure coocoo.cgi work fine and environment setup fine by
  509.        browsing following url
  510.  
  511.           http://www.your-site.com/your-cgi-dir/coocoo.cgi?action=test&datadir=data
  512.  
  513.        where
  514.           
  515.           http://www.your-site.com/your-cgi-dir/ is the url of directory where coocoo.cgi resides
  516.           data is value of coocoo's parameter in Applet tag (note: don't use slash)
  517.  
  518.  
  519.  
  520.  
  521.        If you get OK that means the environment in server side is OK.
  522.        Otherwise, you will get error messages and instructions to fix.   
  523.   
  524.  
  525.  
  526.    14). A list of errors:
  527.  
  528.        - If you get a message box pop up with "Document contains no data" or get
  529.          "java.io.IOException: Document contains no data" in your java console,
  530.          it may means that you didn't set coocoo.cgi to executable.
  531.          You may want to execute command
  532.  
  533.              chmod 755 coocoo.cgi 
  534.  
  535.          to make it executable in yout UNIX shell.
  536.  
  537.  
  538.        - If you get a message box pop up with "cant open File in create file: ..." or get
  539.          "List Item:cant open file6: ..." in your java console,
  540.          it may means that the directory that datadir specifies is not writable
  541.          You may want to execute command
  542.  
  543.              chmod 770 data 
  544.  
  545.          to make it writable in yout UNIX shell.
  546.          
  547.  
  548.        
  549.  
  550.  
  551.        Contact Mark Qian(ok@coolshare.com) if you get any problem.
  552.     
  553.        If you are not confortable with those buttons 
  554.        and news in CooCoo with Mark's info
  555.        you may want to get a registered shareware version.
  556.  
  557.  
  558.  
  559.        
  560.