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