home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / BBS / PPTB101.ZIP / PPBANK.DOC < prev    next >
Text File  |  1994-11-01  |  7KB  |  187 lines
  1.            ProPEX Time Bank Release 1.01 (c) 1994 Darren Bacon
  2.  
  3.  
  4. INTRODUCTION
  5.  
  6.   PPBANK is a Time Bank.  It is a "PEX" utility which will only work on the 
  7.   Proboard BBS package.  The Time Bank included with Proboard has a few
  8.   limitations which I didn't like.  i.e. It won't allow ASCII users into the
  9.   bank and it forces the users clear screen flag to ON.  PPBANK addresses
  10.   those issues, adds some RIP support and other features.
  11.  
  12.  
  13. FEATURES
  14.  
  15.   All the regular Time Banking functions.  Deposit, Withdrawal, etc.
  16.   Full screen with cursor placement, data entry fields
  17.   Supports ASC/ANS/AVT/RIP
  18.   "Extended" features like Robbery, Transfer, Loans (can be turned on or off)
  19.   Users can swap Time for KB's, or KB's for Time
  20.   Hot-Key tagging for selecting users (Robbery, Message or Edit)
  21.   Automatic loan repayment checking
  22.   Checks for upcoming system events
  23.   Notifies users in a message that they have been robbed, or transferred to.
  24.   Sysop editing
  25.  
  26.  
  27. INSTALLATION
  28.  
  29.   SIMPLE INSTALL::
  30.   
  31.   Put the PEX and the INI into your PEX directory and run it from a
  32.   regular type 60 menu option, check the Proboard doc's for more information
  33.   on how to use PEX files.
  34.  
  35.   ADVANCED INSTALLATIONS::
  36.  
  37.   There are some other things you can do to make the PEX a bit more flexible.
  38.  
  39.   The PEX and the INI can go into any directory (but they need to be in the
  40.   same directory as each other).  If you don't use the INI file, the PEX will
  41.   run with my default values.
  42.  
  43.   COMMAND LINE SWITCHES
  44.  
  45.   There are a few command line switches you can use with the PEX.
  46.  
  47.  
  48.    PPBANK L  This will cause the bank to simply check a users loan account.
  49.              If a loan is overdue, something will be done about it!  If you
  50.              auto-execute the PEX in your TOP menu, all users will be checked
  51.              for outstanding loans when they login.  To make a menu line
  52.              auto-execute, use a CTRL-A (smiley face) in the key field.
  53.              NOTE:: Loans are also checked when users enter the bank.
  54.  
  55.    PPBANK D  This will deposit all the users allowable time and KB's into the
  56.              bank.  This allows you to set the PEX up as a one-keystroke
  57.              option for users to deposit everything into the bank without
  58.              actually entering the bank.
  59.  
  60.    PPBANK DG  As above except the user will also be logged off the BBS after
  61.               the transaction.
  62.  
  63.  
  64. PPBANK CONCEPTS
  65.  
  66.   Transfers and Robberies only affect the users ACCOUNT BALANCES.  They will
  67.   not touch the actual users online stats.  This is done to ensure the sysop's
  68.   limits are adhered to and users have a less chance of abusing the bank.
  69.  
  70.   A Robbery costs a user Time and/or KB's (whatever the sysop has configured)
  71.   This Time and/or KB is repaid to the user if the robbery is successful.
  72.  
  73.  
  74. CONFIGURING THE INI FILE:
  75.  
  76.   The sample INI file is fairly well commented, you might want to skip this
  77.   section unless you aren't sure about something.
  78.  
  79.   RegisterNumber=0000000000  ; registration number which I will send you.
  80.  
  81.   The time bank can show an ANS/ASC file when the bank is entered and again
  82.   when exiting, might be handy to lay down some laws, or maybe advertise
  83.   something.  I have found the Time Bank to be the most used door on my BBS.
  84.  
  85.   Ansi1=PPBANK1    ; name of the ANS/ASC file to display when starting
  86.   Ansi2=PPBANK2    ; name of the ANS/ASC file to display when quitting
  87.  
  88.  
  89.   It is best to set a minimum limit to actually get into the bank.  This
  90.   will help stop the system from turfing users before they have a chance
  91.   to get out more time.
  92.  
  93.   MinimumTime=3    ; 0 to 30000  (0 = no minimum time needed)
  94.  
  95.   The maximum time a user can deposit each day.
  96.  
  97.   MaxTimeDeposit=30 ; 0 to 999
  98.  
  99.   The maximum time a user can withdrawal each day.
  100.  
  101.   MaxTimeWithdrawal=60   ; 0 to 999
  102.  
  103.   The maximum KB's a user can deposit each day.
  104.  
  105.   MaxKbDeposit=500      ; 0 to 9999
  106.  
  107.   The maximum KB's a user can withdrawal each day.
  108.  
  109.   MaxKbWithdrawal=2000  ; 0 to 9999
  110.  
  111.   A sysop level can be set to allow access to the Sysop Editor.  I've set
  112.   it to the highest level for first time installations.
  113.  
  114.   SysopLevel=64000 ; Range is 1 to 64000
  115.  
  116.  
  117.   Users can transfer Time or KB's to each other.  The sysop can disable this
  118.   feature if necessary.
  119.  
  120.   Transfers=ON     ; ON/OFF
  121.  
  122.  
  123.   DEPOSITALL is an option in the bank to allow users to hit one key and
  124.   deposit all their allowable time and KB's into the bank.
  125.  
  126.   DepositAll=ON    ; ON/OFF
  127.  
  128.  
  129.   The bank can leave messages to people when they have been robbed, or when
  130.   they have had Time or KB's transferred to them.  The MSGAREA option sets
  131.   the number of the message area to use.  This area will also be used if the
  132.     users want to leave messages to each other
  133.  
  134.   MsgArea=0        ; 0 = all messaging functions disabled.
  135.  
  136.   The next two options will switch on or off the message notification
  137.  
  138.   TransferNotify=ON;
  139.   RobberyNotify=ON ; 
  140.  
  141.   The remaining options are the regular bank settings
  142.  
  143.   MaxTimeStore=200 ; The max amount of time the user can store in the bank
  144.   MaxTimeLoan=60   ; The max time the user can borrow. Users can only have
  145.                    ; one time loan and one KB loan running at a time.
  146.   TimeInterest=10  ; Interest rate for time loans (percentage)
  147.   DaysTimeLoan=14  ; Number of days the user has to pay back time loans
  148.  
  149.   MaxKbStore=2000  ; The max kb's the user can store in the bank
  150.   MaxKbLoan=500    ; The max kb's the user can borrow
  151.   KbInterest=10    ; Interest rate for kb loans (percentage)
  152.   DaysKbLoan=14    ; Number of days the user has to pay back kb loans
  153.  
  154.   RobBankChance=5     ; "chance factor" for bank robberies  (i.e. 5:1 chance)
  155.   MaxRobBankTime=30   ; Max amount of time the user can rob from the bank
  156.   MaxRobBankKb=2000   ; Max amount of kb's the user can rob from the bank
  157.   TimesRobBank=3      ; Max attempts at robbing the bank each day
  158.   BankRobTimeCost=10  ; Time cost for bank robberies
  159.   BankRobKbCost=100   ; KB cost for bank robberies
  160.  
  161.   RobUserChance=3     ; "chance factor" for user robberies (i.e. 3:1 chance)
  162.   MaxRobUserTime=30   ; max time that can be robbed from a user 
  163.   MaxRobUserKb=200    ; max kb that can be robbed from a user
  164.   TimesRobUser=3      ; max attempts at robbing a user each day
  165.   UserRobTimeCost=10  ; time cost for user robberies
  166.   UserRobKbcost=100   ; kb cost for user robberies
  167.  
  168.   BuyTimeCost=10      ; how many kb's it costs to buy 1 minute of time
  169.   BuyKbCost=1         ; how many minutes it costs to buy 10kb's
  170.  
  171.   MaxTimeTransfer=30  ; Maximum time a user can transfer to another user
  172.   MaxKbTransfer=500   ; Maximum kb's a user can transfer to another user
  173.  
  174.  
  175. CLOSING
  176.  
  177.   I'm not much of a doco writer, so I hope that will do the job.  I'm always
  178.   interested in feedback, see the REGISTER.DOC for my contact details.  I'm
  179.   fairly keen on doing PEX's so if people register this one (and the others
  180.   I've done), I will continue writing them.
  181.  
  182. THIS IS SHAREWARE!
  183.  
  184.   USERQ and the ProPEX utilities are shareware.  If you use any of them for
  185.   more than 30 days, you are expected to register.  See REGISTER.DOC for more
  186.   information.
  187.