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