           -= skWare's HTML Acey Duecy Game Online Documentation =-



skWare's HTML Acey Duecy Game Online Documentation


Release 1.00f

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


Introduction

   skWare's HTML Acey Duecy Game (skAceyDuecy) is a HTML Acey Duecy Game
   written in wcCode. 
   
   Usage of this software is covered by skWare's Software License which you
   should read at some stage and you should also check out skWare's Software
   Warranty. You may also want to check out the Trademarks page at some stage.
   
   
   You should definately read the Software History page. 
   
   You can also check out skWare Online for the latest information on this
   program and also the others written by skWare. 
   
   In this documentation we have assumed that Wildcat! has been installed on
   drive d: in the directory wc5 resulting in the fact that the default
   wildcat directory is d:\wc5, as this is how our development system is set
   up. Your system may not be set up like this. 




Upgrading to v1.00f

   To upgrade from v1.00e to v1.00f you should proceed as follows:- 
      
          * Copy the file html-skaceyd.wcx to your default wildcat
            directory. 
          * Copy the help.htm file to http\skware\template\aceyd\help.htm. 
      
   
   
   
   
   Upgrading to v1.00e
   
      To upgrade from v1.00c, v1.00d to v1.00e you should proceed as follows:-
      
         
             * Install the software as described below in the the section
               on installation. 
             * The configuration file has been changed so that the program
               uses the standard skWare configuration file skware.cfg. You
               will need to transfer the information from the old
               configuration file data\skaceyduecy.cfg manually with a text
               editor. This is explained in more detail in the section on the
               configuration file. 
             * All the files in the directory http\skware_images\cards can
               be deleted along with the directory itself. 
             * As the program has been renamed from html-skaceyduecy to
               html-skaceyd don't forget to change the links on your html
               pages that contain a link to html-skaceyduecy. 
             * Finally you can delete the following files as they are no
               longer used. They have all been specified releative to your
               default wildcat directory. (d:\wc5) 
                   * html-skaceyduecy.wcx 
                   * data\skaceyduecy*.* 
                   * http\skware_templates\skaceyduecy_*.htm 
               
         
      
   
   
   
   
   Upgrading to v1.00d
   
      To upgrade from v1.00c to v1.00d you should proceed as follows:- 
         
             * Unzip the archive into a temporary directory. 
             * Copy the file html-skaceyduecy.wcx to your default wildcat
               directory. 
             * As all of the footer templates have been modified to reflect
               the version change you can either copy them to the
               skware_templates directory or elect not to. 
         
      
   
   
   
   
   Upgrading to v1.00c
   
      To upgrade from v1.00a,v1.00b to v1.00c you should proceed as follows:- 
         
             * Unzip the archive into a temporary directory. 
             * Copy the file html-skaceyduecy.wcx to your default wildcat
               directory. 
             * Copy the file
               http\skware_templates\skaceyduecy_html_help.htm to the
               http\skware_templates directory if upgrading from v1.00a. 
             * Delete the following files from the http\skware_templates
               directory as they are no longer required if upgrading from
               v1.00a. 
                   * http\skware_templates\skaceyduecy_html_help_header.htm
                     
                   * http\skware_templates\skaceyduecy_html_help_footer.htm
                     
               
             * As all of the footer templates have been modified to reflect
               the version change you can either copy them to the
               skware_templates directory or elect not to. 
         
      
   
   
   
   
   Upgrading to v1.00b
   
      To upgrade from v1.00a to v1.00b you should proceed as follows:- 
         
             * Unzip the archive into a temporary directory. 
             * Copy the file html-skaceyduecy.wcx to your default wildcat
               directory. 
             * Copy the file
               http\skware_templates\skaceyduecy_html_help.htm to the
               http\skware_templates directory. 
             * Delete the following files from the http\skware_templates
               directory as they are no longer required. 
                   * http\skware_templates\skaceyduecy_html_help_header.htm
                     
                   * http\skware_templates\skaceyduecy_html_help_footer.htm
                     
               
             * As all of the footer templates have been modified to reflect
               the version change you can either copy them to the
               skware_templates directory or elect not to. 
         
      
   
   
   
   
   Installation
   
      To install skAceyDuecy you should follow these steps.
      
         
             * Unzip the package skad100f.zip into a temporary directory
               with a 32 bit unzip program such as unzip as shipped with
               WildCat.
               
             * Move the following files to your default WildCat directory
               (eg: d:\wc5). 
                  
                * html-skaceyd.wcx 
               
             * The rest of the files supplied in the package are in
               relative directories and should be moved as follows:- 
                  
                  Source Directory            Example Destination Directory 
                                                                            
                  data                        d:\wc5\data                   
                  http\skware\ol_docs\aceyd   d:\wc5\http\skware\ol_docs\ace 
                  http\skware\images          d:\wc5\http\skware\images     
                  http\skware\images\cards    d:\wc5\http\skware\images\card 
                  http\skware\template\aceyd  d:\wc5\http\skware\template\ac 
                  
               
             * Next you should edit the configuration file skware.cfg as
               explained in the section on the configuration file. 
               
             * Add one or more links to the game on the pages that you
               want. An example of the link required is as follows:-
               
                  <a href="/code/html-skaceyd.wcx?Mode=Deal"<b>Skware's HTML
                  Acey Duecy Game</b></a> 
               
               
         
      
   
   
   
   
   Configuration File
   
      The operation of the game is controlled by the configuration file. This
      configuration file is called skware.cfg and must be in your WildCat data
      directory (d:\wc5\data). This file is in the process of being setup so
      that it is shared by all of skWare's programs as the single source of
      configuration information. An example file has been shipped with the
      package called skware.cfg.dist which can be used as an example. 
      It is an 'ini' type file the contents for the [skaceyduecy] section are
      described in the following table. 
         
         Parameter      Description                                         
         RegCode        Once registered this parameter should contain your  
                        registration code as supplied by skWare. In the     
                        shareware version this should contain the word      
                        "SHAREWARE" without the quotes.                     
         StartPoints    This is the number of points given to a new player. 
                        It is also the number of points given to a player   
                        when they start a new day with no points.           
         GamesPerDay    This is the number of games a player is allowed per 
                        day. If this is set to 0 then the games allowed per 
                        day is unlimited.                                   
         HomePageLink   This is the link to your home page. It is used by   
                        the Home button so that the user can return quickly 
                        to you home page.                                   
         BackPageLink   This is the link used by the back button so the     
                        user can return quickly to the page that called the 
                        query program.                                      
         
      
   
   
   
   
   HTML Template Customisation
   
      All of the templates used by the game are totally customisable. The
      templates supplied are in the http\skware\template\aceyd directory and
      are used as per the following table. 
         
         Template File  Used By                                             
         help.htm       This template is the help paged displayed to the    
                        user when they use the help button.                 
         lost.htm       This template is used when the user looses a game.  
         main.htm       This template is the main template used by the      
                        game.                                               
         nogames.htm    This template is used when the user has no more     
                        games left for the day.                             
         nopoints.htm   This template is used when the user has no more     
                        points left for the day.                            
         won.htm        This template is used when a game has been won and  
                        the user did not make it to the top ten.            
         won10.htm      This template is used when a game has been won and  
                        the user has made it to the top ten.                
         topten.htm     This template is used when displaying the top ten.  
         
      
   




Changing the Graphics

   If you want you can change the graphics used by the program by either
   modifying the supplied gif's or creating your own and replacing the
   supplied gif's. All of the gifs for the cards are in the directory
   http\skware\images\cards. 





Registration

   To Register skAceyDuecy print the file register.txt fill it in, and send it
   and the required amount to the following address:-
   
      skWare
      PO Box 9559
      Wellington
      NEW ZEALAND
      
   If you want to pay by Credit Card (either Mastercard or Visa) to can either
   print the file ccreg.txt fill it in and send to the address above or fill
   in the form and email it to skWare. 
   
   You can also register online at skWare Online - Online Registration. 


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

             Copyright (c) 1997-1998 skWare, All Rights Reserved
                                       

