The World of Computer Software

home *** CD-ROM | disk | FTP | other *** search

/ The World of Computer Software / World_Of_Computer_Software-02-387-Vol-3of3.iso / m / mm31beta.zip / MMAKER.DOC < prev next >

Wrap

Text File | 1993-02-13 | 37KB | 838 lines

MATCH MAKER v3.1 by Al Lawrence Sunrise Door Software Sunrise-80 BBS (404) 256-9525 (2400-19.2) (404) 705-9104 (2400) (404) 256-9518 (VOICE) (c) Copyright 1993, Al Lawrence All RIghts Reserved TABLE OF CONTENTS ------------------- Match Maker Highlights.......................................... 1 Legalities...................................................... 2 Distribution.................................................... 3 Installation.................................................... 4 Configuration File.............................................. 5 Download Questionaire........................................... 7 Upload Answers to Questionaire.................................. 8 File Transfer Protocols......................................... 9 WELCOME Text File (MMWELCOM).................................... 10 New Questions Bulletin (MMNEWQUE.TXT)........................... 11 Blackout Periods................................................ 12 TRASHCAN File................................................... 13 Plays per Day/Door Time......................................... 14 Question File Setup............................................. 15 Maintenance Program (MMAINT).................................... 17 Non-Standard Communication Ports................................ 18 Multi-Node Setup................................................ 19 Match Maker EXCHANGE............................................ 20 Registration.................................................... 21 Miscellaneous................................................... 22 Page 1 MATCH MAKER HIGHLIGHTS ---------------------- Match Maker allows for the matching of callers with like interests based upon answers given to questions developed by the Sysop. You may create up to 100 questions to be asked of each caller. You may create a different set of questions, based upon the callers sex. All that is required is to assign the proper filename to each set. You can indicate which questions you want a single choice and which you will allow the caller to select multiple choices. You may create a trashcan file containing names you do not want used as an alias or Logon Name (registered version only). You may limit the number of times a caller may access the door. You may send and receive PRIVATE messages (does not affect the normal BBS message base). Message database can accomodate unlimited number of messages. (Reg Version) Caller database can accomodate unlimited number of users. (Reg version) All Caller database records contain the logon name of the caller. A maintainance program is supplied to be used to purge the databases and recreate Index files. Command line parameters define the purge criteria for Event maintenance (Registered version only). When run locally you define the purge criteria at run time (Registered version only). Unregistered version allows for the search and viewing of Callers records (search may be Alias or logon name) as well as the recreation of Indexes. Maintenance program can clear all answers or individual questions. The Door program will then detect this and force the caller to answer the new question(s). Capable of exchanging USER and MESSAGE databases amongst any number of BBS' Caller can download questionaire file Caller can upload answers to questionaire file Page 2 LEGALITIES __________ THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS" WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT, SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF OR BREACH OF ANY WARRANTY. Page 3 DISTRIBUTION ____________ You may make this file available for downloading from your BBS or you may upload it to any BBS of your choice, provided that you do not make any changes to the contents of the archive (ZIP file). The archive and its individual contents may not be used by any service that charges any money whatsoever, without the written permission of the author. Page 4 INSTALLATION/LIMITATIONS ________________________ >>>>>>>> ++++ BE SURE THAT YOU HAVE SHARE.EXE LOADED!!!! ++++ <<<<<<<< Installation is fairly easy and straight-forward. The following steps and examples should have you up and running in a very short period of time. It is assumed that you are familiar with setting up DOORS on your system. To this end, only examples of the configuration file and Door batch file are described. 1) Create a directory to hold all MATCH MAKER files 2) Unzip MMAKERxx.ZIP into the the above directory 3) Create a configuration file, with a name of your choice, or modify the supplied MMAKER.CFG file. 4) Create a batch file or modify the MMAKER file supplied. A description of this file follows: ECHO off cd\PCB\DOORS\MMAKER Location of MatchMaker files MMAKER MMAKER.CFG EXE filename and CFG filename (Name used in creating file in #3 above) CD\PCB * BOARD * This is for PCboard. Replace with whatever your software requires to return to the BBS 5) When running in more than one node, be sure to supply a different configuration name for each node (your choice of name). 6) The maximum number of messages that can exist in the Message Database is 10 in the UNREGISTERED version and unlimited in REGISTERED version. 7) The maximum number of users that can exist in the User Database is 20, in the UNREGISTERED version and unlimited when REGISTERED! 8) If running with multi-port boards add /FD to the line containing the CFG name as follows: MMAKER MMAKER.CFG /FD NOTE: Most errors will be logged to a file called DFRAME.ERR which is created in the directory you run the door from. Page 5 CONFIGURATION FILE EXPLANATION ------------------------------ ** Location of system file (See Below) SUNRISE-80 BBS Your BBS Name Al Sysop's First Name Lawrence Sysop's Last Name |-----------------------------------------------------------------------------| | READ! 1 CommPort \ These 2 lines are required | | READ! 1 Node # / ONLY for GTUSER.BBS | |-----------------------------------------------------------------------------| 00000000 Registration Number # 2 Keyboard timeout value in Minutes ! # 10 Maximum # of Games per day (Sysop gets 99, Registered version ONLY) ! # 0 Time allowed in Door (Sysop = Time Remaining - REG. VERSION) 1 Message Center Functions 1 = allow msg to be left/read 0 = disable message function ! # 000=00/00 Security Level/Games Allowed Per Day ! # 000=00/00 Security Level/Games Allowed Per Day ! # 000=00/00 Security Level/Games Allowed Per Day ! # 000=00/00 Security Level/Games Allowed Per Day ! # 000=00/00 Security Level/Games Allowed Per Day ! # 000=00/00 Security Level/Games Allowed Per Day ! # 000=00/00 Security Level/Games Allowed Per Day ! # 000=00/00 Security Level/Games Allowed Per Day ! # 000=00/00 Security Level/Games Allowed Per Day ! # 000=00/00 Security Level/Games Allowed Per Day @ # XXXX/YYYY Blackout Range From/To @ # XXXX/YYYY Blackout Range From/To @ # XXXX/YYYY Blackout Range From/To @ # XXXX/YYYY Blackout Range From/To @ # XXXX/YYYY Blackout Range From/To # N N = Allow only 1 Alias per caller Y = Allow caller more than 1 Alias Y Y = Include Sexual Orientations N = Do NOT include Sexual Orientations N N = Show dates in American Format Y = Show dates in European Format # 00000000 MMAKER Exchange Registration Number # MMAKER Export File(s) name generated by the MMEXCH Export option Page 6 ** = Replace with Full DRIVE\PATH\FILENAME of ONE of the following: PCBOARD.SYS, DOOR.SYS, CALLINFO.BBS, USERINFO.DAT, DORINFOx.DEF SFDOORS.DAT, CHAIN.TXT, GTUSER.BBS, TRIBBS.SYS For GT Power using GTUSER.BBS: must put the ComPort # on line 5 and the Node # on line 6 of the configuration file # = Requires registration to change to a different value. ! = See "Plays Per Day" Below @ = See "Blackout Periods" Below NOTE: There are NO Blank Lines in the Config File!! Page 7 DOWNLOAD QUESTIONS to QUESTIONAIRE ---------------------------------- Callers will be given the option of downloading the questionaire and replying to it offline. MatchMaker will format the questionaire file to make it easier for the caller to read. The reformatting takes place in one of 2 ways: (a) If you change/add/delete questions then the maintenance program (MMAINT) will do it automatically once you have chosen option #6 to signal a change to the MatchMaker Door. (b) If you choose option #7 After either of the 2 options are exercised, the files will be placed in the MatchMakewr directory: MMQUESTM.DLM and MMQUESTF.DLF (one for the Male questionaire and one for the Female questionaire) Page 8 UPLOAD ANSWERS to QUESTIONAIRE ------------------------------ Callers are given the option of UPLOADING the answers to the questionaire directly to the MatchMaker Door. Typically they would download the questionaire and then create an ASCII file with the replies for each question on a spearate line. The replies MUST be in ASCII format, NOT Zipped, and have replies for each question on a separate line. If user is responding to a question with more than one(1) choice, then the choices MUST be written as: ABCD No punctuation of any sort! Page 9 UPLOAD/DOWNLOAD FILE TRANSFER PROTOCOLS --------------------------------------- The MatchMaker externalizes all file transfer protocols used for Uploading and Downloading of the MatchMaker questionaire/answers. This allows the Sysop to define the file transfer protocols they wish to support. A file called PROTOCOL.DAT is supplied with protocols already defined, which you may alter at any time. Each entry in the PROTOCOL.DAT file consists of the description that will be displayed to the caller on the Protocol Menu and the 'high level' name of the protocol's batch files. Example: ZModem Upload or Download, ZPROT The information to the left of the comma is the description. MatchMaker requires that you have 2 batch files in the MatchMaker directory to handle the uploading and downloading. In the above example ZPROT is the 'high level' portion of the 2 batch file names required for ZMODEM. Your MatchMaker directory should contain ZPROTR.BAT (the R is for uploading) and ZPROTS.BAT (the S is for downloading). The R and S suffixes MUST be present as that is what the MatchMaker will be looking for in the MatchMaker directory! Each protocol batch file MUST contain 2 batch file variables as follows: %1 = MatchMaker will use this variable to substitute the current ComPort %2 = MatchMaker will use this variable to substitute the file name IMPORTANT! Place the variable (%1 and %2) ONLY in the EXACT location that your protocol requires them, in the protocol command line. Do NOT supply the ComPort or FileName, JUST the %1 and %2 variables themselves (%1 and %2)! See example batch files supplied with the MatchMaker. They are the ones being used on the Sunrise-80 BBS. Page 10 WELCOME Text File (MMWELCOM) ____________________________ To allow you complete flexibility in the way in which you can welcome your callers to the MatchMaker Door, you would use a Text editor to create a freeform file called MMWELCOM. See sample file included in this ZIP file. Page 11 New Questions Bulletin (MMNEWQUE.TXT) _____________________________________ This file is displayed when the Sysop has chosen to clear the current set of questions or add more questions or change individual questions. You would use the CHANGE QUESTIONS option in the Maintenance program to signal the change to the MatchMaker Door and therefore force the callers to re-answer the new set (or individual questions). You can use the default file supplied or create your own. The file name must be called MMNEWQUE.TXT ! Page 12 BLACKOUT PERIODS ________________ Use the Blackout ranges option to define up to 5 time periods during which you DO NOT want the Door to be played. If a caller tries to access the Door during the Blackout period, they will be shown a message that contains ALL the Blackout periods you have defined, and to try the Door at a later time. Each of the 5 Blackout ranges takes the form of XXXX/YYYY, where XXXX=beginning time and YYYY=the ending time. For example, 0930/1230 means to NOT allow the Door to be played between 9:30am and 12:30pm. IMPORTANT: - All times must be 4 digits & must follow the XXXX/YYYY format - DO NOT change the XXXX/YYYY entry UNLESS you want to assign a Blackout range. - You MUST use the MILITARY time format. Example: 2030=8:30pm 0900=9am, 0030=12:30am, 1700=5pm, etc. Page 13 TRASHCAN FILE _____________ This is a text file you must create (if you wish to use one), with a file name of MMTCAN.DAT and it must reside in the Door directory. This file is used if you want to block the use of "offensive" alias' or Logon Names, callers may choose to use. Each name (up to a maximum of 10 characters must appear on a separate line within the text file. This file is also used to check the body of any messages left by callers for words you have in this file. All occurances of the word(s) will be replaced with a string of asteriks. NOTE: The name or word must match EXACTLY !!! This file is valid only with registered versions of the Door Page 14 PLAYS Per DAY/DOOR Time _______________________ Plays Per Day and Door Time can be controlled several ways: (1) You can use the Games Per Day, singular option, in the config file above. This option, will affect ALL callers whose Security Level is NOT defined in any of the 10 optional Security Level/ Plays Per Day entries in the config file. (2) You can use the Door Time, singular option, in the config file above. This option, will affect ALL callers whose Security Level is NOT defined in any of the 10 optional Security Level/ Plays Per Day/Door Time entries in the config file. (3) You can restrict the number of games a specific Security Level will be allowed to play per day or REWARD specific Levels with more Plays Per Day. Likewise, you can restrict the Play time for a specific Security Level or REWARD specific Levels with more Door Time. These options are handled by the use of the 10 config entries (000=00/00). The format of each entry is as follows: XXX=YY/ZZ where XXX is the Security Level (must be 3 digits) where = is a constant and MUST be included where YY is the # of games per day (must be 2 digits) where / is a constant and MUST be included where ZZ is num. minutes per Door entry (must be 2 digits) If the callers Security Level is NOT defined, his/her Plays Per Day and Door Time will be controlled by the values in items (1) and (2), above, respectively.. You may define up to 10 Security Levels. All unused entries must be defined as 000=00/00 -------------------------------------------------------------------- Example: Suppose you had 3 Security Levels defined on your BBS as (20=Subscriber, 30=Visiting Sysop, 40=CoSysop, 90=Friend) and you wanted to set Plays Per Day as : Subscriber=5 Visiting Sysop=2 CoSysop=3 Friend=10 and Door Time as follows: Subscriber=30 minutes Visiting Sysop=20 minutes CoSysop=10 minutes Friend=remaining call time You would set the Individual "Games per Day" config entry to 1 and the individual "Door Time" to 5 minutes (these would be the default number of games and default Time for all Security Levels other than 20,30 or 40... make them any number you want). Next you would replace 4 of the Security Level entries as : 020=05/30 030=02/20 040=03/10 090=10/0 Page 15 QUESTION FILE(S) SETUP ______________________ MatchMaker has the ability to use 2 question files, one for Male and one for Female. The Male question file must be named MMQUESTM.QUE and the Female question file must be named MMQUESTF.QUE. The Male file is REQUIRED to be present and the Female file is OPTIONAL. If you do NOT want separate question files, DO NOT create the MMQUESTF.QUE file. If you do use both, bear in mind that the questions should be essentially the same, but may be "slanted" to either sex. You will not get many matches if you use entirely different questions and answers. A sample MMQUESTM.QUE file is included to get you started. NOTE: MMQUESTF.QUE is only recognized in the REGISTERED version !! **You can force existing users to re-answer the questions by using the option on the MMAINT menu (you MUST use the NON-event option to run MMAINT). You may have up to 100 questions. Each question can be up to 2 lines Each question can have up to 14 answers. The following is an explanation of how to set up this file: 38 <number of questions in this file 1 <number of lines in the 1st question 10 <number of answers S <accept single choice, M=multiple choices How old are you? <question line 1 Less than 18 years old <answer A 18 - 20 years old <answer B 21 - 25 years old <answer C 26 - 28 years old <answer D 29 - 32 years old <answer E 33 - 38 years old <answer F 39 - 43 years old <answer G 44 - 49 years old <answer H 50 - 60 years old <answer I Over 60 years old <answer J 2 <number of lines in the last question 3 <number of answers M <accept multiple choices, S=single choice "Now honestly, did you tell the whole truth on the" "questionnaire, and nothing but the truth so help you God?" "Yes, I told the whole truth" A few lies never hurt anyone I told mostly the truth Page 16 In the above example the first line is the total number of questions contained in the file. Line 2 is the number of lines in the first question. Line 3 is the number of answers listed for the question. Line 4 is: S to restrict caller to a SINGLE choice OR M to allow caller to select MULTIPLE choices Line 5 is the first question in the file. Lines 6 to 14 are the answers for the first question The last 7 lines break down as follows: Line 1 states that this question has two lines. Line 2 states that there are 3 answers listed Line 3 is the first line of the question. Line 4 is the second line of the question. Line 5 is the first answer. Line 6 is the second answer. Line 7 the third and last answer. A line, whether a question or an answer, must be enclosed in quotation marks (") if the line contains any punctuation other then a '?'. (see example files) The shorter the question the better. One liners are the best, two liners ok, but three or more becomes tedious. There are two questions you need not worry about including in the file. These are: What is your Sex What is your current age Since the program must have these to work correctly, they are asked when you first log on. Page 17 MATCHMAKER MAINTENANCE PROGRAM (MMAINT) _______________________________________ The Caller Database and Message Database, that MatchMaker utilizes, must be purged periodically. The Caller database can hold an unlimited number of callers, and the Message database can hold an unlimited number of messages. After a message is read, it is marked for deletion, but not physically deleted from the database. The maintenance program (MMAINT), when run, will remove all messages marked for deletion, as well as those messages that have been on the system longer than the number of days specified on the command line, for Events, or requested when run manually. There are 2 ways to remove a caller from the Callers database. You can delete it manually, after searching for & viewing the record or automatically if the door has not been accessed in the number of days specified on the command line, for Events or requested when run manually. The command line required to run MMAINT as an EVENT is as follows: MMAINT /vvvvvvv.CFG /MDAYS:yy /CDAYS:zzz The command line required to run MMAINT MANUALLY is as follows: MMAINT /vvvvvvv.CFG vvvvvvv.CFG = MatchMaker Configuration FIle yyy = Delete message if message is older than yyy days. zzz = Delete User if MMAKER not accessed in zzz days. As you can see, you can run MMAINT in your nightly event and/or manually. Just adjust the command line, accordingly. Special Note: The only option available to Non=Registered users is the option to search/view a caller's record. All other require you to run a registered copy of MatchMaker. Page 18 NON-STANDARD COM SUPPORT ________________________ Support for COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ number after the configuration filename. Let's assume your Door is called FOOBAR and you want to use COM1 and IRQ5. The command line passed to your Door would be: FOOBAR FOOBAR.CFG /5 The /5 tells FOOBAR to use IRQ5 rather than the standard IRQ4 that is normally used with COM1. No /x parameter is needed for the standard IRQ's. As an alternative, you may use an environmental variable on the command line. To use the variable (following the example above), place a SET IRQ=5 in the batch file used to bring up your BBS (you would need a different IRQ number for each node). The command line would now look like this: FOOBAR FOOBAR.CFG /%IRQ% This, in combination with the use of the environmental variables described in the MULTI-NODE SETUP section will allow you to use one batch file and one config file to run this door on all nodes. Page 19 MULTI-NODE SETUP ________________ All Sunrise Doors are Multi-Node capable. Each node must have the ability to access a configuration file which will have its own system file (DORINFOx.DEF, PCBOARD.SYS, DOOR.SYS, etc) defined on the first line. There are 2 ways to accomplish this: (1) Create a separate configuration file for each node. The only difference between each file would be the location of the system file for that particular node. For example, on my system there are 2 nodes and the first line of the config files would look like this: NODE1: H:\PCB1\DOOR.SYS NODE2: H:\PCB2\DOOR.SYS Thus, if you have a 4 node BBS, you will need 4 configuration files. (2) Use ONE configuration file for ALL nodes. This Door will recognize the following PCBoard environmental variables: PCBDIR (Directory containing the System file) PCBDRIVE (Drive containing the System file) Thus, the first line of the SINGLE configuration file, for this Door would look like this: %PCBDRIVE%%PCBDIR%\DOOR.SYS NOTE: This option, as described, assumes that you are running PCBoard 14.5a software. The environmental variables are automatically created by the software for each node. HOWEVER, if you are running other BBS software you should be able to set the variables EXACTLY as described below, for EACH node (more than likely in each batch file you use to bring up EACH node): PCBDRIVE=C: ^^^^^^^^^ PCBDIR=\NODE2 ^^^^^^^^ Info with a carat (^) under it, MUST be typed as is. The rest depends on your naming conventions. This, in combination with the use of the optional environmental variable described in the NON-STANDARD COM SUPPORT section, will allow you to use one batch file and one config file to run this door on all nodes. Page 20 DATABASE EXCHANGE _________________ ** SHARE MATCH MAKER USERS/MESSAGE DATABASES BETWEEN 2 OR MORE BBS' ** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The optional Match Maker Database Exchange feature will allow you to participate in the exchange of Match Maker Users and Message databases with other BBS' (Any number of BBS' can participate). The exchange program (MMEXCH) comes included in the MMAKERxx.ZIP file. MMEXCH performs three (3) major functions: (1) EXPORT: Extracts all active users and messages from the Match Maker database. It creates 2 files named XXXXXXXX.UXP and XXXXXXXX.MXP (XXXXXXXX is defined in the CFG file) and will bypass any USER or MESSAGE already flagged for deletion. (2) IMPORT: Imports the XXXXXXXX.UXP and XXXXXXXX.MXP (XXXXXXXX is defined in the CFG file) created by the EXPORT option and merges all USERS and MESSAGES into the Match Maker database. It will not import any USERS or MESSAGES that duplicates USERS or MESSAGES found in the existing database. Note that this option will IMPORT ALL files with an extension of UXP or MXP, during a single execution of the program. (3) IMPEXP: This option will first IMPORT (as in (2) above) then turn around and EXPORT (as in (1) above) during one execution of the program. All BBS' involved in the exchange MUST run registered versions of BOTH Match Maker and Match Maker Exchange (MMEXCH). MMEXCH will only work with version 3.1 of Match Maker and later! It is critical that ALL participants in the exchange use the SAME QUESTION files (Male and Female versions). Failure to do so will result in incorrect matching and possible Door malfunctions! ( CONTINUED on NEXT PAGE ) Page 21 To run the Exchange you do the following: EXPORT: a) Change to the directory containing your MMAKER files b) Issue this command: MMEXCH EXPORT MMAKER.CFG If you use a different name for your Config file, then substitute that name for MMAKER.CFG c) Send (transmit) the XXXXXXXX.UXP and XXXXXXXX.MXP files to those involved in the exchange or to the HUB. d) Delete XXXXXXXX.UXP and XXXXXXXX.MXP IMPORT: a) Change to the directory containing your MMAKER files b) Copy the XXXXXXXX.UXP and XXXXXXXX.MXP files that was sent to you by the BBS you are exchanging with, to the directory used in item (a) above. c) Issue the command: MMEXCH IMPORT MMAKER.CFG If you use a different name for your Config file, then substitute that name for MMAKER.CFG d) Delete XXXXXXXX.UXP and XXXXXXXX.MXP IMPEXP: a) Change to the directory containing your MMAKER files b) Copy the XXXXXXXX.UXP and XXXXXXXX.MXP files that were sent to you by the BBS you are exchanging with, to the directory used in a) c) Issue the command: MMEXCH IMPEXP MMAKER.CFG If you use a different name for your Config file, then substitute that name for MMAKER.CFG d) Send (transmit) the XXXXXXXX.UXP and XXXXXXXX.MXP files to those involved in the exchange or to the HUB. NOTE: When registering MMEXCH, you MUST use the EXACT SAME Sysop Name AND BBS NAME as used for MATCH MAKER!!!!!!!!!!!!!!!!!!!!!!!!! Page 22 REGISTRATION ____________ Registration and the subsequent insertion of the registration number into your configuation file, allows for the display of your BBS name on the opening and closing screen as well as the reduction of a delay built into the opening screen display along with the ability to change certain values in the configuration file. In addition it will activate certain options in the maintenance program. To register your copy of MatchMaker, please fill out the registration form (REGISTER.FRM) and mail it along with the registration fee to the name and address on the form. Be sure to use the proper upper/lower case when filling in your name and BBS name, as they MUST match the way you entered them in the configuration file. ^^^^ Based upon information supplied on the registration form, I will pre- register you on my BBS. You will then be able to call SUNRISE-80 and pick up your registration number. Page 23 MISC ____ The latest version of MATCH MAKER and other fine SUNRISE DOOR programs are always available for download from SUNRISE-80 BBS. Remember, should you have any problems, questions or suggestions, be sure to drop me a message on Sunrise-80 or in the RIME network (BBS_Doors, PCBHints, SYSops) or on SMARTNET (SN_Sysops).