

                       -------------------------
                                sktBank
                           Version 0.10 Beta
                           a wcCode Time Bank
                           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 sktbank@welcom.gen.nz *****

This is a beta version with all features enabled.  It will work only on
a Wildcat 5 BBS Gamma 4 system or later.  Do not try installing this
software on a Wildcat 4 BBS.


                       Documentation version 0.10

* 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 sktBank
3.  Registration
4.  Files
5.  Overview of Installation
6.  Detailed Installation Instructions
7.  Error Codes
8.  Bug reports and Enhancement Requests
9.  Software License Agreement
10. Disclaimer of Software Warranty



1.  Overview
------------
sktBank is designed to allow maximum flexibility.  For example if you
run an entertainment type of BBS, you can install the Time Bank Menu so
that it is available from the Main Menu, and then when your callers go
to the Time Bank, they will find a lot of "Bank" functions to play with.

User functions currently include:
    Open Account
    Deposit Time
    Withdraw Time
    Account Status
    Loan Application
    Rob Bank

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.

If you are running a lean and mean unix command line type system, you
can delete all of the supplied menus and screens and simple text only
ones will be dynamically generated.

If you are running a product support BBS, or any other system where the
entertainment aspect is inappropriate, you can install a sub-set of the
user functions.  Eg you could use wcMenu to install the Deposit Time and
Withdraw Time functions directly into the Main Menu and disregard the
rest.  Note that there is an option in the config file to turn off the
requirement to open an account first.

2.  Future Plans for sktBank
----------------------------
We are already working on a new and improved version for distribution
soon. Key features of the new version will be:-

    The inclusion of an Account Editor for the SysOp
    HTML interface for Navigator Browser client
    Reporting options for the SysOp to monitor usage
    User option to transfer time to another account
    Other SysOp options

If you have any suggestions for other features that you would like to
see then please let us know.

3.  Registration
----------------
Registration will remove ALL nag screens.

This first version of sktBank can be registered for FREE.  All you need
to do is to email us the following information:
    Wildcat! Registration Number
    BBS Name (as entered into wcConfig)
    SysOp name

Send email to sktbank@welcom.gen.nz

Be sure to send the above information from a valid Internet email
address so that we can reply with your resgistration code.

We will keep your email address and contact you when the next version is
available.

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

sysop.txt              <--- you are reading it now
sktbank_mainmenu1.bbs  <--- sktBank Main Menu screen for users with a
                            security profile containing security display
                            1 (newuser in default Wildcat installation)
sktbank_mainmenu5.bbs  <--- sktBank Main Menu screen for users with a
                            security profile containing security display
                            5 (registered in default Wildcat
                            installation)
sktbank_mainmenu9.bbs  <--- sktBank Main Menu screen for users with a
                            security profile containing security display
                            9 (sysop in default Wildcat installation)
sktbank_open.bbs       <--- BBS screen displayed to callers when they
                            first open an account
sktbank_loan.bbs       <--- BBS screen displayed to callers when they
                            apply for a loan before they are left to
                            enter a message to the sysop
sktbank_robok.bbs      <--- BBS screen displayed to callers who have
                            successfully robbed the bank
sktbank_robbery_ok.bbs <--- BBS screen displayed to callers who have
                            tried unsuccessfully to rob the bank, but
                            who got away
sktbank_caught.bbs     <--- BBS screen displayed to caller who tried to
                            rob the bank, but got caught and fined.
sktbank.wcx            <--- executable program for the time bank
sktbank_sysop.wcx      <--- second copy of the program which may be
                            assigned a different access level (see note
                            in "wcMenu Security" below)
sktbank.cfg            <--- Plain text format config file
sktbank_help.bbs       <--- Main help file
sktbank_help_open.bbs  <--- Help file for "Open Account"
sktbank_help_account.bbs    Help file for "Account Status"
sktbank_help_deposit.bbs    Help file for "Deposit Time"
sktbank_help_withdraw.bbs   Help file for "Withdraw Time"
sktbank_help_loan.bbs  <--- Help file for "Loan Application"
sktbank_help_rob.bbs   <--- Help file for "Rob Bank"
sktbank.reg            <--- Default registration file
fileid.diz             <--- Long program description
desc.sdi               <--- Short program description

5.  Overview of Installation
----------------------------
 NOTE: Please make sure your BBS is configured and running correctly
       before installing sktBank.

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 sktBank require a number of steps, however most should
be familiar to you as it is really mostly a case of simply setting up a
Time Bank Menu using wcMenu, and then adding the options for the
commands that you wish to offer your callers.

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.

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

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

    2 - Extract all the files from the archive into this directory.
    
    3 - Move sktbank.wcx, sktbank_sysop.wcx and sktbank.cfg into the 
        wildcat home directory (eg: c:\wc5)
    
    4 - Create a subdirectory for skTBANK database files where you wish.
        Again we suggest c:\wc5\sktbank\database or something similar.

    5 - Edit the sktbank.cfg as follows:-
    
        line 1 => the absolute path to the registration file. The default
                  is c:\wc5\sktbank\sktbankn.reg
        line 2 => the absolute path to the sktbank database. The default is
                  c:\wc5\sktbank\database\
        line 3 => the absolute path to the display files. The default is
                  c:\wc5\disp\
        line 4 => flag for logging in activity logs Y
                  or N (Y)
        line 5 => flag for logging in the file
                  sktbank.log Y or N (Y)
        line 6 => does user need to
                  open an account before use N or N (N)
        line 7 => max minutes that user can withdraw (60)
        line 8 => max minutes user allowed in bank (120)
        line 9 => counter for robbing bank ok
        line 10 => time for robbing bank ok
        line 11 => counter for robbing bank fine
        line 12 => time for robbing bank fine
        
        If you specify Y in line 3 (activity logs) then information will
        be written to the node activity log. (eg. activity.1 for node
        1).
        
        If you specify Y in line 4 (sktbank.log logging) then
        information will be written to the log file "sktbank.log" in the
        default WildCat directory on the machine that runs wcServer.
        This has the advantage over activity logs in that all
        information is logged into one file. You must be aware that this
        log is not truncated in any way.

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

    8 - Move all the display files (the remaining *.bbs files) into the
        disp file directory (c:\wc5\disp).

- Menu Configuration

    skTBANK uses the standard wildcat menu system. This allows the sysop
    the maximum flexibilty in set up of skTBANK. What follows is what
    the authors have done while testing skTBANK and should be used as a
    guide on how skTBANK can be set up.
    
    - Start wcMenu and create a new menu called "TIME BANK".

        - do not forget access profiles

    - Add menu item to main menu as follows:-

        - Selection Key     = T
        - Description       = [T]...Time Bank
        - Command Type      = Goto Menu
        - Menu              = Time Bank

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

    - Add standard menu items to the TIME BANK 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         = sktbank_help.bbs

    - Add skTBANK menu items to TIME BANK menu

        - Selection Key     = A
        - Description       = [A]...Account status
        - Command Type      = Run wcCODE Program
        - Program           = sktbank
        - Parameter         = A
          [Access] - Enable access to security levels allowed to use
                     the bank

        - Selection Key     = C
        - Description       = [C]...Display Configuration
        - Command Type      = Run wcCODE Program
        - Program           = sktbank_sysop
        - Parameter         = C
          [Access] - Enable access to the SysOp security level

        - Selection Key     = D
        - Description       = [D]...Deposit time
        - Command Type      = Run wcCODE Program
        - Program           = sktbank
        - Parameter         = D

        - Selection Key     = W
        - Description       = [W]...Withdraw time
        - Command Type      = Run wcCODE Program
        - Program           = sktbank
        - Parameter         = W

        - Selection Key     = L
        - Description       = [L]...Loan application
        - Command Type      = Run wcCODE Program
        - Program           = sktbank
        - Parameter         = L

        - Selection Key     = O
        - Description       = [O]...Open Account
        - Command Type      = Run wcCODE Program
        - Program           = sktbank
        - Parameter         = O
  
        - Selection Key     = R
        - Description       = [R]...Rob Bank
        - Command Type      = Run wcCODE Program
        - Program           = sktbank
        - Parameter         = R

    - Remember access profiles

    - Use wcDRAW to modify the appropriate main menu display file and to
      include the T option for TIME BANK. if you have added the TIME
      BANK menu option to other menus do not forget to update them as
      well.

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

        - sktbank_mainmenu1.bbs     for "New Users"
        - sktbank_mainmenu5.bbs     for "Registered"
        - sktbank_mainmenu9.bbs     for "Sysop"

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

- wcMENU security

    The wcMENU security system seems to assign a set of access profiles
    to a certain program. If you want to have say new user's to be only
    able to access one option on a menu (eg Open account) then you need
    to create another program to run. All that is required is for you to
    copy sktbank.wcx to another file (eg. sktbank_newuser.wcx) and use
    this as the program to run. This is what we have done for the sysop
    configure option. (ie. we copied sktbank.wcx to sktbank_sysop.wcx to
    create the program for Sysop's to run for the C)onfiguration Display
    option.


7.  Error Codes
---------------

- The following fatal errors codes are issued and then skTBANK will
  halt. If you experience any of them and can not resolve the problem
  please see the section on bug reporting.
  
    ERR01 Sorry not configured correctly
    
        - skTBANK could not find the two parameters required. ie
          configuration path name and the option letter are not
          specified correctly. Have you remembered the space between the
          config file name and the option code ?
          
    ERR02 Could not find configuration file
    
        - skTBANK could not find the configuration file specified in
          parameter one.
        
    ERR03 Could not find registration file
    
        - skTBANK could not find the registration file specified in
          line one of the configuration file.

    ERR04 Could not create user account
    
        - skTBANK could not create the user database. This is normally
          caused by the fact that the path specified in line two of the
          configuration file is non-existant. You must create this path
          manually as per step 6 of the section on Package Installation.

    ERR05 Could not create robbery file
    
        - skTBANK could not create the robbery file. This is normally
          caused by the fact that the path specified in line two of the
          configuration file is non-existant. You must create this path
          manually as per step 6 of the section on Package Installation.
          
          
    ERX01 Unable to open user database (ReadUD)
    
        - skTBANK could not open the user database for read when
          required. This error should be refered to the software author
          as it is meant to be impossible. Please see the section on bug
          reporting for further information.
  
    ERX02 Unable to open user database (AccountStatus)
    
        - skTBANK could not open the user database for write when
          required. This error should be refered to the software author
          as it is meant to be impossible. Please see the section on bug
          reporting for further information.
          
    ERX03 Unable to open user database (Deposit)

        - skTBANK could not open the user database for write when
          required. This error should be refered to the software author
          as it is meant to be impossible. Please see the section on bug
          reporting for further information.

    ERX04 Unable to update user record (Deposit)
    
        - skTBANK could not update the wildcat user database when
          required. This error should be refered to the software author
          as it is meant to be impossible. Please see the section on bug
          reporting for further information.
        
    ERX05 Unable to open user database (Withdraw)

        - skTBANK could not open the user database for write when
          required. This error should be refered to the software author
          as it is meant to be impossible. Please see the section on bug
          reporting for further information.
            
    ERX06 Unable to update user record (Withdraw)

        - skTBANK could not update the wildcat user database when
          required. This error should be refered to the software author
          as it is meant to be impossible. Please see the section on bug
          reporting for further information.
          
    ERX07 Unable to update user record (Robbery)

        - skTBANK could not update the wildcat user database when
          required. This error should be refered to the software author
          as it is meant to be impossible. Please see the section on bug
          reporting for further information.

    ERX08 Unable to update user record (Robbery)

        - skTBANK could not update the wildcat user database when
          required. This error should be refered to the software author
          as it is meant to be impossible. Please see the section on bug
          reporting for further information.

- Non-fatal error messages, the following error messages are issued by
  skTBANK during normal operations. They are not fatal and normal
  operation should continue.

    Deposit

        Error, you can not deposit more time than you have
            - the user has tried to deposit more time than they have
              left for the day.
            
        Error, you can only deposit up to <n> minutes
            - the user has tried to deposit more time than <n> minutes
              configured in line 6 of the configuration file.
              
        Error, you can only have an account maximum of <n> minutes
            - the user has tried to deposit time that will make their
              balance more than <n> minutes configured in line 8 of the
              configuration file.
              
    Withdraw
    
        Error, you can not withdraw more time than you have
            - the user has tried to withdraw more time than they have in
              the bank.
            
        Error, you can not withdraw more than <n> minutes
            - the user has tried to withdraw more time than <n> minutes 
              configured in line 7 of the configuration file.
              
    Startup

        
        Error, You must first open an account before using skTBANK
    
        - The user has tried to use an option other than open account.
          You have configured skTBANK to force the user to open an
          account before using skTBANK. They have not opened an account.

8.  Bug Reports and Enhancement Requests
----------------------------------------

- Bug Reporting

    - When reporting a bug please include the following information and
      email to us at sktbank@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 sktbank.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 sktbank@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 sktbank@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
      sktbank@welcom.gen.nz with a brief description of your
      requirements.
    
    - For faxes please see the Bug Reporting section about our fax
      number.

9.   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.  Note: version 0.10b
     of this software can be REGISTERED FOR FREE!!!
 (3) Distribute copies of the unregistered version of this software as
     long as all of the original files (listed below) 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.

10.  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). SKTWARE 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). SKTWARE 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

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

