BANK.PPE - Originally By John Palazzolo JP's Place (703) 237-5786 Modified and Updated By Dan Shore The Shoreline BBS (301) 946-2771 Written July 31, 1996 - Updated April 26, 1997 Purpose - To give a user the opportunity to save time or bytes for use on a later date. Also offer a user the ability to exchange time and/or bytes from their bank account or their online account. Lastly, Gambling Modules can be added for users to try their hand at winning time or bytes. All these options are configurable by the SysOp on a security level basis. NOTE: Make sure to read the ENTIRE documentation as it will explain the installation and operation of all the PPE's contained within the BANK archive (Bank, Bank2 Bank3a, BankEd, BankUtl, BankEdit, BankPack). This documentation also covers the installation/setup of the Gambling Games/Modules. The docs are not that long - so please READ!!! - even though SysOp's do not normally read docs. :) NOTE: All the Bank Free PPE's must be installed in the SAME directory (Except the gambling modules). See README.1ST NOTE: Full source code comes with this PPE. If you USE any of B W this source code you need to mention the program name and the authors name as the originator of the code within YOUR documentation. Give credit where credit is due!!!! If you find a better way to code or perform a task in these PPEs, pass on the changes to one of the authors. Everyone learns from others, who learn from others, and it makes all of us better programmers. WARRANTY AND DISCLAIMER: 컴컴컴컴컴컴컴컴컴컴컴컴 YOU MAY NOT ENGAGE IN NOR PERMIT THIRD PARTIES TO ENGAGE IN ANY OF THE FOLLOWING: 1. GRANTING SUB-LICENSES, LEASE OR OTHER RIGHTS IN THE SOFTWARE TO OTHERS. THIS PRODUCT IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, INCLUDING ANY WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE RESULTS AND PERFORMANCE OF THE PROGRAM IS ASSUMED BY YOU. FURTHERMORE, I THE AUTHOR DO NOT WARRANT, GUARANTEE, OR MAKE ANY REPRESENTATIONS REGARDING THE USE OF OR THE RESULTS OF THE USE OF THE PROGRAM, OR THAT THE PROGRAM WILL RUN WITHOUT ERROR, AND YOU RELY ON THE PROGRAM AND RESULTS SOLELY AT YOUR OWN RISK. I THE AUTHOR CANNOT ACCEPT RESPONSIBILITY FOR SYSTEM DAMAGE, LOSS OF PROFIT, OR ANY OTHER SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES RESULTING FROM THE USE OR INABILITY TO USE THIS PRODUCT. YOU ARE ALLOWED TO MODIFY THE SOURCE CODE AND REDISTRIBUTE. YOU ARE NOT ALLOWED TO CHARGE REGISTRATION FEES, OR ANY OTHER TYPE OF FEES, OR COSTS FOR THE PROGRAM ITSELF OR FOR THE WORK YOU OR OTHERS PERFORMED ON THE PROGRAM. THIS PROGRAM IS TO REMAIN *FREE* WITH FULL SOURCE CODE AVAILABLE. 컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� I. Features of Bank Free 컴컴컴컴컴컴컴컴컴컴� � Compatible with PPLC 3.1 and up. (Possibly even earlier, but we have not tested it). � Extensive commenting within included source code. With the source code, the SysOp can modify the program to do things the way they want, or even add new features. New Features? We think we have all the features a Bank needs, but you never know!! That is why the source code is included. � All options of Bank Free are configurable by the SysOp. If you do not want a feature of Bank Free on your BBS, then do not install it or give the user access to it! � Single Bank Free configuration file, or node specific configuration files supported. � External text files allow language specific files to be created or editing of prompts/displays to the SysOps liking. Language specific files are supported by Bank Free. � Detailed logging of exactly what the user did while in Bank Free or any of the Gambling Modules/Games. � All files in Bank Free can be modified using PCB Utilities. No external/third party utilities required. � Access to the Bank set on a security level basis. � Access to the Bank can be restricted by the time and day of the week, on a security level basis, or for all users. � Time and/or Byte Exchange - Configurable by SysOp. � Maximum Time/Byte withdraw amounts per day - Configurable by SysOp. � ANSI and Non-ANSI support. � Database files used to store bank information and user files. � 10 Gambling Modules/Games included with Bank Free. Gambling Modules/Games access is controlled by a configuration file. Each Module/Game includes full source code and extensive logging so the SysOp can tell exactly what the user did. � Generic Gambling Module/Game so SysOp can write their own game. This is the complete source code for writing your OWN Gambling Module. All the input handling, screen display, winning percentage calculations, and .CFG reading, is already programmed for you. All the SysOp has to do is write the acutal game code. Look at the included games to see how easy it is to write a simple gambling module/game. � Bank Free Configuration File Editor - Edit single configuration file or node specific configuration files. � Bank Free User Editor - Ability to edit any information for any user in the Bank. � Bank Free User File Packer - Removes users from the Bank Database who: 1. No longer have accounts on the BBS. 2. Have zero time and byte balances. � Bank Utility Program - One program to add to your CMD.LST file which gives access to the above three programs (.CFG editor, User editor, and Userbase packer). This program was written to reduce the number of entries in the CMD.LST � If user is informed they have (1) Min Remaining on the BBS (this prompt comes from PCBTEXT entry #76) and they have time in the bank, they have the option to withdraw time. � At logoff, user has the ability to deposit time or bytes in their bank account. The user will only be able to deposit time or bytes if: 1. The Bank Free configuration file allows it. 2. Their time or byte balance is not at the maximum. This module will work with or without the "Warning on Logoff" option used by the BBS. A. INSTALLATION 컴컴컴컴컴컴 1. Add two new entries to your CMD.LST file(s) Your entries in CMD.LST should look something like the following: Charges Per PPE/MNU File Specification -or- Command Sec Minute Use Keystroke Substitution 袴袴袴袴袴袴袴 袴� 袴袴袴袴袴袴袴袴� 袴袴袴袴袴袴袴袴袴袴袴袴袴袴袴袴� BANK 5 0 0 C:\PCB\PPE\BANK\BANK.PPE BANKUTL 110 0 0 C:\PCB\PPE\BANK\BANKUTL.PPE (Change the security levels and paths to match your system) ** BankUtl should only be accessible to the SysOp or Co-SysOp Don't forget to add "BANK" to your main menu so users know the Bank is available for their use. 2. Edit the BANK.CFG - Use your favorite text editor (Some good ones are TSE, Qedit, PCBEdit, etc.) NOTE: You will need to edit BANKCFG.SAM and rename it to BANK.CFG (you can use node specific .CFG files example: BANK1.CFG equals Node 1 .CFG file) See BANKCFG.SAM for a sample file. Here is the format: 旼컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴커 쿑ormat: 1 - User Security Level � � 2 - Maximum Bank Time � � 3 - Maximum Bank Bytes � � 4 - Maximum Bank time user can W/D per day � � 5 - Maximum Bank bytes user can W/D per day � � 6 - Time Exchange Rate � � 7 - Byte Exchange Rate � � 8 - Allow exchange with Bank Balances (T/F) � � 9 - Allow exchange with Online Balances (T/F) � � � 쿙ote: If a user has Unlimited D/L Bytes, they will not have� � access to the exchange function. With these users, � � have parm #6 & #7 set to 0 (zero). � � � � Any line that starts with a ' is a comment � 읕컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴켸 Example: 컴컴컴컴 5;0;500000;0;500000;10000;50000;Y;Y NOTE: You need an entry for EVERY security level that is allowed to use the bank. If a users security level cannot be matched, they are not allowed into the Bank program. First 5 Parameters 컴컴컴컴컴컴컴컴컴 The first five parameters are self explanatory, so no need to waste space explaining them. Time Exchange Rate and Byte Exchange Rate 컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� This is the exchange rate a user will receive for exchanging (trading-in) time or bytes. In the example above, the time exchange rate is 10,000. This means for every 1 minute the user exchanges, then get 10,000 bytes in return. The same applies for the Byte exchange. In the example above the user has to exchange 50,000 bytes for every 1 Minute they wish to receive. Bank Balance and On-Line Balance 컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴 This toggle (Y or N) allows the user to exchange Bank Balances, On-Line Balances, or Both. 3. Edit the BANKPACK.SAM file and *RENAME* this file to BANKPACK.CFG Only one entry/line in this file. Path to your PCB user index files. Example: 컴컴컴컴 c:\pcb\main 4. *** Optional *** Edit the DAYTIME.SAM file and rename to DAYTIME.DAT Do this only if you want to LIMIT users access based on the day of the week and the time of day. See DAYTIME.SAM for information. B. BANK2.PPE 컴컴컴컴� Purpose: PCBText replacement for prompt #76 which is: CAUTION: Auto-Disconnect in (1) mins.! BANK2.PPE checks if a user is down to 1 min remaining on-line, and if so, checks the BANK.NDX file to see if they have an account in the Bank Database. If the user has an account, BANK2.PPE checks for a bank time balance. If a Time Balance is available, the user will be given the opportunity to withdraw time. Installation: Replace PCBText #76 with: !c:\pcb\ppe\bank\bank2.ppe @OPTEXT@ You can edit your PCBText file manually or use a command line like the example below. Modify the paths for your setup!!! MKPCBTXT C:\PCB\GEN\PCBTEXT /I:76 "!c:\pcb\ppe\bank\bank2.ppe @OPTEXT@" C. BANK3A.PPE 컴컴컴컴컴 Purpose: When a user logs off, prompt them to bank time, bytes or log off the BBS. The user will only be prompted for depositing time or bytes IF they are able to. The user will be able to if: 1. The BANK.CFG file allows their security level to deposit time/bytes 2. Their bank balance is not at its maximum balance. Note: *** If you have PCBoard set to prompt a user to log off the BBS after entering "G" (goodbye), this PPE currently will not work. To use this PPE in that particular setup, you will need to modify the source code. We have already made the changes, but they need to be uncommented, and the source code recompiled (there are two sections clearly marked in the code). Make sure to change the PCBText prompt to run the PPE instead of asking the user to log off or not. Why is it called BANK3A.PPE instead of BANK3.PPE? 컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� BANK3.PPE is another PPE that I wrote and run on my system. It is basically the same as BANK3A.PPE, but in addition, it allows my users to play one of the two logoff games written by Nannette Thacker ("Don't Wake the Sysop" & "SPIKED"). These are GREAT games that can be played quickly by the user right before they logoff. When the user loses in the game (and they WILL lose) the game drops carrier and the user is logged off. If your BBS uses these great games by Nannette, then you may be interested in this module. Just drop me a note and I can make the file available for you to download or FREQ from the BBS. NOTE: If you do not use Warning on Logoff follow steps 1A & 1B If you use Warning on Logoff follow steps 1C & 1D 旼컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� � USE STEPS 1A and 1B IF YOU DO NOT USE WARNING ON LOGOFF � 읕컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 1A. Go into PCBSETUP and edit the log off script file. B. File Locations D. New User/Logon/off Questionnaires Name/Loc of Logoff Script Quest. Edit this field to the following: C:\PCB\PPE\BANK\BANK3A.PPE - OR - C:\PCB\PPE\BANK\BANK3A.PPE 110 The value on the command line will exempt any user who's security level is GREATER THAN OR EQUAL to this value (the PPE will not execute). If no value is entered (like example above) the PPE will execute for all users. NOTE: You have have to change the path to the PPE to match your system. 1B. Go into PCBSETUP and edit G. Configuration Options C. System Control Check the following entry Warning on Logoff Command : N 旼컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴커 � USE STEPS 1C and 1D IF YOU USE WARNING ON LOGOFF � 읕컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴켸 1C. Go into PCBSETUP and edit G. Configuration Options C. System Control Check the following entry Warning on Logoff Command : Y 1D. Replace PCBText #605 with: !c:\pcb\ppe\bank\bank3a.ppe You can edit your PCBText file manually or use a command line like the example below. Modify the paths for your setup. MKPCBTXT C:\PCB\GEN\PCBTEXT /I:605 "!c:\pcb\ppe\bank\bank3a.ppe" - OR - MKPCBTXT C:\PCB\GEN\PCBTEXT /I:605 "!c:\pcb\ppe\bank\bank3a.ppe 110" The value on the command line will exempt any user who's security level is GREATER THAN OR EQUAL to this value (the PPE will not execute). If no value is entered (like example above) the PPE will execute for all users. 旼컴컴컴컴컴컴컴컴컴컴컴컴커 � DO STEP 2 FOR ALL SETUPS � 읕컴컴컴컴컴컴컴컴컴컴컴컴켸 2. Edit the file BANK3TL for your BBS name. Try not to change the width of the box as it will not match the box in the PPE. If you need to change the width of the box, then you will need to modify the PPE and recompile the code. USE PCBEDIT ON BANK3TL to help keep the box size! D. BankUtl 컴컴컴� Purpose - To have one program for access to all other Bank Free Utilities (BankEdit, BankEd and BankPack) Installation (should already be setup from step A, #1) 1) Edit your CMD.LST file(s) to add this: Charges Per PPE/MNU File Specification -or- Command Sec Minute Use Keystroke Substitution 袴袴袴袴袴袴袴 袴� 袴袴袴袴袴袴袴袴� 袴袴袴袴袴袴袴袴袴袴袴袴袴袴袴袴� 1) BANKUTL 110 0 0 C:\PCB\PPE\BANK\BANKUTL.PPE Note: You may have to change the pathname to the PPE. Note: You may have to change the security level of the PPE. NOTE: Make sure the security level is high enough for only SysOp's and Co-SysOp's to access this PPE. E. BankEd 컴컴컴 Purpose: A program to add or edit entries in the Bank Free Configuration Files. This program is not required as programs like QEdit/TSE, PCBedit, etc. can be used to edit the configuration files. One bonus with BankEd is that you can edit a .CFG file and have online help for each parameter. Installation: None required - Program accessed through BankUtl F. BankPack 컴컴컴컴 Purpose: Bankpack is a program which scans the bank database and deletes user records from the database if: 1. The user no longer exists in the user base of the BBS 2. The user has zero time AND byte balances in the Bank Database If the user being processed does not match either of these requirements, they are retained in the database. In order for BANKPACK to run successfully it needs EXCLUSIVE access to the database (no users currently using the Bank). Bankpack can be run locally or from remote. Remember, when BANKPACK is running, the Bank database will be LOCKED and no users will be able to access the Bank. Installation: None required - Program accessed through BankUtl G. BankEdit 컴컴컴컴 Purpose: BankEdit is a program which allows adding a new user, searching, listing, or editing of an existing user in the Bank Database. You can search for partial or whole names (partial = SLOW->Sequential, whole = FAST->Indexed). You have the ability to edit ANY of the Bank information for a particular user. Here is a list of information you can edit: Last Access Date Bank Time Balance Last Time W/D Date Bank Time W/D on last date Bank Bytes Balance Last Byte W/D Date Bank Bytes W/D on last date Flag user for Deletion <-- Then run BANKPACK to Zero out all user values remove/delete user Installation: None required - Program accessed through BankUtl H. External Text Files - BANKTXT, BANKTXT2, GAMBTXT 컴컴컴컴컴컴컴컴컴� External Text Files are where you can change a prompt or make your own language specific files for Bank Free. Any Bank Free display prompt can be changed by the SysOp. There are two files, BANKTXT & BANKTXT2, which contain all the displays of the PPE's. BANKTXT covers BANK.PPE, BANK2.PPE, BANK3A.PPE while BANKTXT2 covers BANKED, BANKEDIT, BANKPACK, & BANKUTL Remember when changing a prompt, make sure to use the Bank to see how your change affects the look of the PPE. Besides working correctly, a PPE is only as good as it looks!!! All the gambling modules contain their OWN COPY of GAMBTXT. This is all the TEXT for each gambling module and they cannot be switch/copied over each other. But you can change any of the prompts in these files to your liking or language. With the gambling modules, most of the text is external. The only text internal are the prompts for the game itself. You will need to change the text in the PPS and recompile (if you want changes). I. Gambling Modules 컴컴컴컴컴컴컴컴 Included with BANK Free is the option to run Gambling Modules. These modules are games for the user to gamble their Bank Time or Bank Bytes against. (A user cannot gamble their on-line balances) The winning percentages and maximum bet amounts are configured by the SysOp for EACH game. Each Gambling Module can be configured so a player can play once per day, or as many times as the user wishes (that is if their bank balances hold out). Included with BANK Free are 10 games written by Dan Shore: Number Guess : Guess a Number between 1 and 5 MixedUp Words : Unscramble the Scrambled word Five Guess : Five tries to guess a number between 1 and 100 High-Low : Will Dice total be higher or lower than 7 Twenty-Five : Pick 5 grids and try to total more than 25 points Master 4 Guess : Guess the 4 Letter Pattern in 5 Guesses or less Between Card : Guess if the next card will be >Between< G U T S : Do you have the GUTS to hold the highest card? The Vault : Can you solve the combination? Pirate Chest : Don't pick the chest of Billy Bones IMPORTANT IMPORTANT IMPORTANT IMPORTANT IMPORTANT IMPORTANT 컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� NOTE: In each Gambling Module directory is a sample of the .CFG file for each game (each file has a .SAM extension) Modify the file and rename the file to the filename noted in the .SAM file. IF YOU DO NOT DO THIS THE GAMBLING MODULES WILL NOT WORK CORRECTLY!!!!!! A little side note:..........Now the GOOD PART!!! Included with the Gambling Modules is a Module called GENERIC. Included in this file is: GENERIC.PPS <- Complete Source Code INTRO <- Opening screen display for Game GENERIC.CFG <- Configuration file for the game GAMBTXT <- External Prompts File for Modules This is the complete source code for writing your OWN Gambling Module. All the input handling, screen display, winning percentage calculations, and .CFG reading, is already programmed for you. All you do is program the actual GAME code into the procedure called: PROCEDURE DO_GAMBLE (VAR BOOLEAN did_win) .... Your code goes here ... END PROC Also, at the beginning of the GENERIC.PPS, there is a statement: ' ' This is the name of the Gambling Module ' mod_name = "Number Guess" and near the end of GENERIC.PPS is a statement: FOPEN 1, PPEPATH() + "GENERIC.CFG", O_RD, S_DN ** Just change the names to match your Gambling Module name and configuration filename. The only requirement of the DO_GAMBLE code is that it returns the BOOLEAN variable did_win for the results of the game. did_win = TRUE => User Won did_win = FALSE => User Lost Look at the source code for the included games to get an idea of the game code needed. There isn't much to a simple game and everything else is written for you. Once you write a module, that program is yours......something you wrote!! It's a lot of fun! How to install a Gambling Module 컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴 Edit the file GAMBLE.SAM which is located in the same directory as BANK.PPE and *RENAME* this file to GAMBLE.DAT The format of this file is: 1st Entry = Full path and filename of the PPE 2nd Entry = Description of the game Any blank line or a line starting with a ' is considered a comment and is ignored. Currently, Bank Free can support 15 modules. If you wish to support more, just change the array size in BANK.PPS and recompile. Editing the .CFG file for each game. The format of the file is: Line 1 = Only allow the user to play once per day (TRUE/FALSE) Line 2 = Allow Time Betting;Maximum User can Bet;Winning Percentage Line 3 = Allow Byte Betting;Maximum User can Bet;Winning Percentage Here is an example: TRUE TRUE;30;.50 TRUE;500000;1.00 NOTE: In "GUTS" there is a 4th line. 4th line = Number of Computer Players (up to 5) Example: 3 NOTE: In "The Vault" there is a 4th and 5th line. 4th line = time in vault;bytes in vault 5th line = Vault Combination (Use leading zeros for single digit combination #'s) Example: 30;250000 11-21-07 NOTE: In "Pirate Chest" there is a 4th and 5th line. 4th line = Maximum time in a Treasure Chest 5th line = Maximum bytes in a Treasure Chest Example: 10 10000 In all the Gambling Modules/Games the maximum amount a user can bet is determined by: 1. The amount entered in the .CFG file -OR- 2. The amount of their current Bank Balance When a user wins a bet they receive: 1. All their time or bytes which they bet (-PLUS-) 2. The amount of their bet TIMES the Winning Percentage Miscellaneous files for the Gambling Modules 컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴 - Each gambling modules has a file called INTRO. This is the display shown upon entering the Gambling Module. - Each Gambling Module will create the following files in the same directory as the Gambling PPE: NODE????.LOG - Complete logging of what the user did (node specific) CKDATE.DAT - Date Module was last played GAM-USER.DAT - Contains names of users who have played the game on the date contained in CKDATE.DAT NOTE: CKDATE.DAT and GAM-USER.DAT will only be created if limiting the users to one play per day. (Determined in .CFG file) The GAM-USER.DAT file will be recreated when the first user plays the game on a new day. J. Registration 컴컴컴컴컴컴 This program is being released under the "Freeware" concept. If you really like the program, send a small donation to the author to help encourage more PPE's in the future. ($5 to $10) Or you are welcome to send us your PPE in exchange. K. Conclusion 컴컴컴컴컴 This archive has been zipped with an authenticity verification stamp. When you unzip this archive you should see at the end: Authentic files Verified! # MMJ131 THE SHORELINE BBS If you do not see this, then the file has either been tampered with or has been rezipped by an upload processor. If you have any questions, comments, suggestions, etc. please feel free to contact me via NetMail, the PCBoard or the PCBNet conference in FIDO, or the PPL conference on RIME. Dan Shore (301) 946-2771 - Node 1 (public access) The Shoreline BBS (301) 946-4202 - Node 2 (subscribers) 4312 Ferrara Court Fido Address - 1:109/458 1:109/457 Silver Spring, MD 20906 RIME Address - #1205 or SHORELINE E-Mail Address - dan.shore%sline@ghawk.com John Palazzolo (703) 237-5786 - Node 1 (Public Access) JP's Place Fido Address - 1:109/100 7211 Hickory Falls Church, VA 22043