

                       -------------------------
                              skSaw  (tm)
                             Version 1.00d
                     a wcCode Scratch and Win Game
                          for Wildcat! 5 BBS
                       -------------------------


                       (c) Copyright 1996 skWare
                          All Rights Reserved

                              skWare (tm)

                   Steve Davies (steve@welcom.gen.nz)                      
                   Kevin Murphy (kevin@welcom.gen.nz)

*****  For technical support please email to sksaw@welcom.gen.nz *****

The NAG screen is disabled with registration.

Statistic Display is available in the rgistered version.

It will work on a Wildcat 5 BBS Release version.

Do not try installing this software on a Wildcat 4 BBS.

                 Documentation version 1.00d 29/07/1996

* By using this software you agree to the terms of the Software License
Agreement and Disclaimer of Warranty. *

Contents
--------
1.  Overview
2.  Future Plans for skSaw
3.  Registration
4.  Files
5.  Overview of Installation
6.  Detailed Installation Instructions
7.  Game Types
8.  Navigator Support
9.  Multi Language Support
10. Error Codes
11. Bug reports and Enhancement Requests
12. Software License Agreement
13. Disclaimer of Software Warranty



1.  Overview
------------
skSaw is a Scratch and Win program for the entertainment of BBS user's.

All of the menus and screens are normal Wildcat *.bbs screens and can be
customised for your BBS using wcDraw.  The ones supplied are a bit dry,
however they integrate nicely with the default Wildcat Menu screens.

All functions can be launched from the Navigator. Example HTML pages
for user functions are included with the distribution.

2.  Future Plans for skSaw
--------------------------

    Once Mustang have released their Wildcat! sdk we will be looking
    at developing a system that does not need to load the terminal
    client as we have to do a present to support Navigator users.

3.  Registration
----------------
Registration will remove ALL nag screens and enable the statistics display
function.

All that is required to register skSaw is that you print the file
register.txt, fill in the missing parts and send it and US$10 to:-

    skWare
    PO Box 9559
    Wellington
    New Zealand

Once we have received your registration request we will email you the
registration key. Please ensure that you have included your EMAIL
ADDRESS as required in our form. If you do not we will not be able
to send your registration key to you.

4.  Files
---------
The following files are included in the archive that you downloaded.

skware.txt             <--- important information about skWare
sysop.txt              <--- you are reading it now
history.txt            <--- the file that has notes about changes etc.
register.txt           <--- the file that has notes about registration
skware_olgames1.bbs    <--- skWare Game Menu screen for users with a
                            security profile containing security display
                            1 (newuser in default Wildcat installation)
skware_olgames5.bbs    <--- skWare Game Menu screen for users with a
                            security profile containing security display
                            5 (registered in default Wildcat
                            installation)
skware_olgames9.bbs    <--- skWare Game Menu screen for users with a
                            security profile containing security display
                            9 (sysop in default Wildcat installation)
sksaw.wcx              <--- THE executable program for the game
sksaw_p.wcx            <--- executable program to play game
sksaw_s.wcx            <--- executable program to display statistics
sksaw.cfg              <--- Plain text format config file
skware_help_onlinegames.bbs <--- skWare Main help file for online games
skware_help_onlinegames_saw.bbs <--- Help file for Scratch and Win
sksaw.reg              <--- Default registration file
fileid.diz             <--- Long program description
desc.sdi               <--- Short program description
sksaw_language.txt     <--- configuration file for multi language support
sksaw_*.prm            <--- prompt files for multi language support
skware_*.prm           <--- standard prompt files for multi language support
sksaw_default.htm      <--- example default.htm for navigator support
skware_olgames.htm     <--- example online games html page

5.  Overview of Installation
----------------------------
 NOTE: Please make sure your BBS is configured and running correctly
       before installing skSaw. A full system backup would also be
       a good idea.

You will need to unzip the archive and put the files in their respective
directories (see detailed instructions following.  You will then need to
edit the config file using a text editor.

Installation of skSaw requires a number of steps, however most should
be familiar to you as it is really mostly a case of simply setting up a
Games Menu using wcMenu, and then adding the option for the game to
this menu.

You may then wish to edit the supplied menu screens and display screens
to fit with the theme of your BBS, and to delete any menu items for
commands that you have not installed.

If you have a BBS that the default language is not english or that has
more than one language then you will also need to alter the sksaw_*.prm
files that have been supplied. Please see section 9 for further
information.

6.  Detailed Installation Instructions
--------------------------------------
- Package Installation

    1 - Create a subdirectory for skSaw where you wish.  We suggest
        c:\wc5\sksaw or something similar.

    2 - Extract all the files from the archive into this directory.
    
    3 - Move the following files into the wildcat home directory
        (eg: c:\wc5)

        sksaw.cfg
        sksaw.wcx
        sksaw_p.wcx
        sksaw_s.wcx

    4 - Create a subdirectory for skSaw database files where you wish.
        Again we suggest c:\wc5\sksaw\database or something similar.

    5 - Edit the sksaw.cfg as follows:-

        line 1 => version control string
        line 2 => the absolute path to the registration file. The default
                  is c:\wc5\sksaw\sksaw.reg
        line 3 => the absolute path to the sksaw database. The default is
                  c:\wc5\sksaw\database\
        line 4 => flag for logging in activity logs Y
                  or N (Y)
        line 5 => flag for logging in the file
                  sksaw.log Y or N (Y)
        line 6 => Game type 1..4 (4), please see section 7 for a discussion
                  of game types.

    6 - Move all the sksaw_help*.bbs files into the help file
        directory. (c:\wc5\help).
        
    7 - Move all the menu files (skware_olgames*.bbs) into the menu
        file directory. (c:\wc5\menu).

    8 - Move the file sksaw_language.txt to the default language directory
        (c:\wc5\language)

    9 - Move all the sksaw_*.prm files to the default language directory
        (c:\wc5\language)

- Menu Configuration

    skSaw uses the standard wildcat menu system. This allows the sysop
    the maximum flexibilty in set up of skSaw. What follows is what
    the authors have done while testing skSaw and should be used as a
    guide on how skSaw can be set up.

    - Start wcMenu and create a new menu called "ON LINE GAMES".

        - Description       = On Line Games
        - Display Name      = skware_olgames

        - do not forget access profiles

    - Add menu item to main menu as follows:-

        - Selection Key     = O
        - Description       = [O]...On Line Games
        - Command Type      = Goto Menu
        - Menu              = On Line Games

    - You can also add this item to any other menu you want by using	
      wcMENU.

    - Add standard menu items to the ON LINE GAMES menu as follows:-

        - Selection Key     = Q
        - Description       = [Q]...Quit to the Main Menu
        - Command Type      = Goto Menu
        - Menu              = Main Menu

        - Selection Key     = Y
        - Description       = [Y]...Your Settings
        - Command Type      = Run wcCODE Program
        - Program           = Change user settings

        - Selection Key     = H
        - Description       = [H]...Help level
        - Command Type      = Run wcCODE Program
        - Program           = Change help level

        - Selection Key     = G
        - Description       = [G]...Goodbye & logoff
        - Command Type      = Run wcCODE Program
        - Program           = Log off

        - Selection Key     = ?
        - Description       = [?]...Command help
        - Command Type      = Run wcCODE Program
        - Program           = Display help file
        - Parameter         = skware_help_onlinegames.bbs

    - Add skSaw menu item to ON LINE GAMES menu

        - Selection Key     = S
        - Description       = [S]...Scratch And Win
        - Command Type      = Run wcCODE Program
        - Program           = sksaw_p
          [Access] - Enable access to security levels allowed to this
                     game

    - Add skSaw statistics display senu item to ON LINE GAMES menu

        - Selection Key     = SS
        - Description       = [SS]...Scratch And Win Statistics
        - Command Type      = Run wcCODE Program
        - Program           = sksaw_s
          [Access] - Enable access to security levels allowed to this
                     game

    - Remember access profiles

    - Use wcDRAW to modify the appropriate main menu display file and to
      include the O option for ON LINE GAMES. If you have added the ON
      LINE GAMES menu option to other menus do not forget to update them
      as well.

    - Rename the skware_onlinegamesX.bbs files to match your security
      levels. Out of the box you will find the following three files:-

        - skware_onlinegames1.bbs     for "New Users"
        - skware_onlinegames5.bbs     for "Registered"
        - skware_onlinegames9.bbs     for "Sysop"

        - These use the same security levels as the default WildCat
          distribution.

7.  Game Types
--------------

skSaw supports 4 different game types. The difference between each is the
theoretical return for users of the game. The game types are discussed
below:-

        /- Number Of Tickets That Can Win --\
Game                                                   Win      Approx
Type    60Min   30Min   15Min   10Min   5Min    Lost   Odds     %Return

 1      2       6       16      24      84      892   1 : 7.76  23.4%
 2      4       12      32      48      168     760   1 : 3.88  46.8%
 3      6       18      48      72      252     628   1 : 2.59  70.3%
 4      8       24      64      96      336     496   1 : 2.28  93.8%

As can be seen from the above table the higher the game type, the more
winning tickets and the better the chance that the user will get a
winning ticket.

Each game has 1024 tickets and the winning tickets are picked at random.
Once all 1024 tickets have been picked, an new game is started.

8.  Navigator Support
---------------------

To allow a user to use sksaw from navigator we have supplied three files
as an example of what can be done. To set sksaw up for Navigator you can
follow the procedure below:-

- Add the scratch and win html link to your default html pages as
  required. An example has been supplied (sksaw_default.htm) with the
  two additions and one change marked. The example supplied is the
  standard default.htm supplied with the WildCat! distribution modified
  by us to test navigator support.

- Copy the supplied file skware_olgames.htm to the public directory
  (c:\wc5\http\public)

Please note, that the above is only an example of what can be done with
html. You are only limited by your imagination.

9.  Multi Language Support
--------------------------

To allow for support of multiple languages we have provided a group of
files that can be customised by the sysop to support another language
other than english. To setup another language proceed as follows:-

- Start languages from wcConfig. Clone the default language to another
  language eg. German.

    - Name          = German
    - Description   = German

- Exit the config menu and stop wcServer.

- Copy sksaw_language.txt from the default language directory to
  language\german directory

- Copy sksaw_*.prm from the default language directory to
  language\german directory

- Copy skware_*.prm from the default language directory to
  language\german directory

- You will also need to copy the sksaw files from the help directory
  to the help\german directory

- You will also need to copy the sksaw files from the menu directory
  to the menu\german directory

  Note: the ..\german directories were created by the language program in
  wcConfig.

- Start wcServer

Once this has been done we should have a directory structure similar to what
is described below. (See page 163 of the WildCat System Operator Guide for
further information).

    c:\wc5\help
    c:\wc5\help\german
    c:\wc5\menu
    c:\wc5\menu\german
    c:\wc5\language
    c:\wc5\language\german

- Use wcDraw to modify the sksaw files in the help\german directory. When
  you start wcDraw you will be asked to pick a language. Use German.

- Use wcDraw to modify the sksaw files in the menu\german directory. When
  you start wcDraw you will be asked to pick a language. Use German.

- You will need to modify sksaw_language.txt in the language\german to
  suit your requirement. This file allows you to specify key letters etc.
  that controls the operation of sktbank. For example you can specify that
  "Ja" is the string for yes and that the key to be pressed is "J" when
  a yes response is required. Details of the file contents is below:-

    sktbank_language.txt

        - This file contains various characters that control the operation
          of sksaw in a multi language environment. It contains the
          following information:-

            line  1 => Version control (skSaw-V1.xx)
            line  2 => character used for Yes response
            line  3 => character used for No response

- The next thing you will need to do is to modify the sksaw_*.prm files
  to your language. While you can use wcDraw to do this we have found that
  going through the directory with Windows Explorer and Notepad is faster.

  The files are described below:-

    sksaw_err101.prm
        - message displayed when skSaw could not create stats file

    sksaw_err102.prm
        - message displayed when skSaw could not open stats file

    sksaw_err103.prm
        - message displayed when skSaw could not load game file

    sksaw_err104.prm
        - message displayed when skSaw could not save game file

    sksaw_gametype1.prm
        - intro displayed to user when they first start skSaw in game
          type 1 mode

    sksaw_gametype2.prm
        - intro displayed to user when they first start skSaw in game
          type 2 mode

    sksaw_gametype3.prm
        - intro displayed to user when they first start skSaw in game
          type 3 mode

    sksaw_gametype4.prm
        - intro displayed to user when they first start skSaw in game
          type 4 mode

    sksaw_header1.prm
        - play game header

    sksaw_question1.prm
        -  "Would you like to buy a ticket ?"

    sksaw_question2.prm
        - "Would you like to play again ?" prompt

    sksaw_results_header.prm
        - draw results header

    sksaw_startup_header.prm
        - startup header

    sksaw_statistics_header.prm
        - statistics header

    sksaw_statistics.prm
        - statistics display screen
            - SUB1 = Games Played
            - SUB2 = Number of lost games
            - SUB3 = Number of  5 minute wins
            - SUB4 = Number of 10 minute wins
            - SUB5 = Number of 15 minute wins
            - SUB6 = Number of 30 minute wins
            - SUB7 = Number of 60 minute wins

    sksaw_title1.prm
        - title in middle of screen displayed before gametype
          prompt

    sksaw_title2.prm
        - title in middle of screen displayed before sksaw_winX
          includes time left for user

    sksaw_win0.prm
        - displayed when user looses

    sksaw_win10.prm
        - displayed when user wins 10 minutes

    sksaw_win15.prm
        - displayed when user wins 15 minutes

    sksaw_win30.prm
        - displayed when user wins 30 minutes

    sksaw_win5.prm
        - displayed when user wins 5 minutes

    sksaw_win60.prm
        - displayed when user wins 60 minutes

The final thing you will need to do is edit the standard skWare prompt files
(skware_*.prm) in the language directory. The contents of these files are
described inb the file skware_std_prompts.txt. The standard prompt files used
by skSaw are as follows:-

    - skware_err01.prm
    - skware_err02.prm
    - skware_err03.prm
    - skware_err04.prm
    - skware_registered_to.prm

10. Error Codes
---------------

- Most if not all of the error message numbers and codes have been
  changed from the beta release. We have also assigned error codes
  to all errors to allow for easy conversion to other languages.

- The following fatal errors codes are issued and then skSaw will
  halt. If you experience any of them and can not resolve the problem
  please see the section on bug reporting.
  
    ERR01 Could not find configuration file
        - skSaw could not find the configuration file in the default
          wildcat directory.
        
    ERR02 Could not find registration file
        - skSaw could not read the registration file. Is the path
          in line 2 of the config file correct.

    ERR03 Could not find language file
        - skSaw could not find the file sksaw_language.txt in the
          default language directory.

    ERR04 This option is only available in the registered version
        - You tried to use an option that is only available in the
          registered version of skSaw.
    
    ERR101 Could not create stats file
        - skSaw could not create the statistics file. Is the path in
          line 3 of the config file correct.
        
    ERR102 Could not open stats file
        - skSaw could not open the statistics file. Is the path in
          line 3 of the config file correct.

    ERR103 Could not read game file
        - skSaw could not read the game file. Is the path in line
          3 of the config file correct.

    ERR104 Could not save game file
        - skSaw could not read the game file. Is the path in line
          3 of the config file correct.

11. Bug Reports and Enhancement Requests
----------------------------------------

- Bug Reporting

    - When reporting a bug please include the following information and
      email to us at sksaw@welcom.gen.nz.

        - Operating system and version
        - Version of Wildcat 5
        - Details of any LAN (eg: are files on a NetWare 3.11 server)
        - Description of problem
        - Description of the installation that you have done
        - Copy of your sksaw.cfg
        - Your email address
        - Any other relevent info

    - If you want to fax the bug report then send an email to the
      following email address sksaw@welcom.gen.nz requesting the fax
      number. We have had to do this as the fax number is currently in a
      state of flux and will change from what it is now.

- Enhancement Requests

    - If you have an idea or request for an enhancement please send an
      email to sksaw@welcom.gen.nz. While all such requests should be
      acknowledged as received within 48 hours we can not state that
      they will be accepted for a further release.
    
    - We are always ready to discuss any customisation requirements that
      you may have. For further information send an email to
      sksaw@welcom.gen.nz with a brief description of your
      requirements.
    
    - For faxes please see the Bug Reporting section about our fax
      number.

12.   SOFTWARE LICENSE AGREEMENT
--------------------------------
This software is LICENSED not sold.

 You may:
 --------
 (1) Make as many backups as you see fit to protect your investment.
 (2) Use this software on a single BBS for a 30 day trial period, after 
     which it must be registered.  If you run more than one BBS you must
     register additional copies of this software.
 (3) Distribute copies of the unregistered version of this software as
     long as all of the original files (listed in section 4) are included
     and are unaltered.

 Besides the above rights you have no other rights to the software,
 implied or otherwise.

 You may NOT:
 ------------
 (1) Reverse-Engineer, Decompile or Alter the software in any way.
 (2) Rent, Lease or Lend the software that you have registered.
 (3) Give out or let anybody use your software activation code.

 If you breach this License Agreement, skWare will terminate your
 license and all software must be de-installed from your system(s) and
 use of the software must be terminated.

13.  DISCLAIMER OF SOFTWARE WARRANTY
------------------------------------

 THIS SOFTWARE PRODUCT IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND.
 THE ENTIRE RISK AS TO THE RESULTS AND PERFORMANCE OF THIS SOFTWARE IS
 ASSUMED BY YOU (NOT skWare). skWare DOES NOT WARRANT, GUARANTEE, OR
 MAKE ANY REPRESENTATIONS REGARDING THE USE OF, RESULTS OF,
 MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE OF THIS SOFTWARE.
 SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU (NOT skWare) ASSUME THE ENTIRE
 COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION EVEN IF skWare
 HAS BEEN NOTIFIED OF A DEFECT(S). skWare DOES NOT WARRANT, GUARANTEE,
 OR MAKE ANY REPRESENTATIONS REGARDING THE USE OF, OR RESULTS OF THE USE
 OF THE SOFTWARE IN TERMS OF CORRECTNESS, ACCURACY, RELIABILITY, OR
 OTHERWISE. YOU RELY ON THE SOFTWARE AND RESULTS SOLELY AT YOUR OWN
 RISK. skWare WILL NOT BE LIABLE FOR ANY DAMAGES, INCLUDING BUT NOT
 LIMITED TO SYSTEM DAMAGE, SERVICE, REPAIR, CORRECTION, LOSS OF PROFIT,
 LOST SAVINGS, OR ANY OTHER INCIDENTAL, CONSEQUENTIAL, OR SPECIAL
 DAMAGES OF ANY NATURE WHATSOEVER RESULTING FROM THE USE OR THE
 INABILITY TO USE THIS SOFTWARE.

 THE DISCLAIMER OF WARRANTY SHALL BE GOVERNED BY THE LAWS OF NEW
 ZEALAND.

========================================================================

             Copyright (C) skWare 1996, all rights reserved

    skSaw is a trademark of skWare.
    skWare is a tradmark of skWare.

    WildCat! is a trademark of Mustang Software Inc.

    Other products and corporate names may be trademarks or registered
    trademarks of other companies, and are used for illustrative
    purposes only, and to the owners benefit, without an intent to
    infringe.

========================================================================

