home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / DOOR / ARCADE_1.ZIP / QSLOT10.ZIP / QSLOT.DOC < prev    next >
Text File  |  1996-03-10  |  16KB  |  332 lines
  1.  
  2.  
  3.  
  4.                            Q-Slot  -  Version 1.0
  5.  
  6.  
  7.                         Copyright 1995 - 1996 SoftNet
  8.                              All Rights Reserved
  9.  
  10.  
  11.  
  12.                             Co-Owners' of SoftNet
  13.  
  14.  
  15.                      David Smart                  Peter Kling
  16.                     Space Station         Info System Technology, Inc.
  17.  FidoNet:             1:324/285                    1:374/169
  18.  Phone BBS/FAX:    1-508-454-0356               1-407-729-9166
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36. QSlot - User documentation        -(1)-                       March 10, 1996
  37. ╒════════════════════════════════════════════════════════════════════════════╕
  38. │░░░░░░ LICENSING INFORMATION ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
  39. ╘════════════════════════════════════════════════════════════════════════════╛
  40.  
  41.       This is a licence agreement between you, the end user, and SoftNet
  42.   QSlot, including any Screen, Executable, documentation, etc are the
  43.   property of SoftNet. Please read the terms and conditions of this
  44.   licence agreement carefully before using the software. If you for any
  45.   reason, whatsoever, cannot accept the conditions in this agreement,
  46.   you are not permitted to use QSlot.
  47.  
  48.       You acknowledge and agree that QSlot is a proprietary product of
  49.   SoftNet protected by applicable copyright laws and international treaty
  50.   provisions. You further acknowledge and agree that all rights, title,
  51.   and interest in, and to QSlot are and shall remain with SoftNet
  52.  
  53.       QSlot may be used for a period of thirty (30) days on a trial
  54.   basis to allow you to determine its suitability for your particular
  55.   application. After this period you MUST register QSlot, or remove
  56.   it from your system. Registration entitles you to use QSlot and
  57.   any future versions of QSlot for as  long  as you wish, subject
  58.   to any special licensing conditions and/or applicable upgrade fees
  59.   attached to future versions.
  60.  
  61.       In the event that you are in violation of this licence agreement,
  62.   you agree and accept that SoftNet may cancel your registration and
  63.   any rights to use QSlot that you may have. In the case of a dispute 
  64.   over the licence agreement, you further agree and accept to fully
  65.   reimburse SoftNet for legal and other expenses resulting from the
  66.   dispute.
  67.  
  68.       QSlot is provided "as is", without warranty of any kind, or
  69.   fitness for a particular purpose, either expressed or implied, all
  70.   of are hereby explicitly disclaimed. SoftNet only guarantees that
  71.   QSlot will occupy disk space.
  72.  
  73.       SoftNet liability resulting from your use or inability to use
  74.   QSlot is limited to the amount that the affected party has paid
  75.   for it, or in the event that QSlot was registered with a third
  76.   party  for payment to SoftNet, liability is limited to the amount
  77.   that was received by SoftNet from that third party.
  78.  
  79.       Neither SoftNet nor any of its employees, agents, or other
  80.   representatives are in any way obligated to provide future versions
  81.   of, or support for, QSlot. You may freely distribute and copy
  82.   QSlot provided that no fee is charged and the QSlot distribution
  83.   archive contains unmodified copies of the original files as produced
  84.   by SoftNet Pay Bulletin Board Systems may, however, charge their
  85.   normal fee provided that no additional charge for QSlot is levied
  86.   No part of QSlot may be modified, altered, reverse engineered,
  87.   sold, or distributed in any form what so ever which would involve
  88.   some sort of trade without prior written permission from SoftNet
  89.  
  90. QSlot - User documentation        -(2)-                       March 10, 1996
  91. ╒═══════════════════════════════════════════════════════════════════════════╕
  92. │░░░░░░ INTRODUCTION ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
  93. ╘═══════════════════════════════════════════════════════════════════════════╛
  94.  
  95.       Q-Slot! is an online ANSI graphics "Slot Machine" door game
  96.   for QuickBBS, RemoteAccess BBS, and SuperBBS.
  97.  
  98.       It allows users to gamble their time remaining while online.
  99.   The program is pretty straight forward and and easy to install.
  100.   It does require ANSI graphics to be turned ON by the user and
  101.   does require the DOS ANSI.SYS driver to be installed on the host
  102.   computer. If a caller tries to run Q-Slot! and does not have
  103.   graphics turned on, the program will notify the user that
  104.   graphics are required. It will then return control to the BBS.
  105.  
  106.       Q-Slot! allows the BBS Sysop to define the maximum number
  107.   of turns allowed per user, per day as well as the maximum number
  108.   of minutes a user may win while in the game. Once a user has
  109.   reached a maximum number of winable minutes, the user is not
  110.   allowed to access the game until the next day. Once a user has
  111.   reached the maximum number of turns per day Q-Slot! will not
  112.   allow the user to take any more turns.
  113.  
  114. QSlot - User documentation        -(3)-                       March 10, 1996
  115. ╒═══════════════════════════════════════════════════════════════════════════╕
  116. │░░░░░░ INSTALLATION ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
  117. ╘═══════════════════════════════════════════════════════════════════════════╛
  118.  
  119.       NOTE: If you were running an older release of QSlot, please
  120.   note the node number is now 3 digits, ie QSLOT001.CFG rather
  121.   than QSLOT1.CFG You also need to delete the first line of the
  122.   config file, as QSLot now reads the drop files from the current
  123.   directory.
  124.  
  125.   Q-Slot is easy to install. A type 7 menu entry may be used, as follows:
  126.  
  127.   Optional Data :  C:\BBS\DOORS\QSLOT\QSLOT.EXE /N*N
  128.  
  129.       When executed, Q-Slot! will look for its configuration file
  130.   QSLOT.CFG in the same directory that Q-Slot! is in. Q-Slot! reads
  131.   the first 6 lines of the configuration file and gets its operating
  132.   parameters. Edit the QSLOT.CFG file to suit your needs. QSlot will
  133.   read the ExitInfo.BBS and Dorinfo1.def file from the current
  134.   directory.
  135.  
  136.   LEAVE NO BLANK LINES between lines 1 through 6.
  137.  
  138.   The 6 lines represent the following parameters:
  139.  
  140.  
  141.    Line 1 - Time Bank Path    This is the path to your Time
  142.                               Banking utility directory. A
  143.                               trailing backslash is appended
  144.                               if one is not already specified.
  145.                               This is the path where Q-Slot!
  146.                               will write the file 'THEBANK.EXT'.
  147.  
  148.    Line 2 - Coin Value        Coin_value is a number from 1 to
  149.                               10. This tells Q-Slot! the value
  150.                               of a coin in minutes. For example,
  151.                               if you enter a value of 2, each
  152.                               coin will have a value of 2 minutes.
  153.                               I have found that a value of 2 works
  154.                               well.
  155.  
  156.    Line 3 - Maximum Winable   Max_Mins is a number from 1 to 1000.
  157.             Daily Minutes     This tells Q-Slot! the maximum number
  158.                               of minutes a user can win while in the
  159.                               program. If a user meets or exceeds
  160.                               this number, the user will be
  161.                               congratulated and politely asked to try
  162.                               again tomorrow. The user will not be
  163.                               allowed access to Q-Slot! until the next
  164.                               day.
  165.  
  166.                               NOTE: This number does not include the
  167.                               time the user already has. If this was
  168.                               set to 100 and the user had 99 minutes
  169.                               when he entered the program, he would
  170.                               be allowed to win 100 minutes.
  171.  
  172.    Line 4 - Maximum Daily     Max_turns is a number from 1 to 1000.
  173.             Turns             This tells Q-Slot! the maximum number
  174.                               of turns a player may take per day. If
  175.                               this number is reached, the user will
  176.                               not be allowed to take any more turns.
  177.  
  178.    Line 5 - External Time     Specifying a value of 1 on this line
  179.             Bank Support      tells Q-Slot! that you wish to use time
  180.                               bank support. What this means is that
  181.                               if a player is in Q-Slot! and wins an
  182.                               amount of time that would overlap a
  183.                               system event, Q-Slot! will create or
  184.                               append a file called THEBANK.EXT. This
  185.                               file would then contain the user's
  186.                               name and the number of minutes to
  187.                               automatically deposit into the user's
  188.                               time bank account. If you don't have a
  189.                               TimeBank that supports THEBANK.EXT then
  190.                               you might want to have a look at SoftNet's
  191.                               RATS V3.00 which is being released at
  192.                               the same time as this program.
  193.  
  194.                               For example, if there is a system event
  195.                               in 60 minutes and the player wins 80
  196.                               minutes Q-Slot! will give the player
  197.                               60 minutes of winnings and automatically
  198.                               bank the rest (20 minutes).
  199.  
  200.                               Note: Q-Slot! will write to the
  201.                               THEBANK.EXT file using in the path
  202.                               specified in QSLOT.CFG.
  203.  
  204.    Line 6 - Slot Type         You may specify one of three selection
  205.                               on this line. Slot Type specifies which
  206.                               slot format to use. Valid entries for
  207.                               this line are:
  208.  
  209.                               PROMPT_USER - Q-Slot! asks user which
  210.                                             slot type to use
  211.                               CITY_SLOTS  - Forces Q-Slot! to use
  212.                                             City Slots format
  213.                           TWENTY_ONE_BELL - Forces Q-Slot! to use 21
  214.                                             Bell format
  215.  
  216.                   Twenty-One Bell Format
  217.  
  218.        This format is similar to that of the actual machine by
  219.   the same name. It is modified slightly to include the 3-Skull
  220.   combination. Each reel contains 21 spaces. The payoff percentage
  221.   of this format is lower than the default format (City Slots) but
  222.   it is very close to the real thing. The 3-Cherry combination does
  223.   not exist in this format.
  224.  
  225.                   City Slots Format
  226.  
  227.       City Slots has a higher payoff percentage but also has better
  228.   odds of hitting a 3-Skull combination. The 3-Cherry combination is
  229.   allowed in this format.
  230.  
  231. QSlot - User documentation        -(4)-                       March 10, 1996
  232. ╒═══════════════════════════════════════════════════════════════════════════╕
  233. │░░░░░░ SUPPORT FILES ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
  234. ╘═══════════════════════════════════════════════════════════════════════════╛
  235.       The Q-Slot! archive comes with a few files needed by the
  236.   program. You can run Q-Slot! from any directory. The files
  237.   that come with the archive are:
  238.  
  239.     QSLOT.EXE                   This is the program
  240.     QSLOT.CFG                   This is the configuration file
  241.     QSLOT.ANS                   This is the formatted graphic used
  242.     QSLOT.ASC                   This is the formatted non-graphic used
  243.     QSLOT.HLP                   This is a formatted help file
  244.     QSLOT.DOC                   This document
  245.  
  246.   NOTE: Do not edit or change the contents of QSLOT.ANS ,QSLOT.ASC
  247.         or QSLOT.HLP. These files are formatted specifically for
  248.         the program.
  249.  
  250.       In addition to these files, Q-Slot! also creates and 
  251.   maintains some files it needs to operate. These are:
  252.  
  253.     QSLOT.DTE                   Julian date file. Erase this file if
  254.                                 you need to reset the game that day.
  255.     QSLOT.USR                   List of users who have reached a daily
  256.                                 limit and are not allowed to play again
  257.                                 that day.
  258.     QSLOT.TRN                   This keeps track of the user turn counts
  259.                                 for the day.
  260.     QSLOT.LOG                   This is the player log. It is a circular
  261.                                 text file which tracks the last 15 players
  262.                                 and how they did.
  263.     THEBANK.EXT                 External time bank utility file. This
  264.                                 file is created and maintained by Q-Slot!
  265.  
  266. ╒═══════════════════════════════════════════════════════════════════════════╕
  267. │░░░░░░ MORE ON TIME BANKING ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
  268. ╘═══════════════════════════════════════════════════════════════════════════╛
  269.  
  270.       When The Bank is run and locates THEBANK.EXT, it will read it
  271.   through to the end of the file updating or adding user accounts as
  272.   needed. The format of THEBANK.EXT is: User Name:Time
  273.  
  274.      For example, if JOHN DOE wins 80 minutes and Q-Slot deposits 20
  275.   minutes into his account, the following line will be appended to
  276.   THEBANK.EXT:
  277.                        JOHN DOE:20
  278.  
  279.       A user's name can appear in this file more than once. The Bank
  280.   will handle it properly. For more details, see RATS 1.01 or later.
  281.  
  282. QSlot - User documentation        -(5)-                       March 10, 1996
  283. ╒═══════════════════════════════════════════════════════════════════════════╕
  284. │░░░░░░ OTHER STUFF ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
  285. ╘═══════════════════════════════════════════════════════════════════════════╛
  286.  
  287.       Q-Slot also allows the Sysop to plug his/her BBS by displaying
  288.   a file called QSLOT.TXT, if it exists. So, if there's a message
  289.   you'd like to display before Q-Slot draws it's screen, just create
  290.   an ASCII text file called QSLOT.TXT and put it in the same
  291.   directory as Q-Slot and it will be displayed.
  292.  
  293.  
  294.       Sysop function keys:
  295.  
  296.                [ALT]-[C] : Chat with word wrap.
  297.                            [ESC] to quit chat.
  298.                [ALT]-[H] : Hang up on user.
  299.                [ALT]-[J] : Jump to DOS.
  300.                [ALT]-[T] : Unconditionally return user to BBS.
  301.               Up Arrow   : Increase users time by 2 minutes.
  302.               Down Arrow : Decrease users time by 2 minutes.
  303.  
  304.  
  305. ╒═══════════════════════════════════════════════════════════════════════════╕
  306. │░░░░░░ NOTES FROM THE AUTHOR ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
  307. ╘═══════════════════════════════════════════════════════════════════════════╛
  308.  
  309.       Q-Slot will not allow a user with less than 3 minutes access
  310.   to the program.
  311.  
  312.       When a player enters the game, their time remaining is recorded.
  313.   They are issued coins based on their time remaining and the coin
  314.   value specified by the Sysop. The field "Your Time" reflects the
  315.   amount of time available for gambling purposes. It does not affect
  316.   the time the player has within the program. If a player has 10
  317.   minutes left when he enters the program, he can play for 10 minutes
  318.   regardless of how much time he wins. The reason for this is if a
  319.   system event is pending in 10 minutes and the user enters the
  320.   program, then the program must return the user to the BBS in time
  321.   for that event to run. If the user has won time, he can call back
  322.   after the system event has run and the time should still be available
  323.   provided it was not truncated by the BBS (this may be the case if
  324.   no time banking support is used).
  325.  
  326.       As always, if you have any questions, comments, or problems with
  327.   this program, feel free to contact one of the support systems listed
  328.   in SUPPORT.DOC
  329.  
  330. QSlot - User documentation        -(6)-                       March 10, 1996
  331.  
  332.