home *** CD-ROM | disk | FTP | other *** search
/ Black Box 4 / BlackBox.cdr / bbs_ra / rats120.arj / RATS120.DOC < prev    next >
Text File  |  1991-11-07  |  16KB  |  390 lines
  1.  
  2.  
  3.                                    - RATS 1.20 -
  4.  
  5.                            RemoteAccess TimeBank System
  6.                               Version 1.20 - release
  7.                                 Copyright 1990,1991
  8.                                 Motor City Software
  9.                                 All Rights Reserved
  10.  
  11.  
  12.  
  13.  
  14.  
  15. -----------------------------------------------------------------------------
  16.  
  17.  ** I M P O R T A N T   N O T I C E **
  18. -----------------------------------------------------------------------------
  19. The RATS data file structure was changed in Rats V1.20.
  20.  
  21. Please read the RATS.NEW file for info on upgrading your current RATS data
  22. and configuration files.
  23.  
  24. -----------------------------------------------------------------------------
  25.  
  26. Introduction
  27. -----------------------------------------------------------------------------
  28. The RemoteAccess TimeBank System (henceforth known as RATS) is a user time-
  29. banking system for RemoteAccess and QuickBBS.  It has many features for the
  30. user and Sysop alike and allows users to bank online time and download
  31. kilobytes for use at a later date.
  32.  
  33. RATS also supports programs which automatically deposit minutes in user
  34. accounts using the THEBANK.EXT external support file (see External Game
  35. Support).
  36.  
  37. At the time of this release, RATS works with RemoteAccess versions 0.04
  38. through 1.10 and QuickBBS 2.64 through 2.75.  RATS will automatically
  39. detect and support the format of these packages' EXITINFO.BBS files.
  40.  
  41. RATS has a separate maintenance program called RMU (RATS Maintenance Utility)
  42. which takes care of the RATS data file RATS.DAT.  It performs tasks ranging
  43. from deleting zero-balance accounts and users who are no longer in the
  44. USERS.BBS file to sorting accounts in last name order.
  45.  
  46. RATS provides hot-key support.  If the user is familiar with the commands,
  47. the current screen output can be interrupted when a command key is pressed.
  48. This can really speed things along!
  49.  
  50. RATS has a graphic transaction screen and uses Sysop-definable colors for
  51. most fields and prompts.
  52.  
  53. RATS recognizes the Sysop when he/she logs in and affords the <S>ysop Admin.
  54. command which basically allows the Sysop to make balance changes or delete
  55. certain user accounts.  RATS assumes that the user is the Sysop if the
  56. current user name is equal to that of the Sysop name as defined by your BBS.
  57.  
  58. RATS allows the Sysop to define values for maximum time deposit, withdrawal,
  59. and balance, as well as maximum kilobyte deposit, withdrawal, and balance.
  60. You can also set the maximum time transfer and maximum purchaseable kilobytes
  61. as well as default prompt foreground, prompt background, and prompt highlight
  62. colors to be used.
  63.  
  64. RATS now supports Multi-Line Systems! You can have more than one user in
  65. the bank at the same time. You MUST be running SHARE.EXE for multi-node
  66. support. Full RECORD LOCKING is supported, and this version will now
  67. handle up to 99 nodes.
  68.  
  69.  
  70.  
  71. -----------------------------------------------------------------------------
  72.  
  73. Licensing Information
  74.  
  75. -----------------------------------------------------------------------------
  76.  
  77. This program is not freeware.  This is SHAREWARE which means it is user-
  78. supported software.  If you use this program for more than 30 days, you are
  79. asked to register or remove it from your system.
  80.  
  81. The concept works only  with your support.  If  you find that you  can
  82. use this program, then  a registration fee of  $15.00 U.S. funds  will
  83. help defray the development cost and encourage the authorship of other
  84. programs that might be  useful to you.  A  Registration Form for  this
  85. purpose is included with the RATS distribution archive and is called
  86. RATSREG.DOC.
  87.  
  88. RATS is Copyrighted 1990,1991 by Motor City Software, ALL RIGHTS RESERVED.
  89. You may copy this program and documentation for backup purposes.
  90. You also may copy and share UNMODIFIED copies of the program package,
  91. providing that the copyright notice is reproduced and included on all copies.
  92.  
  93. You may not sell the product for a fee and/or distribute the product
  94. along with other products without expressed written permission, nor may
  95. you modify or remove the Copyright Notice from the program or the
  96. documentation.
  97.  
  98. Motor City Software shall not be held responsible for any damage incurred by
  99. the user to hardware, software or peripheral devices during the operation of
  100. the RATS program.
  101.  
  102. Comments, suggestions and bug reports are welcome.  If you have any,
  103. you may call one of the Motor City Software Support Systems listed below,
  104. and leave a message to the Sysop.  If you're reporting a bug, please give
  105. as much detail as possible about the problem you are having.
  106.  
  107.  
  108. Motor City Software Support Systems
  109.  
  110. Sysop Name           Location               Phone           Net Address
  111. ----------           --------               -----           -----------
  112. Rod Hancock          Oshawa, Ont. Can.      (416) 579-6318  1:229/418
  113. Jeff Wilson          Bowmanville Ont Can.   (416) 623-5148  1:229/414
  114. Peter Kling          Albany NY USA          (518) 437-1267  1:267/169
  115. Denis Bennet         Faversham Kent UK      +44-795-538359  2:440/11
  116. Peter Janssens       Venray Netherlands     +31-4780-12428  2:512/1
  117. Terry Harvey         Burwood NSW Australia  +61-2-7453500   3:712/704
  118.  
  119.  
  120. -----------------------------------------------------------------------------
  121.  
  122. Distribution Files
  123. -----------------------------------------------------------------------------
  124. This program is distributed in archive (PKZip) format.  The distribution
  125. archive contains the files:
  126.  
  127.         RATSCFG.EXE           The RATS configuration program
  128.         RATSCFG.DOC           Documentation for RATSCFG
  129.  
  130.         RATS120.EXE           The program executable
  131.         RATS120.DOC           This documentation file
  132.  
  133.         RMU.EXE               RATS maintenance utility
  134.         RMU.DOC               Documentation for RMU
  135.  
  136.         RATS.BAT              Sample Batch File for running RATS
  137.         RATS.HLP              The program help file
  138.         RATS.NEW              Program revision history (read this!!)
  139.         REGISTER.???          Registration forms
  140.         SUPPORT.DOC           Location of Support Systems
  141.  
  142.  
  143.  
  144. -----------------------------------------------------------------------------
  145.  
  146. Getting Started -- Installation
  147.  
  148. -----------------------------------------------------------------------------
  149.  
  150.            *** If You are Upgrading from a previous version ***
  151.  
  152.    VERY IMPORTANT!!!  Before you run RATS V1.20 you MUST run the update
  153.    program.
  154.  
  155.    If you are running a version of RATS prior to 1.00 then you will be
  156.    required to delete your RATSxx.CFG files and reconfigure using RATSCFG.
  157.  
  158.    Once this is done, you can then update your RATS.DAT file (the actual
  159.    user data) by running the conversion utility 100to120.exe
  160.  
  161.    If you were running V1.0x then you may simply run 100to120.exe which
  162.    will convert all necessary files to the new format.
  163.  
  164.  
  165.  
  166.  
  167.          *** If You are Installing RATS For The FIRST Time ***
  168.  
  169.  
  170. Unpack the distribution archive into the directory you'll run RATS in.  RATS
  171. can be run in any subdirectory as long as paths are setup properly in
  172. RATSCFG.EXE.  We recommend creating a RATS subdirectory off your main BBS
  173. directory.
  174.  
  175. Run the RATSCFG.EXE program to create/edit the RATS configuration file.
  176.  
  177. PLEASE READ RATSCFG.DOC for information on configuring RATS.
  178.  
  179. Now you will need to create the batch files needed to run RATS.  This is
  180. straight forward, and beyond the scope of this document. A sample RATS.BAT
  181. is included with the distribution archive.
  182.  
  183. That's all there is to it!  RATS is easy to install and to use.
  184.  
  185.  
  186.  
  187. -----------------------------------------------------------------------------
  188.  
  189. Getting Started -- Command Line Parameters
  190. -----------------------------------------------------------------------------
  191. RATS accepts the following command line parameters:
  192.  
  193.     /E - This  tells  RATS  not  to read any upcoming system event
  194.     information.  Some systems do not define any events within the
  195.     BBS and RATS doesn't like finding no events.    If  you  don't
  196.     have any events defined within your  BBS,  pass this parameter
  197.     to RATS.  I would recommend having at least one event  defined
  198.     within  your BBS as RATS thinks this is an ideal configuration
  199.     and loves the heck out of it! <grin>
  200.  
  201.     IMPORTANT NOTES ABOUT EVENTS:
  202.  
  203.     If you have ANY system events that require a user to be off at
  204.     a specific time,  you  MUST  have these events defined in your
  205.     BBS event schedule or RATS will  allow  users to withdraw time
  206.     that would overlap the system event time.
  207.  
  208.     If you  just  plain  don't  have  any  system events, then you
  209.     should use the /E command line parameter when  executing  RATS
  210.     (as above).
  211.   
  212.  
  213.  
  214.  
  215.  
  216.  
  217.  
  218.     /I - Causes  RATS  to  perform an 'Inquire'.    This  is  used
  219.     by Bob Butler's BitSpin game.     DORINFO1.DEF  will be opened
  220.     and the current online user's name retrieved  from  it.  Next,
  221.     RATS will search it's data file for this user  and  return the
  222.     user's name and current account balance in the format:
  223.  
  224.                            USER_NAME:BALANCE
  225.  
  226.     Where USER_NAME  is  the  user's full  name  (just as it is in
  227.     DORINFO1.DEF for  that matter - no underscores) and BALANCE is
  228.     the  user's  current  balance.    If the user does not have an
  229.     account, a balance of 0 will be returned.
  230.  
  231.     This  information is then written  to  a  file called RATS.TYM
  232.     which  is a standard ASCII text file.  RATS will overwrite any
  233.     existing RATS.TYM file.  This file will be written in the same
  234.     directory that contains RATS.EXE.
  235.  
  236.     This feature was added to support  door programs which need to
  237.     read a user's current balance.
  238.  
  239.     If you pass the /I parameter to RATS, the specified task will
  240.     be performed and then RATS will exit to DOS.  RATS will NOT
  241.     come up for online use when this parameter is passed to it
  242.     since its sole purpose is to allow other door programs to
  243.     retrieve the current user's account balance.
  244.  
  245.  
  246.     /NOLIST  Passing this on the command line will disable the users
  247.     from listing other users balances. You will still be able to list
  248.     them from the sysop menu.
  249.  
  250.     /N This is used to pass the Node Number in a multi-node system.
  251.     If you are running a single node system, ignore this. Otherwise
  252.     you pass /N1 for node 1, /N2 for node 2 etc... You will be required
  253.     to create a seperate configuration file for each node. See notes
  254.     in RATSCFG.DOC
  255.  
  256.  
  257.  
  258. For normal single line operation, RATS doesn't need any command line
  259. parameters passed to it.
  260.  
  261.  
  262.  
  263.  
  264. -----------------------------------------------------------------------------
  265.  
  266. External Files -- Minimum Usage File - RATSUSE.TXT
  267. -----------------------------------------------------------------------------
  268. If you configure RATS to require a user to use the BBS for a given amount of
  269. time before being able to make a deposit (of time or kilobytes) and a user
  270. attempts to make a deposit before using the BBS for the minimum required
  271. time, RATS will display a text file called RATSUSE.TXT, if it exits.  If it
  272. does not exist, a short message will be displayed.
  273.  
  274. This was added to support those Sysops who do not wish to have users logon
  275. only to deposit all of their time and then logoff.  If you set the minimum
  276. usage time in RATSCFG to 5 minutes, for example, and a user logs on and
  277. attempts to make a deposit before using the BBS for 5 minutes, the file
  278. RATSUSE.TXT is displayed.  Once the user has used the BBS for 5 minutes or
  279. more, the user is then allowed to make a deposit.
  280.  
  281.  
  282.  
  283. -----------------------------------------------------------------------------
  284.  
  285. External Files -- Bummer List -- RATS.BUM and RATSBUM.TXT
  286. -----------------------------------------------------------------------------
  287. RATS supports a 'bummer list' which is an ASCII text file list of user names
  288. that you do not want to have access to RATS.  This text file must have no
  289. blank lines.  Each line contains one full user name.  The user name can be
  290. in upper or lower case.  RATS will convert the names to upper case when it
  291. reads them.  The name of the text file is RATS.BUM.  If RATS finds this
  292. file upon startup, it will process it.
  293.  
  294. If a user who is on the bummer list tries to fire up RATS, RATS will look for
  295. a file called RATSBUM.TXT.  If found, this file will be displayed.  Otherwise,
  296. a default, one-line message will be displayed.
  297.  
  298.  
  299.  
  300. -----------------------------------------------------------------------------
  301.  
  302. External Game Support
  303. -----------------------------------------------------------------------------
  304. RATS is compatible with programs which utilize an external, automatic
  305. time-banking file (THEBANK.EXT) in that RATS will read this file and apply
  306. deposits and/or withdrawals automatically, to user accounts.
  307.  
  308. This means that RATS allows other door programs to automatically deposit
  309. or withdraw time from user accounts.  This can be quite handy, especially
  310. for door programs that offer time gambling or other time manipulation
  311. features.
  312.  
  313. So how does this work?  In RATSCFG, you entered a path to the external time
  314. bank support file THEBANK.EXT.  Whenever RATS is started, it looks for this
  315. file in the path you have set up.  If found, RATS performs the following
  316. tasks:
  317.  
  318.  o - Reads a line from THEBANK.EXT and retrieves the user name for the
  319.      transaction and the amount of the transaction.
  320.  
  321.  o - Searches the RATS data file for this user.  If the user does not
  322.      have an account, one is created.
  323.  
  324.  o - Applies the amount to be transacted.  This amount may be a positive or
  325.      a negative number.  If the number is negative, then the amount is
  326.      withdrawn from the user's account.  If the number is positive, the
  327.      amount is deposited.
  328.  
  329. So, what's the format of this external support file?  THEBANK.EXT is simply
  330. an ASCII text file consisting of no blank lines.  Each line must contain a
  331. transaction.  Here's a sample THEBANK.EXT file;  we will be depositing 30
  332. minutes in Jane Doe's account and withdrawing 30 minutes from John Doe's
  333. account:
  334.  
  335. <top of file>
  336. JANE DOE:30
  337. JOHN DOE:-30
  338. <end of file>
  339.  
  340. There is no limit to the number of transactions in THEBANK.EXT.  However,
  341. the more there are to process the longer it will take RATS to load since
  342. RATS looks for and processes this file each time it is loaded.
  343.  
  344.  
  345.  
  346. -----------------------------------------------------------------------------
  347.  
  348. External Files -- RATSMIN.TXT
  349. -----------------------------------------------------------------------------
  350. If a user fires up RATS and has a security level less than the Minimum
  351. Security value defined in RATSCFG, the text file RATSMIN.TXT is displayed,
  352. if it exists in the directory containing RATS.EXE.  If this file does not
  353. exist, a one-line message will be displayed.  The user is then returned to
  354. the BBS.
  355.  
  356. This is useful for Sysops who would like to tell users how to get access to
  357. RATS if their security level is not high enough.  The Sysop can then set the
  358. security level on the menu entry that calls RATS to a lower level than what
  359. is actually required to have access to it.
  360.  
  361.  
  362.  
  363. -----------------------------------------------------------------------------
  364.  
  365. Notes From the Authors
  366. -----------------------------------------------------------------------------
  367.  
  368. John Parlin, the original author of RATS has joined Motor City Software as
  369. a partner.  Rod Hancock has taken over the development of RATS, and John is
  370. working on some new exciting projects.
  371.  
  372. All support will be handled through the Motor City Software support group.
  373. See SUPPORT.DOC for the closest Support system to you.
  374.  
  375. If you have any helpful comments, suggestions or bug reports, please feel
  376. free to contact us.
  377.  
  378. We also have available, a Motor City Software support echo, which is carried
  379. on the Fido BackBone.  Tag Name is MCSOFT
  380.  
  381. If you use RATS for 30 days, you are required to register it or remove it
  382. from your system.
  383.  
  384. Please support us, so we may continue to support you....
  385.  
  386.  
  387.  
  388.  
  389.  
  390.