            -= skWare's HTML Hang Man Game Online Documentation =-



skWare's HTML Hang Man Game Online Documentation


Release 1.00h

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


Introduction

   skWare's HTML Hang Man Game (skHangMan) is a hangman game that uses a
   browser. The sysop can modify all html templates used by the game. In the
   registered version the sysop can add their own words. The word list
   supplied has over 25,000 words. 
   
   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 - v1.00h

   To upgrade from v1.00g to v1.00h you should 
       * Copy the html-skhman.wcx to your default wildcat directory. 
       * Copy the data\skhman_wordlist.* files to your wildcat data
         directory. 
       * Copy the supplied template files to
         http\skware\template\hman\*.htm as they have been changed to cater
         for average scoring. 
       * You must DELETE the following files for you data directory as the
         structure has changed and the program is likely to crash. 
             * skhman_tt.dat 
             * skhman_ud*.dat 
         The following parameters can be removed from the skhangman section of
         skware.cfg. 
             * StartPoints 
             * PointsLost 
         
      
         To upgrade from earlier versions to v1.00h you should follow the
         v1.00g upgrade procedure below and then apply the modifications
         above. 
      
      
      
      
      Upgrading - v1.00g
      
         To upgrade from v1.00f to v1.00g you should 
             * Copy the html-skhman.wcx to your default wildcat directory. 
             * Copy the data\skhman_wordlist.* files to your wildcat data
               directory. 
             * Change the paremeter QuestionsPerDay to GamesPerDay in the
               skhangman section of skware.cfg. 
            
               To upgrade from earlier versions to v1.00g you should follow
               the v1.00f upgrade procedure below and then apply the
               modifications above. 
            
            
            
            
            Upgrading - v1.00f
            
               To upgrade from v1.00a,v1.00b, v1.00c, v1.00d, v1.00e to v1.00f
               you should 
                   * Install the program as covered in the section on
                     installation. 
                   * Transfer the information from the present
                     configuration file data\skhangman.cfg to the new
                     configuration file skware.cfg. There are some new
                     parameters that will also need specifying namely,
                     StartPoints, QuestionsPerDay, PointsLost and PointsWin.
                     Please see the section on configuration for further
                     information. 
                   * If you have modified the images used by the game you
                     will need to copy your changed files into the new image
                     directory namely http\skware\images\hman. Please note
                     that the new image files have had the skhangman_ part of
                     their name removed as they now have their own directory. 
                   * If you have custom headers and or footers then you
                     will need to modify the new templates as they have now
                     been combined into one file. Please see the section on
                     html customisation for further information. 
                   * As the name of the program has changed from
                     html-skhangman to html-skhman you will need to change any
                     links you have to the program to reflect this. 
                   * Finally the following files can be deleted (they are
                     all relative to your wc5 directory):- 
                         * html-skhangman.wcx 
                         * data\skhangman.cfg 
                         * data\skhangman.ctl 
                         * data\skhangman_* 
                         * http\skware_images\skhangman*.gif 
                         * http\skware_templates\skhangman*.htm 
                     
                  
                  
                  
                  
                  Upgrading - v1.00e
                  
                     To upgrade from v1.00a,v1.00b, v1.00c, v1.00d to v1.00e
                     you should install the program as covered in the next
                     section.
                     If you are upgrading from an earlier version than v1.00c
                     you will need to delete the top ten file
                     data\skhangman_topten.dat as the top ten stuff was not
                     working correctly in v1.00a and v1.00b and needs to be
                     reset. 
                  
                  
                  
                  
                  Installation
                  
                     To install skHangMan you should follow these steps.
                     
                        
                            * Unzip the package skhm100h.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-skhman.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\h d:\wc5\http\skware\ol 
                                 http\skware\images   d:\wc5\http\skware\im 
                                 http\skware\images\hm d:\wc5\http\skware\im 
                                 http\skware\template\ d:\wc5\http\skware\te 
                                 
                              
                            * 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
                              requirted is as follows:-
                              
                                 <a
                                 href="/code/html-skhman.wcx?Mode=New+Game"<b>S
                                 kware's HTML Hang Man 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
                     [sknextcard] 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.                 
                        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 
                                       your 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.                      
                        PointsWin      This is the number of points won by 
                                       a player if they win a game.        
                        
                     
                  
                  
                  
                  
                  HTML Template Customisation
                  
                     All of the templates used by the game are totally
                     customisable. The templates supplied are in the
                     http\skware\template\hman 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 a game   
                                       has been lost by the user.          
                        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. 
                                                                           
                        topten.htm     This template is used when          
                                       displaying the top ten.             
                        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.                  
                        
                     
                  
                  
                  
                  
                  Adding Your Own Words
                  
                     In the registered version of the game you can add and
                     delete your own words. All that you have to do is edit
                     the file data\skhman_wordlist.txt with any normal editor
                     and make the changes you want. The next time the game is
                     started it will detect the changes made and update the
                     data file. 
                  
                  
                  
                  
                  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. The
                     table below describes the gif's supplied which are all in
                     http\skware\images\hman. 
                        
                        Gif File      When Used                            
                        00wrong.gif   This gif is displayed when the user  
                                      has supplied no wrong guesses.       
                        01wrong.gif   This gif is displayed when the user  
                                      has 1 wrong guess.                   
                        02wrong.gif   This gif is displayed when the user  
                                      has 2 wrong guesses.                 
                        03wrong.gif   This gif is displayed when the user  
                                      has 3 wrong guesses.                 
                        04wrong.gif   This gif is displayed when the user  
                                      has 4 wrong guesses.                 
                        05wrong.gif   This gif is displayed when the user  
                                      has 5 wrong guesses.                 
                        06wrong.gif   This gif is displayed when the user  
                                      has 6 wrong guesses.                 
                        07wrong.gif   This gif is displayed when the user  
                                      has 7 wrong guesses.                 
                        08wrong.gif   This gif is displayed when the user  
                                      has 8 wrong guesses.                 
                        09wrong.gif   This gif is displayed when the user  
                                      has 9 wrong guesses.                 
                        10wrong.gif   This gif is displayed when the user  
                                      has 10 wrong guesses. They are also  
                                      dead at this point and the game is   
                                      over.                                
                        
                     
                  
                  
                  
                  
                  Registration
                  
                     To Register skHangMan 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
                                              
               
               