home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / MMAKER26.ZIP / MMAKER.DOC < prev    next >
Text File  |  1992-07-01  |  25KB  |  573 lines

  1.  
  2.                               MATCH MAKER
  3.  
  4.                                   v2.6
  5.  
  6.  
  7.                                    by
  8.  
  9.                               Al Lawrence
  10.  
  11.                             Sunrise-80  BBS
  12.                             (404) 256-9525
  13.  
  14.  
  15.  
  16.  
  17.                                DESCRIPTION
  18.                                ___________
  19.  
  20.    Match Maker allows for the matching of callers with like interests 
  21.    based upon answers given to questions developed by the Sysop.
  22.   
  23.    You may create up to 50 questions to be asked of each caller. You may 
  24.    create a different set of questions, based upon the callers sex. All 
  25.    that is required is to assign the proper filename to each set.
  26.  
  27.    You may create a trashcan file containing names you do not want used as an 
  28.    alias (registered version only).
  29.  
  30.    You may limit the number of times a caller may access the door.
  31.  
  32.    You may send and receive PRIVATE messages (does not affect the normal
  33.    BBS message base).
  34.  
  35.    Message database can accomodate unlimited number of messages. (Reg Version)
  36.  
  37.    Caller database can accomodate unlimited number of users. (Reg version)
  38.  
  39.    All Caller database records contain the logon name of the caller. 
  40.  
  41.    A maintainance program is supplied to be used to purge the databases and
  42.    recreate Index files. Command line parameters define the purge criteria
  43.    for Event maintenance (Registered version only). When run locally you define
  44.    the purge criteria at run time (Registered version only). Unregistered 
  45.    version allows for the search and viewing of Callers records (search may be
  46.    Alias or logon name) as well as the recreation of Indexes.
  47.  
  48.    Maintenance program can clear all answers to questions. The Door pgm will 
  49.    then detect this and force the caller to answer the new set of questions.
  50.  
  51.  
  52.    NOTE: Most errors will be logged to a file called DFRAME.ERR which is
  53.          created in the directory you run the door from.
  54.  
  55.  
  56.  
  57.                         INSTALLATION/LIMITATIONS
  58.                         ________________________
  59.  
  60.  
  61.    >>>>>>>> ++++ BE SURE THAT YOU HAVE SHARE.EXE LOADED!!!! ++++ <<<<<<<<
  62.  
  63.  
  64.    Installation is fairly easy and straight-forward. The following steps and
  65.    examples should have you up and running in a very short period of time.
  66.    It is assumed that you are familiar with setting up DOORS on your system.
  67.    To this end, only examples of the configuration file and Door batch file
  68.    are described.
  69.  
  70.       1) Create a directory to hold all MATCH MAKER files
  71.  
  72.       2) Unzip MMAKERxx.ZIP into the the above directory
  73.  
  74.          NOTE: BRUN45.EXE is not included but is required !!!
  75.  
  76.       3) Create a configuration file, with a name of your choice, or
  77.          modify the supplied MMAKER.CFG file. A description follows:
  78.  
  79.             **                       Location of system file (See Below)
  80.             SUNRISE-80 BBS           Your BBS Name
  81.             Al                       Sysop's First Name
  82.  
  83.             Lawrence                 Sysop's Last Name
  84.  
  85. |-----------------------------------------------------------------------------|
  86. | READ!     1                        CommPort  \ These 2 lines are required   |
  87. | READ!     1                        Node #    / ONLY for GTUSER.BBS          |
  88. |-----------------------------------------------------------------------------|
  89.  
  90.             00000000                 Registration Number
  91.  
  92.         #   2                        Keyboard timeout value in Minutes
  93.  
  94.     !   #   1                        Maximum # of Games per day
  95.                                      (Sysop gets 99, Registered version ONLY)
  96.  
  97.     !   #   0                        Time allowed in Door
  98.                                      (Sysop = Time Remaining - REG. VERSION)
  99.  
  100.             1                         Message Center Functions
  101.                                       1 = allow msg to be left/read
  102.                                       0 = disable message function
  103.  
  104.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  105.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  106.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  107.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  108.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  109.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  110.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  111.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  112.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  113.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  114.  
  115.     @   #   XXXX/YYYY                 Blackout Range  From/To
  116.     @   #   XXXX/YYYY                 Blackout Range  From/To
  117.     @   #   XXXX/YYYY                 Blackout Range  From/To
  118.     @   #   XXXX/YYYY                 Blackout Range  From/To
  119.     @   #   XXXX/YYYY                 Blackout Range  From/To
  120.  
  121.  
  122.      
  123.               ** = Replace with ONE of the following:
  124.  
  125. C:\PCB\PCBOARD.SYS              <- For PCBoard systems using PCBOARD.SYS only
  126. C:\BBS\CALLINFO.BBS             <- For Wildcat! systems (prior to v3.0)
  127. C:\BBS\USERINFO.DAT             <- For Wildcat! systems using v3.x
  128.                                    (Note:DOOR.SYS must be in SAME directory)
  129. C:\BBS\DOOR.SYS                 <- For ANY systems that support DOOR.SYS
  130. C:\BBS\DORINFOx.DEF             <- For ANY systems that support DORINFOx.DEF
  131. C:\BBS\SFDOORS.DAT              <- For Spitfire systems.
  132. C:\BBS\CHAIN.TXT                <- For WWIV systems 
  133. C:\BBS\GTUSER.BBS               <- For GT Power 
  134.                                    * if using this option you must put the
  135.                                      ComPort # on line 5 and the Node # on
  136.                                      line 6 of the configuration file
  137.  
  138.  
  139.  
  140.            # = Requires registration to change to a different value.
  141.            ! = See "Plays Per Day" Below
  142.            @ = See "Blackout Periods" Below
  143.  
  144.                NOTE: There are NO Blank Lines in the Config File!!
  145.  
  146.  
  147.  
  148.  
  149.       4) Create a batch file or modify the MMAKER file supplied. A
  150.          description of this file follows:
  151.  
  152.             ECHO off
  153.             cd\PCB\DOORS\MMAKER       Location of MatchMaker files
  154.             MMAKER MMAKER.CFG         EXE filename and CFG filename (Name
  155.                                       used in creating file in #3 above)
  156.             CD\PCB
  157.         *   BOARD
  158.  
  159.                * This is for PCboard. Replace with whatever your software
  160.                  requires to return to the BBS
  161.  
  162.        5) When running in more than one node, be sure to supply a
  163.           different configuration name for each node (your choice of name).
  164.  
  165.        6) The maximum number of messages that can exist in the Message
  166.           Database is 10 in the UNREGISTERED version and unlimited in
  167.           REGISTERED version.
  168.  
  169.        7) The maximum number of users that can exist in the User Database
  170.           is 20, in the UNREGISTERED version and unlimited when REGISTERED!
  171.  
  172.  
  173.                          WELCOME Text File (MMWELCOM)
  174.                          ____________________________
  175.  
  176.       To allow you complete flexibility in the way in which you can welcome 
  177.       your callers to the MatchMaker Door, you would use a Text editor to 
  178.       create a freeform file called MMWELCOM. The MMWELCOM file included in the
  179.       ZIP file MUST be used if MatchMaker is NOT registered. In the registered 
  180.       version use of the file is optional.
  181.     
  182.  
  183.    
  184.                      New Questions Bulletin (MMNEWQUE.TXT)
  185.                      _____________________________________
  186.  
  187.       This file is displayed when the Sysop has chosen to clear the current set
  188.       of questions and force the callers to re-answer the new set. You can use
  189.       the default file supplied or create your own. The file name must be 
  190.       called MMNEWQUE.TXT !
  191.  
  192.  
  193.                                BLACKOUT PERIODS
  194.                                ________________
  195.  
  196.       Use the Blackout ranges option to define up to 5 time periods during
  197.       which you DO NOT want the Door to be played. If a caller tries to access 
  198.       the Door during the Blackout period, they will be shown a message that
  199.       contains ALL the Blackout periods you have defined, and to try the Door
  200.       at a later time.
  201.  
  202.       Each of the 5 Blackout ranges takes the form of XXXX/YYYY, where
  203.       XXXX=beginning time and YYYY=the ending time. For example, 0930/1230
  204.       means to NOT allow the Door to be played between 9:30am and 12:30pm.
  205.  
  206.       IMPORTANT: - All times must be 4 digits & must follow the XXXX/YYYY format
  207.                  - DO NOT change the XXXX/YYYY entry UNLESS you want to assign
  208.                    a Blackout range.
  209.                  - You MUST use the MILITARY time format. Example: 2030=8:30pm
  210.                    0900=9am, 0030=12:30am, 1700=5pm, etc.
  211.  
  212.  
  213.                               TRASHCAN FILE
  214.                               _____________
  215.  
  216.       This is a text file you must create (if you wish to use one), with
  217.       a file name of MMTCAN.DAT and it must reside in the Door directory.
  218.  
  219.       This file is used if you want to block the use of "offensive" alias'
  220.       callers may choose to use. Each name (up to a maximum of 10 characters
  221.       must appear on a separate line within the text file. 
  222.  
  223.       NOTE: The name must match EXACTLY !!!
  224.  
  225.       This file is valid only with registered versions of the Door
  226.  
  227.  
  228.  
  229.                           PLAYS Per DAY/DOOR Time
  230.                           _______________________
  231.  
  232.       Plays Per Day and Door Time can be controlled several ways:
  233.  
  234.       (1) You can use the Games Per Day, singular option, in the config
  235.           file above. This option, will affect ALL callers whose Security
  236.           Level is NOT defined in any of the 10 optional Security Level/
  237.           Plays Per Day entries in the config file.
  238.  
  239.       (2) You can use the Door Time, singular option, in the config file
  240.           above. This option, will affect ALL callers whose Security
  241.           Level is NOT defined in any of the 10 optional Security Level/
  242.           Plays Per Day/Door Time entries in the config file.
  243.  
  244.       (3) You can restrict the number of games a specific Security Level
  245.           will be allowed to play per day or REWARD specific Levels with 
  246.           more Plays Per Day. 
  247.  
  248.           Likewise, you can restrict the Play time for a specific Security
  249.           Level or REWARD specific Levels with more Door Time.
  250.  
  251.           These options are handled by the use of the 10 config 
  252.           entries (000=00/00). 
  253.           
  254.           The format of each entry is as follows:
  255.  
  256.           XXX=YY/ZZ  where XXX is the Security Level (must be 3 digits)
  257.                      where =  is a constant and MUST be included
  258.                      where YY is the # of games per day (must be 2 digits)
  259.                      where / is a constant and MUST be included
  260.                      where ZZ is num. minutes per Door entry (must be 2 digits)
  261.           
  262.           If the callers Security Level is NOT defined, his/her Plays Per
  263.           Day and Door Time will be controlled by the values in items
  264.           (1) and (2), above, respectively..
  265.  
  266.           You may define up to 10 Security Levels. All unused entries must
  267.           be defined as   000=00/00
  268.         --------------------------------------------------------------------
  269.           Example: Suppose you had 3 Security Levels defined on your BBS as
  270.           (20=Subscriber, 30=Visiting Sysop, 40=CoSysop, 90=Friend) and you 
  271.           wanted to set Plays Per Day as :     Subscriber=5
  272.                                            Visiting Sysop=2
  273.                                                   CoSysop=3
  274.                                                    Friend=10 
  275.           
  276.           and Door Time as follows:     Subscriber=30 minutes
  277.                                     Visiting Sysop=20 minutes
  278.                                            CoSysop=10 minutes 
  279.                                             Friend=remaining call time
  280.                                
  281.  
  282.           You would set the Individual "Games per Day" config entry to 1 and 
  283.           the individual "Door Time" to 5 minutes (these would be the 
  284.           default number of games and default Time for all Security Levels
  285.           other than 20,30 or 40... make them any number you want). Next you
  286.           would replace 4 of the Security Level entries as :  020=05/30                                               
  287.                                                               030=02/20
  288.                                                               040=03/10
  289.                                                               090=10/0
  290.  
  291.  
  292.  
  293.  
  294.                            QUESTION FILE(S) SETUP
  295.                            ______________________
  296.  
  297.         MatchMaker has the ability to use 2 question files, one for Male
  298.         and one for Female. The Male question file must be named MMQUESTM.QUE
  299.         and the Female question file must be named MMQUESTF.QUE. The Male 
  300.         file is REQUIRED to be present and the Female file is OPTIONAL. If you
  301.         do NOT want separate question files, DO NOT create the MMQUESTF.QUE
  302.         file. If you do use both, bear in mind that the questions should be
  303.         essentially the same, but may be "slanted" to either sex. You will
  304.         not get many matches if you use entirely different questions and
  305.         answers. A sample MMQUESTM.QUE file is included to get you started.
  306.         
  307.         NOTE: MMQUESTF.QUE is only recognized in the REGISTERED version !!
  308.  
  309.         **You can force existing users to re-answer the questions by using the
  310.           option on the MMAINT menu.
  311.  
  312.         You  may have up to 50 questions.
  313.  
  314.         Each question can be up to 2 lines
  315.  
  316.         Each question can have up to 14 answers.
  317.  
  318.         The following is an explanation of how to set up this file:
  319.  
  320.         38                         <number of questions in this file
  321.         1                          <number of lines in the 1st question
  322.         10                         <number of answers
  323.         How old are you?           <question line 1
  324.         Less than 18 years old     <answer A
  325.         18 - 20 years old          <answer B
  326.         21 - 25 years old          <answer C
  327.         26 - 28 years old          <answer D
  328.         29 - 32 years old          <answer E
  329.         33 - 38 years old          <answer F
  330.         39 - 43 years old          <answer G
  331.         44 - 49 years old          <answer H
  332.         50 - 60 years old          <answer I
  333.         Over 60 years old          <answer J
  334.         2                          <number of lines in the last question
  335.         3                          <number of answers
  336.         "Now honestly, did you tell the whole truth on the"
  337.         "questionnaire, and nothing but the truth so help you God?"
  338.         "Yes, I told the whole truth"
  339.         A few lies never hurt anyone
  340.         I told mostly the truth
  341.  
  342.         In  the  above  example  the first line is the  total  number  of 
  343.         questions contained in the file.
  344.  
  345.         Line 2 is the number of lines in the first question.
  346.  
  347.         Line 3 is the number of answers listed for the question.
  348.  
  349.         Line 4 is the first question in the file.
  350.  
  351.         Lines 5 to 13 are the answers for the first question
  352.  
  353.         The last 7 lines break down as follows:
  354.  
  355.         Line 1 states that this question has two lines.
  356.  
  357.         Line 2 states that there are 3 answers listed
  358.  
  359.         Line 3 is the first line of the question.
  360.  
  361.         Line 4 is the second line of the question.
  362.  
  363.         Line 5 is the first answer.
  364.  
  365.         Line 6 is the second answer.
  366.  
  367.         Line 7 the third and last answer.
  368.  
  369.         A  line,  whether a question or an answer,  must be  enclosed  in 
  370.         quotation  marks  (") if the line contains any punctuation  other 
  371.         then a '?'. (see example files)
  372.  
  373.         The shorter the question the better.  One liners are the 
  374.         best, two liners ok, but three or more becomes tedious.
  375.  
  376.         There are two questions you need not worry about including in the 
  377.         file. These are:
  378.  
  379.                          What is your Sex
  380.                          What is your current age
  381.  
  382.         Since  the program must have these to work correctly,  they are
  383.         asked when you first log on.
  384.  
  385.  
  386.  
  387.  
  388.               MATCHMAKER MAINTENANCE PROGRAM (MMAINT)
  389.               _______________________________________
  390.  
  391.       The Caller Database and Message Database, that MatchMaker utilizes, 
  392.       must be purged periodically. The Caller database can hold an unlimited
  393.       number of callers, and the Message database can hold an unlimited
  394.       number of messages.
  395.  
  396.       After a message is read, it is marked for deletion, but not physically 
  397.       deleted from the database. The maintenance program (MMAINT), when run, 
  398.       will remove all messages marked for deletion, as well as those messages
  399.       that have been on the system longer than the number of days specified on
  400.       the command line, for Events, or requested when run manually.
  401.  
  402.       There are 2 ways to remove a caller form the Callers database. You can
  403.       delete it manually, after searching for & viewing the record or 
  404.       automatically if the door has not been accessed in the number of days
  405.       specified on the command line, for Events or requested when run manually.
  406.  
  407.       The command line required to run MMAINT as an EVENT is as follows:
  408.  
  409.               MMAINT /vvvvvvv.CFG /MDAYS:yy /CDAYS:zzz
  410.  
  411.       The command line required to run MMAINT MANUALLY is as follows:
  412.  
  413.                      MMAINT /vvvvvvv.CFG
  414.  
  415.           vvvvvvv.CFG  =  MatchMaker Configuration FIle
  416.                   yyy  =  Delete message if message is older than yyy days.
  417.                   zzz  =  Delete User if MMAKER not accessed in zzz days.
  418.  
  419.       As you can see, you can run MMAINT in your nightly event and/or manually.
  420.       Just adjust the command line, accordingly.
  421.  
  422.       Special Note: The only option available to Non=Registered users is the
  423.                     option to search/view a caller's record. All other require
  424.                     you to run a registered copy of MatchMaker.
  425.  
  426.  
  427.  
  428.                         NON-STANDARD COM SUPPORT
  429.                         ________________________
  430.  
  431.       Support for COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and
  432.       COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ
  433.       number after the configuration filename. Let's assume your Door is
  434.       called FOOBAR and you want to use COM1 and IRQ5. The command line
  435.       passed to your Door would be:
  436.  
  437.                             FOOBAR FOOBAR.CFG /5
  438.  
  439.       The /5 tells FOOBAR to use IRQ5 rather than the standard IRQ4 that is
  440.       normally used with COM1. No /x parameter is needed for the standard
  441.       IRQ's.
  442.  
  443.       As an alternative, you may use an environmental variable on the command
  444.       line. To use the variable (following the example above), place a 
  445.       SET IRQ=5 in the batch file used to bring up your BBS (you would need a 
  446.       different IRQ number for each node). The command line would now look 
  447.       like this: 
  448.  
  449.                           FOOBAR FOOBAR.CFG /%IRQ%
  450.       
  451.       This, in combination with the use of the environmental variables 
  452.       described in the MULTI-NODE SETUP section will allow you to use one 
  453.       batch file and one config file to run this door on all nodes.
  454.  
  455.  
  456.  
  457.  
  458.                            MULTI-NODE SETUP
  459.                            ________________
  460.  
  461.       All Sunrise Doors are Multi-Node capable. Each node must have the 
  462.       ability to access a configuration file which will have its own system 
  463.       file (DORINFOx.DEF, PCBOARD.SYS, DOOR.SYS, etc) defined on the first 
  464.       line. There are 2 ways to accomplish this:
  465.  
  466.       (1) Create a separate configuration file for each node. The only 
  467.           difference between each file would be the location of the system 
  468.           file for that particular node. For example, on my system there are 2
  469.           nodes and the first line of the config files would look like this:
  470.  
  471.                         NODE1:  H:\PCB1\DOOR.SYS
  472.                         NODE2:  H:\PCB2\DOOR.SYS
  473.  
  474.           Thus, if you have a 4 node BBS, you will need 4 configuration files.
  475.  
  476.       (2) Use ONE configuration file for ALL nodes. This Door will recognize 
  477.           the following PCBoard environmental variables:
  478.  
  479.                  PCBDIR    (Directory containing the System file)
  480.                  PCBDRIVE  (Drive containing the System file)
  481.  
  482.           Thus, the first line of the SINGLE configuration file, for this Door
  483.           would look like this:
  484.  
  485.                         %PCBDRIVE%%PCBDIR%\DOOR.SYS
  486.  
  487.       NOTE: This option, as described, assumes that you are running PCBoard 
  488.             14.5a software. The environmental variables are automatically 
  489.             created by the software for each node.
  490.  
  491.             HOWEVER, if you are running other BBS software you should be able
  492.             to set the variables EXACTLY as described below, for EACH node 
  493.             (more than likely in each batch file you use to bring up EACH node):
  494.  
  495.                             PCBDRIVE=C:
  496.                             ^^^^^^^^^
  497.                             PCBDIR=\NODE2
  498.                             ^^^^^^^^
  499.             
  500.             Info with a carat (^) under it, MUST be typed as is. The rest 
  501.             depends on your naming conventions. 
  502.  
  503.             This, in combination with the use of the optional environmental
  504.             variable described in the NON-STANDARD COM SUPPORT section, will
  505.             allow you to use one batch file and one config file to run this 
  506.             door on all nodes.
  507.  
  508.  
  509.  
  510.  
  511.                               LEGALITIES
  512.                               __________
  513.  
  514.  
  515.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  516.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  517.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  518.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  519.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  520.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  521.       OR BREACH OF ANY WARRANTY.
  522.  
  523.  
  524.  
  525.  
  526.  
  527.                              DISTRIBUTION
  528.                              ____________
  529.  
  530.    You may make this file available for downloading from your BBS or you may
  531.    upload it to any BBS of your choice, provided that you do not make any
  532.    changes to the contents of the archive (ZIP file). The archive and its
  533.    individual contents may not be used by any service that charges any money
  534.    whatsoever, without the written permission of the author.
  535.  
  536.  
  537.  
  538.  
  539.  
  540.                              REGISTRATION
  541.                              ____________
  542.  
  543.    Registration and the subsequent insertion of the registration number into
  544.    your configuation file, allows for the display of your BBS name on the
  545.    opening and closing screen as well as the reduction of a delay built into
  546.    the opening screen display along with the ability to change certain
  547.    values in the configuration file. In addition it will activate certain
  548.    options in the maintenance program.
  549.  
  550.    To register your copy of MatchMaker, please fill out the registration 
  551.    form (REGISTER.FRM) and mail it along with the registration fee to
  552.    the name and address on the form.
  553.  
  554.    Be sure to use the proper upper/lower case when filling in your name and
  555.    BBS name, as they MUST match the way you entered them in the configuration
  556.    file.             ^^^^
  557.  
  558.    Based upon information supplied on the registration form, I will pre-
  559.    register you on my BBS. You will then be able to call SUNRISE-80 and pick
  560.    up your registration number.
  561.  
  562.  
  563.  
  564.                                  MISC
  565.                                  ____
  566.  
  567.    The latest version of MATCH MAKER and other fine SUNRISE DOOR programs
  568.    are always available for download from SUNRISE-80 BBS.
  569.  
  570.    Remember, should you have any problems, questions or suggestions, be sure
  571.    to drop me a message on Sunrise-80 or in the RIME network (BBS_Doors, 
  572.    PCBHints, SYSops) or on SMARTNET (SN_Sysops).
  573.