home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1994 #1 / monster.zip / monster / BBS_SUN / LMATCH18.ZIP / LMATCH.DOC < prev    next >
Text File  |  1994-03-14  |  24KB  |  544 lines

  1.  
  2.                               LETTER  MATCH
  3.  
  4.                                   v1.8
  5.  
  6.                                    by
  7.  
  8.                               Al Lawrence
  9.  
  10.                             Sunrise-80  BBS
  11.                          (404) 256-9525 (Data)
  12.                          (404) 705-9104 (Data)
  13.                  (404) 256-9518 (Voice, 9am-9:30pm EST)
  14.  
  15.  
  16.  
  17.  
  18.                                 OVERVIEW
  19.                                 ________
  20.  
  21.  
  22. LETTER MATCH is an easy to play and very challenging word game, designed
  23. to test your memory, category knowledge and spelling.
  24.  
  25. The object of the game is to match as many words as possible, each time
  26. trying to beat the score you have posted in the high score file, as well
  27. other players scores.
  28.  
  29. The Sysop determines the category subject and the program will display it
  30. at the top of the box that contains the current word you are working with.
  31.  
  32. You must think of a word, in line with the current category, whose first
  33. letter matches the last letter of the word in the box OR whose last letter
  34. matches the first letter of the word in the box.
  35.  
  36. For Example: Given the category "STATES and CAPITALS" and an initial word
  37.              of "OREGON", you could use "OHIO" to match the first letter
  38.              in "OREGON" or you could use "NEW YORK" to match the last
  39.              letter in "OREGON".
  40.  
  41.  
  42.    NOTE: Most errors will be logged to a file called DFRAME.ERR which is
  43.          created in the directory you run the door from.
  44.  
  45.  
  46.  
  47.                 NON-REGISTERED   R E S T R I C T I O N S
  48.                 ----------------------------------------
  49.  
  50.                 ° No Bulletins created
  51.                 ° Games per day limited to 3
  52.                 ° Keyboard timeout value limitied to 2 minutes
  53.                 ° Makeup days disabled
  54.                 ° Game time limit disabled
  55.                 ° Scores will reset at a random time between
  56.                   22 and 29 days of use
  57.  
  58.  
  59.  
  60.  
  61.                               INSTALLATION
  62.                               ____________
  63.  
  64.  
  65.    Installation is fairly easy and straight-forward. The following steps and
  66.    examples should have you up and running in a very short period of time.
  67.    It is assumed that you are familiar with setting up DOORS on your system.
  68.    To this end, only examples of the configuration file and Door batch file
  69.    are described.
  70.  
  71.       1) Create a directory to hold all LMATCH files
  72.  
  73.       2) Unzip LMATCHxx.ZIP into the the above directory
  74.  
  75.       3) Create a configuration file, with a name of your choice, or
  76.          modify the supplied LMATCH.CFG file. A description follows:
  77.  
  78.             **                       Location of system file (See Below)
  79.             SUNRISE-80 BBS           Your BBS Name
  80.             Al                       Sysop's First name
  81.  
  82.             Lawrence                 Sysop's Last Name
  83.  
  84. |-----------------------------------------------------------------------------|
  85. | READ!     1                        CommPort  \ These 2 lines are required   |
  86. | READ!     1                        Node #    / ONLY for GTUSER.BBS          |
  87. |-----------------------------------------------------------------------------|
  88.  
  89.             00000000                 Registration Number
  90.  
  91.     !   #   3                        Maximum # of Games per day
  92.                                      (Sysop gets 99, Registered version ONLY)
  93.  
  94.         #   0                        Max # of days a caller can make up, during
  95.                                      calls in one day. 0=Disable Make-up Option
  96.                                      Maximum value = 27, Minimum value = 1
  97.  
  98.         #   NONE                     Drive:\Path\Filename to contain the
  99.                                      Top Score Bulletin or enter NONE
  100.                                      for NO Bulletin creation.
  101.  
  102.         #   NONE                     Drive:\Path\Filename to contain the
  103.                                      Top Score Bulletin (Color) or enter NONE
  104.                                      for NO Bulletin creation.
  105.  
  106.         #   NONE                     Drive:\Path\Filename to contain the
  107.                                      Hall of Fame Bulletin or enter NONE
  108.                                      for NO Bulletin creation.
  109.  
  110.         #   NONE                     Drive:\Path\Filename to contain the
  111.                                      Hall of Fame Bulletin (Color) or enter NONE
  112.                                      for NO Bulletin creation.
  113.  
  114.             2                        1 = DO NOT Display ADOPT-A-DOOR Message
  115.                                      2 = Display ADOPT-A-DOOR message
  116.  
  117.         #   2                        Keyboard timeout value in Minutes
  118.  
  119.     !   #   0                        Time allowed in Door
  120.                                      (Sysop = Time Remaining - REG. VERSION)
  121.  
  122.             c:\bbs\door\lmatch.cat   Drive:\Path\Filename of the Category file
  123.  
  124.         #   N                        Y = Play a Solitaire Game
  125.                                      N = Computer plays
  126.  
  127.         #   1                        Scoring: Points earned per match
  128.  
  129.         #   N                        Automatic game reset at end of month:
  130.                                        Y = Yes enable autoreset
  131.                                        N = Keep accumulating scores
  132.  
  133.         #   Y                        Y = Allow Sysop to have 999 games
  134.                                      N = Do Not Allow Sysop 999 games
  135.  
  136.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  137.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  138.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  139.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  140.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  141.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  142.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  143.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  144.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  145.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  146.  
  147.     @   #   XXXX/YYYY                 Blackout Range  From/To
  148.     @   #   XXXX/YYYY                 Blackout Range  From/To
  149.     @   #   XXXX/YYYY                 Blackout Range  From/To
  150.     @   #   XXXX/YYYY                 Blackout Range  From/To
  151.     @   #   XXXX/YYYY                 Blackout Range  From/To
  152.  
  153.             N                         Y = Force Caller to respond to
  154.                                           Instructions <y/n). May need this with
  155.                                           Digiboards.
  156.                                       N = Allow caller to press ENTER in
  157.                                           response to Instructions <y/N>
  158.  
  159.  
  160.  
  161.               ** = Replace with ONE of the following:
  162.  
  163. C:\PCB\PCBOARD.SYS              <- For PCBoard systems using PCBOARD.SYS only
  164. C:\BBS\CALLINFO.BBS             <- For Wildcat! systems (prior to v3.0)
  165. C:\BBS\DOOR.SYS                 <- For ANY systems that support DOOR.SYS
  166. C:\BBS\DORINFOx.DEF             <- For ANY systems that support DORINFOx.DEF
  167. C:\BBS\SFDOORS.DAT              <- For Spitfire systems.
  168. c:\bbs\TRIBBS.SYS               <- For TriBBS systems.
  169. C:\BBS\GTUSER.BBS               <- For GT Power
  170.                                    * if using this option you must put the
  171.                                      ComPort # on line 5 and the Node # on
  172.                                      line 6 of the configuration file
  173.  
  174.  
  175.  
  176.            # = Requires registration to change to a different value.
  177.            ! = See "Plays Per Day" Below
  178.            @ = See "Blackout Periods" Below
  179.  
  180.                NOTE: There are NO Blank Lines in the Config File!!
  181.  
  182.  
  183.  
  184.  
  185.       4) Create a batch file or modify the LMATCH file supplied. A
  186.          description of this file follows:
  187.  
  188.             ECHO off
  189.             cd\BBS\DOORS\LMATCH       Location of LMATCH files
  190.             LMATCH LMATCH.CFG         EXE filename and CFG filename (Name
  191.                                       used in creating file in #3 above)
  192.             CD\BBS
  193.             BOARD
  194.  
  195.  
  196.        5) When running in more than one node, be sure to supply a
  197.           different configuration name for each node (your choice of name).
  198.  
  199.        6) If running with Fossil-based multi-port boards add
  200.            /FD to the line containing the CFG name as follows:
  201.  
  202.                        LMATCH LMATCH.CFG /FD
  203.  
  204.  
  205.  
  206.                          CATEGORY FILES
  207.                          --------------
  208.  
  209. In the unregistered version of Letter Match, you MUST use the category I have
  210. supplied, STATES and CAPITALS, in the file called LMATCH.CAT.
  211.  
  212. After registration you are free to use the extra category file I have
  213. included in the LMATCHxx.ZIP (XTRA1.CAT-XTRA5-CAT) or you may modify the extra
  214. file or you may create your own. If you will be creating your own or modifying
  215. the extra ones, you must ensure that you follow this format:
  216.  
  217. Line 1: CAT:xxxxxxxxx
  218.  
  219.       CAT:    must be left as you see it
  220.       xxxxxxx is the category title that will appear in the box used to display
  221.               the individual category entries. The maximum length = 40 char.
  222.  
  223. Line 2: Category Entry
  224.  
  225.         All category entries can have a maximum length of 40 characters.
  226.         You may have up to 500 entries in each category file.
  227.  
  228. The types of categories are only limited by your imagination. I would suggest
  229. that you place a substantial number of entries in each category file and at a
  230. minimum be sure you include all the possible answers for that category (or as
  231. many as you can find). I can assure you your users will come up with ones you
  232. have missed <GRIN>. With that in mind, I will apologize now for any mistakes
  233. or ommissions in the extra category files I have supplied <g>..
  234.  
  235.  
  236.                MAKE-UP DAYS (Registered version only)
  237.                --------------------------------------
  238.  
  239. The Make-Up-Day feature allows the caller to make up any plays he/she missed
  240. during the current month and prior to the current call. You control whether
  241. to allow this option, as well as the number of days the caller can make up, on
  242. any prticular days worth of calls. Entering a 0 (zero) for this option, in the
  243. configuration file, turns the option OFF, any other value (up to a max of 27)
  244. turns the option ON and dictates the number of days the caller can make up.
  245.  
  246.  
  247. NOTE:      The number of games per day is calculated as follows...
  248.  
  249.            Games Allowed per day x Number of makeup days.
  250.  
  251. Example:   Games Allowed per day = 2
  252.            Max # of makeup days  = 4
  253.  
  254. If a caller logs in on 5/8/92 and this is their first call of the month, they
  255. would have a potential of 16 games to makeup and bring them current
  256. (8 days (5/8/92) * 2 (games per day)). However, since the maximum # of Makeup
  257. Days is set at 4, the maximum # of games the caller can play on 5/8/92, is 8
  258. (games allowed * max # of makeup days).
  259.  
  260.  
  261.  
  262.              HALL OF FAME BULLETINS (Registered version only)
  263.              ------------------------------------------------
  264.  
  265. The program will automatically reset the game when the first caller of the
  266. month plays the game. The score file will be cleared and a set of Hall of Fame
  267. bulletin files will be created. The files will be called SUNHOF.ASC and
  268. SUNHOF.ANS (ASCII and ANSI versions). The files will be placed in the same
  269. directory as the LAMTCH.EXE file. You are responsible for COPYING the files to
  270. your bulletin area and renaming to a filename of your choice.
  271.  
  272. WARNING: The HOF files are cumulative files. That means they are read in each
  273.          month and updated. DO NOT DELETE EITHER FILE!!!! or you will lose
  274.          the record of prior months winners!!!!
  275.  
  276.  
  277.  
  278.                           BLACKOUT PERIODS
  279.                           ________________
  280.  
  281.       Use the Blackout ranges option to define up to 5 time periods during
  282.       which you DO NOT want the Door to be played. If a caller tries to access
  283.       the Door during the Blackout period, they will be shown a message that
  284.       contains ALL the Blackout periods you have defined, and to try the Door
  285.       at a later time.
  286.  
  287.       Each of the 5 Blackout ranges takes the form of XXXX/YYYY, where
  288.       XXXX=beginning time and YYYY=the ending time. For example, 0930/1230
  289.       means to NOT allow the Door to be played between 9:30am and 12:30pm.
  290.  
  291.       IMPORTANT: - All times must be 4 digits & must follow the XXXX/YYYY format
  292.                  - DO NOT change the XXXX/YYYY entry UNLESS you want to assign
  293.                    a Blackout range.
  294.                  - You MUST use the MILITARY time format. Example: 2030=8:30pm
  295.                    0900=9am, 0030=12:30am, 1700=5pm, etc.
  296.  
  297.  
  298.  
  299.                           PLAYS Per DAY/DOOR Time
  300.                           _______________________
  301.  
  302.       Plays Per Day and Door Time can be controlled several ways:
  303.  
  304.       (1) You can use the Games Per Day, singular option, in the config
  305.           file above. This option, will affect ALL callers whose Security
  306.           Level is NOT defined in any of the 10 optional Security Level/
  307.           Plays Per Day entries in the config file.
  308.  
  309.       (2) You can use the Door Time, singular option, in the config file
  310.           above. This option, will affect ALL callers whose Security
  311.           Level is NOT defined in any of the 10 optional Security Level/
  312.           Plays Per Day/Door Time entries in the config file.
  313.  
  314.       (3) You can restrict the number of games a specific Security Level
  315.           will be allowed to play per day or REWARD specific Levels with
  316.           more Plays Per Day.
  317.  
  318.           Likewise, you can restrict the Play time for a specific Security
  319.           Level or REWARD specific Levels with more Door Time.
  320.  
  321.           These options are handled by the use of the 10 config
  322.           entries (000=00/00).
  323.  
  324.           The format of each entry is as follows:
  325.  
  326.           XXX=YY/ZZ  where XXX is the Security Level (must be 3 digits)
  327.                      where =  is a constant and MUST be included
  328.                      where YY is the # of games per day (must be 2 digits)
  329.                      where / is a constant and MUST be included
  330.                      where ZZ is num. minutes per Door entry (must be 2 digits)
  331.  
  332.           If the callers Security Level is NOT defined, his/her Plays Per
  333.           Day and Door Time will be controlled by the values in items
  334.           (1) and (2), above, respectively..
  335.  
  336.           You may define up to 10 Security Levels. All unused entries must
  337.           be defined as   000=00/00
  338.         --------------------------------------------------------------------
  339.           Example: Suppose you had 3 Security Levels defined on your BBS as
  340.           (20=Subscriber, 30=Visiting Sysop, 40=CoSysop, 90=Friend) and you
  341.           wanted to set Plays Per Day as :     Subscriber=5
  342.                                            Visiting Sysop=2
  343.                                                   CoSysop=3
  344.                                                    Friend=10
  345.  
  346.           and Door Time as follows:     Subscriber=30 minutes
  347.                                     Visiting Sysop=20 minutes
  348.                                            CoSysop=10 minutes
  349.                                             Friend=remaining call time
  350.  
  351.  
  352.           You would set the Individual "Games per Day" config entry to 1 and
  353.           the individual "Door Time" to 5 minutes (these would be the
  354.           default number of games and default Time for all Security Levels
  355.           other than 20,30 or 40... make them any number you want). Next you
  356.           would replace 4 of the Security Level entries as :  020=05/30
  357.                                                               030=02/20
  358.                                                               040=03/10
  359.                                                               090=10/0
  360.  
  361.  
  362.                         NON-STANDARD COM SUPPORT
  363.                         ________________________
  364.  
  365.       Support for COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and
  366.       COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ
  367.       number after the configuration filename. Let's assume your Door is
  368.       called FOOBAR and you want to use COM1 and IRQ5. The command line
  369.       passed to your Door would be:
  370.  
  371.                             FOOBAR FOOBAR.CFG /5
  372.  
  373.       The /5 tells FOOBAR to use IRQ5 rather than the standard IRQ4 that is
  374.       normally used with COM1. No /x parameter is needed for the standard
  375.       IRQ's.
  376.  
  377.       As an alternative, you may use an environmental variable on the command
  378.       line. To use the variable (following the example above), place a
  379.       SET IRQ=5 in the batch file used to bring up your BBS (you would need a
  380.       different IRQ number for each node). The command line would now look
  381.       like this:
  382.  
  383.                           FOOBAR FOOBAR.CFG /%IRQ%
  384.  
  385.       This, in combination with the use of the environmental variables
  386.       described in the MULTI-NODE SETUP section will allow you to use one
  387.       batch file and one config file to run this door on all nodes.
  388.  
  389.  
  390.  
  391.  
  392.                            MULTI-NODE SETUP
  393.                            ________________
  394.  
  395.       All Sunrise Doors are Multi-Node capable. Each node must have the
  396.       ability to access a configuration file which will have its own system
  397.       file (DORINFOx.DEF, PCBOARD.SYS, DOOR.SYS, etc) defined on the first
  398.       line. There are 2 ways to accomplish this:
  399.  
  400.       (1) Create a separate configuration file for each node. The only
  401.           difference between each file would be the location of the system
  402.           file for that particular node. For example, on my system there are 2
  403.           nodes and the first line of the config files would look like this:
  404.  
  405.                         NODE1:  H:\PCB1\DOOR.SYS
  406.                         NODE2:  H:\PCB2\DOOR.SYS
  407.  
  408.           Thus, if you have a 4 node BBS, you will need 4 configuration files.
  409.  
  410.       (2) Use ONE configuration file for ALL nodes. This Door will recognize
  411.           the following PCBoard environmental variables:
  412.  
  413.                  PCBDIR    (Directory containing the System file)
  414.                  PCBDRIVE  (Drive containing the System file)
  415.  
  416.           Thus, the first line of the SINGLE configuration file, for this Door
  417.           would look like this:
  418.  
  419.                         %PCBDRIVE%%PCBDIR%\DOOR.SYS
  420.  
  421.       NOTE: This option, as described, assumes that you are running PCBoard
  422.             14.5a software. The environmental variables are automatically
  423.             created by the software for each node.
  424.  
  425.             HOWEVER, if you are running other BBS software you should be able
  426.             to set the variables EXACTLY as described below, for EACH node
  427.             (more than likely in each batch file you use to bring up EACH node):
  428.  
  429.                             PCBDRIVE=C:
  430.                             ^^^^^^^^^
  431.                             PCBDIR=\NODE2
  432.                             ^^^^^^^^
  433.  
  434.             Info with a carat (^) under it, MUST be typed as is. The rest
  435.             depends on your naming conventions.
  436.  
  437.             This, in combination with the use of the optional environmental
  438.             variable described in the NON-STANDARD COM SUPPORT section, will
  439.             allow you to use one batch file and one config file to run this
  440.             door on all nodes.
  441.  
  442.  
  443.  
  444.                                ADOPT-A-DOOR
  445.                                ____________
  446.  
  447.     Having been a Sysop for a number of years, I have had my share of problems
  448.     and frustrations getting financial support for my board's upkeep. A fellow
  449.     Sysop left a message on my board, not long ago, about a concept that was
  450.     being used by several boards around the country.
  451.  
  452.     The concept, ADOPT-A-DOOR, allows a caller to register (ADOPT) a door. It
  453.     would be the same as sending in a donation, only this way it is earmarked
  454.     for registering a particular door. In a way, the user feels he/she is
  455.     "getting something in return". As a Door author I have decided to build
  456.     this concept into each of my Door programs. The concept replaces the
  457.     usual message "tell the Sysop to register this Door" we find in most
  458.     doors.
  459.  
  460.     If the Door is unregisterd then a message appears on the opening screen
  461.     to that effect. After finishing or suspending a game, a message screen
  462.     is displayed about the ADOPT-A-DOOR concept. The message also tells the
  463.     caller to contact the Sysop to find out if there is any further details
  464.     to the ADOPT-A-DOOR concept. Some Sysops give extra D/L time, online
  465.     time, etc to callers that ADOPT-A-DOOR.
  466.  
  467.     If the Door has been registered, either by the Sysop or other callers,
  468.     the names of those contributors will be displayed in the closing screen.
  469.  
  470.     NOTE: If you want to display the names of the callers that contributed
  471.           to registering the Door, you must create an ASCII file called
  472.           ADOPT.SYS. You create it with an Editor or Word Processor. Enter
  473.           the name(s) of the contributors (one on each line, maximum of 5
  474.           entries, each a maximum of 30 characters long). This file must be
  475.           saved, in ASCII format, and placed in the Door directory.
  476.  
  477.  
  478.  
  479.                               LEGALITIES
  480.                               __________
  481.  
  482.  
  483.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  484.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  485.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  486.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  487.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  488.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  489.       OR BREACH OF ANY WARRANTY.
  490.  
  491.  
  492.  
  493.  
  494.  
  495.                              DISTRIBUTION
  496.                              ____________
  497.  
  498.    You may make this file available for downloading from your BBS or you may
  499.    upload it to any BBS of your choice, provided that you do not make any
  500.    changes to the contents of the archive (ZIP file). The archive and its
  501.    individual contents may not be used by any service that charges any money
  502.    whatsoever, without the written permission of the author.
  503.  
  504.  
  505.  
  506.  
  507.  
  508.                              REGISTRATION
  509.                              ____________
  510.  
  511.    Registration and the subsequent insertion of the registration number into
  512.    your configuation file, allows for the display of your BBS name on the
  513.    opening and closing screen as well as the reduction of a delay built into
  514.    the opening screen display along with the ability to change certain
  515.    values in the configuration file.
  516.  
  517.    To register your copy of LMATCH please fill out the registration form
  518.    (REGISTER.FRM) and mail it along with the registration fee to
  519.    the name and address on the form.
  520.  
  521.    Once a door is registered, any changes to registration information (Sysop
  522.    name or BBS Name) will require the doors to be re-registered at the
  523.    registration fee in effect at that time.
  524.  
  525.    Be sure to use the proper upper/lower case when filling in your name and
  526.    BBS name, as they MUST match the way you entered them in the configuration
  527.    file.             ^^^^
  528.  
  529.    Based upon information supplied on the registration form, I will pre-
  530.    register you on my BBS. You will then be able to call SUNRISE-80 and pick
  531.    up your registration number.
  532.  
  533.  
  534.  
  535.                                  MISC
  536.                                  ____
  537.  
  538.    The latest version of Letter Match and other fine SUNRISE DOOR programs
  539.    are always available for download from SUNRISE-80 BBS.
  540.  
  541.    Remember, should you have any problems, questions or suggestions, be sure
  542.    to drop me a message on Sunrise-80 or in the RIME network (BBS_Doors,
  543.    PCBHints, SYSops) or on SMARTNET (SN_Sysops) or FIDO 1:133/410.
  544.