home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / World_Of_Computer_Software-02-385-Vol-1of3.iso / m / mmaker12.zip / MMAKER.DOC < prev    next >
Text File  |  1991-12-19  |  21KB  |  492 lines

  1.  
  2.                               MATCH MAKER
  3.  
  4.                                   v1.2
  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 file containing names you do not want used as an 
  28.    alias (registered verion 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 1000 messages.
  36.  
  37.    Caller database can accomodate 1000 users.
  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.
  42.    Command line parameters define the purge criteria. (Registered version 
  43.    only). Unregistered version allows for the search and viewing of Callers
  44.    records (search may ben Alias or logon name).
  45.  
  46.  
  47.  
  48.    NOTE: Most errors will be logged to a file called DFRAME.ERR which is
  49.          created in the directory you run the door from.
  50.  
  51.  
  52.  
  53.                         INSTALLATION/LIMITATIONS
  54.                         ________________________
  55.  
  56.  
  57.    Installation is fairly easy and straight-forward. The following steps and
  58.    examples should have you up and running in a very short period of time.
  59.    It is assumed that you are familiar with setting up DOORS on your system.
  60.    To this end, only examples of the configuration file and Door batch file
  61.    are described.
  62.  
  63.       1) Create a directory to hold all MATCH MAKER files
  64.  
  65.       2) Unzip MMAKERxx.ZIP into the the above directory
  66.  
  67.          NOTE: BRUN45.EXE is not included but is required !!!
  68.  
  69.       3) Create a configuration file, with a name of your choice, or
  70.          modify the supplied MMAKER.CFG file. A description follows:
  71.  
  72.             **                       Location of system file (See Below)
  73.             SUNRISE-80 BBS           Your BBS Name
  74.             Al                       Sysop's First Name
  75.  
  76.             Lawrence                 Sysop's Last Name
  77.  
  78.             00000000                 Registration Number
  79.  
  80.         #   2                        Keyboard timeout value in Minutes
  81.  
  82.     !   #   1                        Maximum # of Games per day
  83.                                      (Sysop gets 99, Registered version ONLY)
  84.  
  85.             2                        1 = DO NOT Display ADOPT-A-DOOR Message
  86.                                      2 = Display ADOPT-A-DOOR message
  87.  
  88.     !   #   0                        Time allowed in Door
  89.                                      (Sysop = Time Remaining - REG. VERSION)
  90.  
  91.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  92.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  93.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  94.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  95.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  96.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  97.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  98.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  99.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  100.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  101.  
  102.     @   #   XXXX/YYYY                 Blackout Range  From/To
  103.     @   #   XXXX/YYYY                 Blackout Range  From/To
  104.     @   #   XXXX/YYYY                 Blackout Range  From/To
  105.     @   #   XXXX/YYYY                 Blackout Range  From/To
  106.     @   #   XXXX/YYYY                 Blackout Range  From/To
  107.  
  108.  
  109.      
  110.               ** = Replace with ONE of the following:
  111.  
  112. C:\PCB\PCBOARD.SYS              <- For PCBoard systems using PCBOARD.SYS only
  113. C:\BBS\CALLINFO.BBS             <- For Wildcat! systems (prior to v3.0)
  114. C:\BBS\USERINFO.DAT             <- For Wildcat! systems using v3.x
  115.                                    (Note:DOOR.SYS must be in SAME directory)
  116. C:\BBS\DOOR.SYS                 <- For systems that support DOOR.SYS
  117. C:\BBS\DORINFOx.DEF             <- For QBBS/RBBS/RA. Replace x with Node #.
  118. C:\BBS\SFDOORS.DAT              <- For Spitfire systems.
  119. C:\BBS\CHAIN.TXT                <- For WWIV systems 
  120.  
  121.  
  122.            # = Requires registration to change to a different value.
  123.            ! = See "Plays Per Day" Below
  124.            @ = See "Blackout Periods" Below
  125.  
  126.                NOTE: There are NO Blank Lines in the Config File!!
  127.  
  128.  
  129.  
  130.  
  131.       4) Create a batch file or modify the MMAKER file supplied. A
  132.          description of this file follows:
  133.  
  134.             ECHO off
  135.             cd\PCB\DOORS\MMAKER       Location of MatchMaker files
  136.             MMAKER MMAKER.CFG         EXE filename and CFG filename (Name
  137.                                       used in creating file in #3 above)
  138.             CD\PCB
  139.         *   BOARD
  140.  
  141.                * This is for PCboard. Replace with whatever your software
  142.                  requires to return to the BBS
  143.  
  144.        5) When running in more than one node, be sure to supply a
  145.           different configuration name for each node (your choice of name).
  146.  
  147.        6) The maximum number of messages that can exist in the Message
  148.           Database is 75 in the UNREGISTERED version and 1000 in the 
  149.           REGISTERED version.
  150.   
  151.  
  152.  
  153.                           BLACKOUT PERIODS
  154.                           ________________
  155.  
  156.       Use the Blackout ranges option to define up to 5 time periods during
  157.       which you DO NOT want the Door to be played. If a caller tries to access 
  158.       the Door during the Blackout period, they will be shown a message that
  159.       contains ALL the Blackout periods you have defined, and to try the Door
  160.       at a later time.
  161.  
  162.       Each of the 5 Blackout ranges takes the form of XXXX/YYYY, where
  163.       XXXX=beginning time and YYYY=the ending time. For example, 0930/1230
  164.       means to NOT allow the Door to be played between 9:30am and 12:30pm.
  165.  
  166.       IMPORTANT: - All times must be 4 digits & must follow the XXXX/YYYY format
  167.                  - DO NOT change the XXXX/YYYY entry UNLESS you want to assign
  168.                    a Blackout range.
  169.                  - You MUST use the MILITARY time format. Example: 2030=8:30pm
  170.                    0900=9am, 0030=12:30am, 1700=5pm, etc.
  171.  
  172.  
  173.                               TRASHCAN FILE
  174.                               _____________
  175.  
  176.       This is a text file you must create (if you wish to use one), with
  177.       a file name of MMTCAN.DAT and it must reside in the Door directory.
  178.  
  179.       This file is used if you want to block the use of "offensive" alias'
  180.       callers may choose to use. Each name (up to a maximum of 10 characters
  181.       must appear on a separate line within the text file. 
  182.  
  183.       NOTE: The name must match EXACTLY !!!
  184.  
  185.       This file is valid only with registered versions of the Door
  186.  
  187.  
  188.  
  189.                           PLAYS Per DAY/DOOR Time
  190.                           _______________________
  191.  
  192.       Plays Per Day and Door Time can be controlled several ways:
  193.  
  194.       (1) You can use the Games Per Day, singular option, in the config
  195.           file above. This option, will affect ALL callers whose Security
  196.           Level is NOT defined in any of the 10 optional Security Level/
  197.           Plays Per Day entries in the config file.
  198.  
  199.       (2) You can use the Door Time, singular option, in the config file
  200.           above. This option, will affect ALL callers whose Security
  201.           Level is NOT defined in any of the 10 optional Security Level/
  202.           Plays Per Day/Door Time entries in the config file.
  203.  
  204.       (3) You can restrict the number of games a specific Security Level
  205.           will be allowed to play per day or REWARD specific Levels with 
  206.           more Plays Per Day. 
  207.  
  208.           Likewise, you can restrict the Play time for a specific Security
  209.           Level or REWARD specific Levels with more Door Time.
  210.  
  211.           These options are handled by the use of the 10 config 
  212.           entries (000=00/00). 
  213.           
  214.           The format of each entry is as follows:
  215.  
  216.           XXX=YY/ZZ  where XXX is the Security Level (must be 3 digits)
  217.                      where =  is a constant and MUST be included
  218.                      where YY is the # of games per day (must be 2 digits)
  219.                      where / is a constant and MUST be included
  220.                      where ZZ is num. minutes per Door entry (must be 2 digits)
  221.           
  222.           If the callers Security Level is NOT defined, his/her Plays Per
  223.           Day and Door Time will be controlled by the values in items
  224.           (1) and (2), above, respectively..
  225.  
  226.           You may define up to 10 Security Levels. All unused entries must
  227.           be defined as   000=00/00
  228.         --------------------------------------------------------------------
  229.           Example: Suppose you had 3 Security Levels defined on your BBS as
  230.           (20=Subscriber, 30=Visiting Sysop, 40=CoSysop, 90=Friend) and you 
  231.           wanted to set Plays Per Day as :     Subscriber=5
  232.                                            Visiting Sysop=2
  233.                                                   CoSysop=3
  234.                                                    Friend=10 
  235.           
  236.           and Door Time as follows:     Subscriber=30 minutes
  237.                                     Visiting Sysop=20 minutes
  238.                                            CoSysop=10 minutes 
  239.                                             Friend=remaining call time
  240.                                
  241.  
  242.           You would set the Individual "Games per Day" config entry to 1 and 
  243.           the individual "Door Time" to 5 minutes (these would be the 
  244.           default number of games and default Time for all Security Levels
  245.           other than 20,30 or 40... make them any number you want). Next you
  246.           would replace 4 of the Security Level entries as :  020=05/30                                               
  247.                                                               030=02/20
  248.                                                               040=03/10
  249.                                                               090=10/0
  250.  
  251.  
  252.  
  253.  
  254.                            QUESTION FILE(S) SETUP
  255.                            ______________________
  256.  
  257.         MatchMaker has the ability to use 2 question files, one for Male
  258.         and one for Female. The Male question file must be named MMQUESTM.QUE
  259.         and the Female question file must be named MMQUESTF.QUE. The Male 
  260.         file is REQUIRED to be present and the Female file is OPTIONAL. If you
  261.         do NOT want separate question files, DO NOT create the MMQUESTF.QUE
  262.         file. If you do use both, bear in mind that the questions should be
  263.         essentially the same, but may be "slanted" to either sex. You will
  264.         not get many matches if you use entirely different questions and
  265.         answers. A sample MMQUESTM.QUE file is included to get you started.
  266.         
  267.         You  may have up to 50 questions.
  268.  
  269.         Each question can be up to 2 lines
  270.  
  271.         Each question can have up to 14 answers.
  272.  
  273.         The following is an explanation of how to set up this file:
  274.  
  275.         38                         <number of questions in this file
  276.         1                          <number of lines in the 1st question
  277.         10                         <number of answers
  278.         How old are you?           <question line 1
  279.         Less than 18 years old     <answer A
  280.         18 - 20 years old          <answer B
  281.         21 - 25 years old          <answer C
  282.         26 - 28 years old          <answer D
  283.         29 - 32 years old          <answer E
  284.         33 - 38 years old          <answer F
  285.         39 - 43 years old          <answer G
  286.         44 - 49 years old          <answer H
  287.         50 - 60 years old          <answer I
  288.         Over 60 years old          <answer J
  289.         2                          <number of lines in the last question
  290.         3                          <number of answers
  291.         "Now honestly, did you tell the whole truth on the"
  292.         "questionnaire, and nothing but the truth so help you God?"
  293.         "Yes, I told the whole truth"
  294.         A few lies never hurt anyone
  295.         I told mostly the truth
  296.  
  297.         In  the  above  example  the first line is the  total  number  of 
  298.         questions contained in the file.
  299.  
  300.         Line 2 is the number of lines in the first question.
  301.  
  302.         Line 3 is the number of answers listed for the question.
  303.  
  304.         Line 4 is the first question in the file.
  305.  
  306.         Lines 5 to 13 are the answers for the first question
  307.  
  308.         The last 7 lines break down as follows:
  309.  
  310.         Line 1 states that this question has two lines.
  311.  
  312.         Line 2 states that there are 3 answers listed
  313.  
  314.         Line 3 is the first line of the question.
  315.  
  316.         Line 4 is the second line of the question.
  317.  
  318.         Line 5 is the first answer.
  319.  
  320.         Line 6 is the second answer.
  321.  
  322.         Line 7 the third and last answer.
  323.  
  324.         A  line,  whether a question or an answer,  must be  enclosed  in 
  325.         quotation  marks  (") if the line contains any punctuation  other 
  326.         then a '?'. (see example files)
  327.  
  328.         The shorter the question the better.  One liners are the 
  329.         best, two liners ok, but three or more becomes tedious.
  330.  
  331.         There are two questions you need not worry about including in the 
  332.         file. These are:
  333.  
  334.                          What is your Sex
  335.                          What is your current age
  336.  
  337.         Since  the program must have these to work correctly,  they are
  338.         asked when you first log on.
  339.  
  340.  
  341.  
  342.  
  343.               MATCHMAKER MAINTENANCE PROGRAM (MMAINT)
  344.               _______________________________________
  345.  
  346.       The Caller Databse and Message Database, that MatchMaker utilizes, 
  347.       must be purged periodically. The Caller database can hold a maximum
  348.       of 1000 callers, and the Message database can hold a maximum of
  349.       1000 messages.
  350.  
  351.       After a message is read, it is marked for deletion, but not physically 
  352.       deleted form the database. The maintenance program (MMAINT), when run, 
  353.       will remove all messages marked for deletion, as well as those messages
  354.       that have ben on the system longer than the number of days specified on
  355.       the command line.
  356.  
  357.       There are 2 ways to remove a caller form teh Callers database. You can
  358.       delete it manually, after searching for & viewing the record or 
  359.       automatically if the door has not been accessed in the number of days
  360.       specified on the command line.
  361.  
  362.       The command line required to run MMAINT is as follows:
  363.  
  364.       MMAINT vvvvvvv.CFG /E:x /MDAYS:yy /CDAYS:zzz
  365.  
  366.           vvvvvvv.CFG  =  MatchMaker Confgiuration FIle
  367.                     x  =  N (Run Manually)
  368.                     x  =  Y (Run as an Event)
  369.                   yyy  =  Delete message if message is older than yyy days.
  370.                   zzz  =  Delete User if MMAKER not accessed in zzz days.
  371.  
  372.       As you can see, you can run MMAINT in your nightly event and/or manually.
  373.       Just adjust the /E: parameter, on the command line, accordingly.
  374.  
  375.       Special Note: The only option available to Non=Registered users is the
  376.                     option to search/view a caller's record. All other require
  377.                     you to run a registered copy of MatchMaker.
  378.  
  379.  
  380.  
  381.                              COM Support
  382.                              ___________
  383.  
  384.       Support for COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and
  385.       COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ
  386.       number after the configuration filename. Let's assume your Door is
  387.       called FOOBAR and you want to use COM1 and IRQ5. The command line
  388.       passed to your Door would be:
  389.                                    FOOBAR FOOBAR.CFG /5
  390.       The /5 tells FOOBAR to use IRQ5 rather than the standard IRQ4 that is
  391.       normally used with COM1. No /x parameter is needed for the standard
  392.       IRQ's.
  393.  
  394.  
  395.  
  396.                                ADOPT-A-DOOR
  397.                                ____________
  398.  
  399.     Having been a Sysop for a number of years, I have had my share of problems
  400.     and frustrations getting financial support for my board's upkeep. A fellow
  401.     Sysop left a message on my board, not long ago, about a concept that was
  402.     being used by several boards around the country.
  403.  
  404.     The concept, ADOPT-A-DOOR, allows a caller to register (ADOPT) a door. It
  405.     would be the same as sending in a donation, only this way it is earmarked
  406.     for registering a particular door. In a way, the user feels he/she is
  407.     "getting something in return". As a Door author I have decided to build
  408.     this concept into each of my Door programs. The concept replaces the
  409.     usual message "tell the Sysop to register this Door" we find in most
  410.     doors.
  411.  
  412.     If the Door is unregisterd then a message appears on the opening screen
  413.     to that effect. After finishing or suspending a game, a message screen
  414.     is displayed about the ADOPT-A-DOOR concept. The message also tells the
  415.     caller to contact the Sysop to find out if there is any further details
  416.     to the ADOPT-A-DOOR concept. Some Sysops give extra D/L time, online
  417.     time, etc to callers that ADOPT-A-DOOR.
  418.  
  419.     If the Door has been registered, either by the Sysop or other callers,
  420.     the names of those contributors will be displayed in the closing screen.
  421.  
  422.     NOTE: If you want to display the names of the callers that contributed
  423.           to registering the Door, you must create an ASCII file called
  424.           ADOPT.SYS. You create it with an Editor or Word Processor. Enter
  425.           the name(s) of the contributors (one on each line, maximum of 5
  426.           entries, each a maximum of 30 characters long). This file must be
  427.           saved, in ASCII format, and placed in the Door directory.
  428.  
  429.  
  430.  
  431.                               LEGALITIES
  432.                               __________
  433.  
  434.  
  435.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  436.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  437.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  438.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  439.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  440.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  441.       OR BREACH OF ANY WARRANTY.
  442.  
  443.  
  444.  
  445.  
  446.  
  447.                              DISTRIBUTION
  448.                              ____________
  449.  
  450.    You may make this file available for downloading from your BBS or you may
  451.    upload it to any BBS of your choice, provided that you do not make any
  452.    changes to the contents of the archive (ZIP file). The archive and its
  453.    individual contents may not be used by any service that charges any money
  454.    whatsoever, without the written permission of the author.
  455.  
  456.  
  457.  
  458.  
  459.  
  460.                              REGISTRATION
  461.                              ____________
  462.  
  463.    Registration and the subsequent insertion of the registration number into
  464.    your configuation file, allows for the display of your BBS name on the
  465.    opening and closing screen as well as the reduction of a delay built into
  466.    the opening screen display along with the ability to change certain
  467.    values in the configuration file.
  468.  
  469.    To register your copy of BETSY, please fill out the registration form
  470.    (REGISTER.FRM) and mail it along with a small donation ($20,25,etc) to
  471.    the name and address on the form.
  472.  
  473.    Be sure to use the proper upper/lower case when filling in your name and
  474.    BBS name, as they MUST match the way you entered them in the configuration
  475.    file.             ^^^^
  476.  
  477.    Based upon information supplied on the registration form, I will pre-
  478.    register you on my BBS. You will then be able to call SUNRISE-80 and pick
  479.    up your registration number.
  480.  
  481.  
  482.  
  483.                                  MISC
  484.                                  ____
  485.  
  486.    The latest version of MATCH MAKER and other fine SUNRISE DOOR programs
  487.    are always available for download from SUNRISE-80 BBS.
  488.  
  489.    Remember, should you have any problems, questions or suggestions, be sure
  490.    to drop me a message on Sunrise-80 or in the RIME network (BBS_Doors, 
  491.    PCBHints, SYSops) or on SMARTNET (SN_Sysops).
  492.