home *** CD-ROM | disk | FTP | other *** search
/ Media Share 9 / MEDIASHARE_09.ISO / sunrise / crypto22.zip / CRYPTO.DOC < prev    next >
Text File  |  1993-06-19  |  20KB  |  442 lines

  1.  
  2.                               CRYPTOGRAMS
  3.  
  4.                                   v2.2
  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.    In CRYPTOGRAMS you must solve a coded phrase. It is played exactly like
  23.    the puzzle games of the same name, that appear in magazines and newspapers.
  24.    It is very difficult to solve and requires a lot of patience.
  25.  
  26.  
  27.    NOTE: Most errors will be logged to a file called DFRAME.ERR which is
  28.          created in the directory you run the door from.
  29.  
  30.  
  31.  
  32.                               INSTALLATION
  33.                               ____________
  34.  
  35.  
  36.    Installation is fairly easy and straight-forward. The following steps and
  37.    examples should have you up and running in a very short period of time.
  38.    It is assumed that you are familiar with setting up DOORS on your system.
  39.    To this end, only examples of the configuration file and Door batch file
  40.    are described.
  41.  
  42.       1) Create a directory to hold all CRYPTO files
  43.  
  44.       2) Unzip CRYPTOxx.ZIP into the the above directory
  45.  
  46.       3) Create a configuration file, with a name of your choice, or
  47.          modify the supplied CRYPTO.CFG file. A description follows:
  48.  
  49.             **                       Location of system file (See Below)
  50.             SUNRISE-80 BBS           Your BBS Name
  51.             Al                       Sysop's First name
  52.  
  53.             Lawrence                 Sysop's Last Name
  54.  
  55. |-----------------------------------------------------------------------------|
  56. | READ!     1                        CommPort  \ These 2 lines are required   |
  57. | READ!     1                        Node #    / ONLY for GTUSER.BBS          |
  58. |-----------------------------------------------------------------------------|
  59.  
  60.             00000000                 Registration Number
  61.  
  62.     !   #   1                        Maximum # of Calls per day(Plays per day)
  63.                                      (Sysop gets 99, Registered version ONLY)
  64.  
  65.             50                       Number of Top Score entries.
  66.                                      Minimum = 10, Maximum = 99.
  67.  
  68.         #   NONE                     Drive:\Path\Filename to contain the
  69.                                      Top Score Bulletin or enter NONE
  70.                                      for NO Bulletin creation.
  71.  
  72.         #   NONE                     Drive:\Path\Filename to contain the
  73.                                      Top Score Bulletin (Color) or enter NONE
  74.                                      for NO Bulletin creation.
  75.  
  76.             2                        1 = DO NOT Display ADOPT-A-DOOR Message
  77.                                      2 = Display ADOPT-A-DOOR message
  78.  
  79.         #   2                        Keyboard timeout value in Minutes
  80.  
  81.     !   #   0                        Time Allowed in Door
  82.                                      (Sysop = Time Remaining - REG. VERSION)
  83.  
  84.         #   2                        Number of players that must solve the
  85.                                      Cryptogram before it is changed by
  86.                                      your nightly event.
  87.  
  88.         #   Y                        Y = Allow Sysop to have 999 games
  89.                                      N = Do Not Allow Sysop 999 games
  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.           ** = Replace with ONE of the following:
  109.  
  110. C:\PCB\PCBOARD.SYS              <- For PCBoard systems using PCBOARD.SYS only
  111. C:\BBS\CALLINFO.BBS             <- For Wildcat! systems (prior to v3.0)
  112. C:\BBS\DOOR.SYS                 <- For ANY systems that support DOOR.SYS
  113. C:\BBS\DORINFOx.DEF             <- For ANY systems that support DORINFOx.DEF
  114. C:\BBS\SFDOORS.DAT              <- For Spitfire systems.
  115. c:\bbs\TRIBBS.SYS               <- For TriBBS system.
  116. C:\BBS\CHAIN.TXT                <- For WWIV systems
  117. C:\BBS\GTUSER.BBS               <- For GT Power
  118.                                    * if using this option you must put the
  119.                                      ComPort # on line 5 and the Node # on
  120.                                      line 6 of the configuration file
  121.  
  122.  
  123.  
  124.            # = Requires registration to change to a different value.
  125.            ! = See "Plays Per Day" Below
  126.            @ = See "Blackout Periods" Below
  127.  
  128.                NOTE: There are NO Blank Lines in the Config File!!
  129.  
  130.  
  131.  
  132.  
  133.       4) Create a batch file or modify the CRYPTO file supplied. A
  134.          description of this file follows:
  135.  
  136.             ECHO off
  137.             cd\PCB\DOORS\CRYPTO       Location of CRYPTO files
  138.             CRYPTO CRYPTO.CFG         EXE filename and CFG filename (Name
  139.                                       used in creating file in #3 above)
  140.             CD\PCB
  141.             BOARD
  142.  
  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) If running with Fossil-based multi-port boards add
  148.            /FD to the line containing the CFG name as follows:
  149.  
  150.                         CRYPTO CRYPTO.CFG /FD
  151.  
  152.  
  153.  
  154.                           BLACKOUT PERIODS
  155.                           ________________
  156.  
  157.       Use the Blackout ranges option to define up to 5 time periods during
  158.       which you DO NOT want the Door to be played. If a caller tries to access
  159.       the Door during the Blackout period, they will be shown a message that
  160.       contains ALL the Blackout periods you have defined, and to try the Door
  161.       at a later time.
  162.  
  163.       Each of the 5 Blackout ranges takes the form of XXXX/YYYY, where
  164.       XXXX=beginning time and YYYY=the ending time. For example, 0930/1230
  165.       means to NOT allow the Door to be played between 9:30am and 12:30pm.
  166.  
  167.       IMPORTANT: - All times must be 4 digits & must follow the XXXX/YYYY format
  168.                  - DO NOT change the XXXX/YYYY entry UNLESS you want to assign
  169.                    a Blackout range.
  170.                  - You MUST use the MILITARY time format. Example: 2030=8:30pm
  171.                    0900=9am, 0030=12:30am, 1700=5pm, etc.
  172.  
  173.  
  174.                           PLAYS Per DAY/DOOR Time
  175.                           _______________________
  176.  
  177.       Plays Per Day and Door Time can be controlled several ways:
  178.  
  179.       (1) You can use the Games Per Day, singular option, in the config
  180.           file above. This option, will affect ALL callers whose Security
  181.           Level is NOT defined in any of the 10 optional Security Level/
  182.           Plays Per Day entries in the config file.
  183.  
  184.       (2) You can use the Door Time, singular option, in the config file
  185.           above. This option, will affect ALL callers whose Security
  186.           Level is NOT defined in any of the 10 optional Security Level/
  187.           Plays Per Day/Door Time entries in the config file.
  188.  
  189.       (3) You can restrict the number of games a specific Security Level
  190.           will be allowed to play per day or REWARD specific Levels with
  191.           more Plays Per Day.
  192.  
  193.           Likewise, you can restrict the Play time for a specific Security
  194.           Level or REWARD specific Levels with more Door Time.
  195.  
  196.           These options are handled by the use of the 10 config
  197.           entries (000=00/00).
  198.  
  199.           The format of each entry is as follows:
  200.  
  201.           XXX=YY/ZZ  where XXX is the Security Level (must be 3 digits)
  202.                      where =  is a constant and MUST be included
  203.                      where YY is the # of games per day (must be 2 digits)
  204.                      where / is a constant and MUST be included
  205.                      where ZZ is num. minutes per Door entry (must be 2 digits)
  206.  
  207.           If the callers Security Level is NOT defined, his/her Plays Per
  208.           Day and Door Time will be controlled by the values in items
  209.           (1) and (2), above, respectively..
  210.  
  211.           You may define up to 10 Security Levels. All unused entries must
  212.           be defined as   000=00/00
  213.         --------------------------------------------------------------------
  214.           Example: Suppose you had 3 Security Levels defined on your BBS as
  215.           (20=Subscriber, 30=Visiting Sysop, 40=CoSysop, 90=Friend) and you
  216.           wanted to set Plays Per Day as :     Subscriber=5
  217.                                            Visiting Sysop=2
  218.                                                   CoSysop=3
  219.                                                    Friend=10
  220.  
  221.           and Door Time as follows:     Subscriber=30 minutes
  222.                                     Visiting Sysop=20 minutes
  223.                                            CoSysop=10 minutes
  224.                                             Friend=remaining call time
  225.  
  226.  
  227.           You would set the Individual "Games per Day" config entry to 1 and
  228.           the individual "Door Time" to 5 minutes (these would be the
  229.           default number of games and default Time for all Security Levels
  230.           other than 20,30 or 40... make them any number you want). Next you
  231.           would replace 4 of the Security Level entries as :  020=05/30
  232.                                                               030=02/20
  233.                                                               040=03/10
  234.                                                               090=10/0
  235.  
  236.  
  237.                             EVENT PROCESSING
  238.                             ________________
  239.  
  240.       To change the CRYPTOGRAM phrases automatically, you must run the
  241.       CRYPENVT.EXE program, using the same configuration file you use for the
  242.       Door. Place the following in your nightly event batch file and it will
  243.       check the CFG file to see if the correct number of players have solved
  244.       the CRYPTOGRAM. If so it will change the CRYPTOGRAM by taking the next
  245.       available one from the CRYPTO.DAT file, and reset the Hi Score file for
  246.       a new game.
  247.  
  248.                              CRYPENVT CRYPTO.CFG
  249.  
  250.      NOTE: This option requires that CRYPTOGRAMS be registered!!!
  251.  
  252.  
  253.                               CRYPTOGRAM DATABASE
  254.                               ____________________
  255.  
  256.      The CRYPTOGRAM database (CRYPTO.DAT) can be added to using your favorite
  257.      text editor. Phrases MUST only contain alphabetic characters (A-Z) and
  258.      spaces. No other characters will be permitted. The maximum length of any
  259.      phrase is 66.
  260.  
  261.  
  262.  
  263.                         NON-STANDARD COM SUPPORT
  264.                         ________________________
  265.  
  266.       Support for COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and
  267.       COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ
  268.       number after the configuration filename. Let's assume your Door is
  269.       called FOOBAR and you want to use COM1 and IRQ5. The command line
  270.       passed to your Door would be:
  271.  
  272.                             FOOBAR FOOBAR.CFG /5
  273.  
  274.       The /5 tells FOOBAR to use IRQ5 rather than the standard IRQ4 that is
  275.       normally used with COM1. No /x parameter is needed for the standard
  276.       IRQ's.
  277.  
  278.       As an alternative, you may use an environmental variable on the command
  279.       line. To use the variable (following the example above), place a
  280.       SET IRQ=5 in the batch file used to bring up your BBS (you would need a
  281.       different IRQ number for each node). The command line would now look
  282.       like this:
  283.  
  284.                           FOOBAR FOOBAR.CFG /%IRQ%
  285.  
  286.       This, in combination with the use of the environmental variables
  287.       described in the MULTI-NODE SETUP section will allow you to use one
  288.       batch file and one config file to run this door on all nodes.
  289.  
  290.  
  291.  
  292.  
  293.                            MULTI-NODE SETUP
  294.                            ________________
  295.  
  296.       All Sunrise Doors are Multi-Node capable. Each node must have the
  297.       ability to access a configuration file which will have its own system
  298.       file (DORINFOx.DEF, PCBOARD.SYS, DOOR.SYS, etc) defined on the first
  299.       line. There are 2 ways to accomplish this:
  300.  
  301.       (1) Create a separate configuration file for each node. The only
  302.           difference between each file would be the location of the system
  303.           file for that particular node. For example, on my system there are 2
  304.           nodes and the first line of the config files would look like this:
  305.  
  306.                         NODE1:  H:\PCB1\DOOR.SYS
  307.                         NODE2:  H:\PCB2\DOOR.SYS
  308.  
  309.           Thus, if you have a 4 node BBS, you will need 4 configuration files.
  310.  
  311.       (2) Use ONE configuration file for ALL nodes. This Door will recognize
  312.           the following PCBoard environmental variables:
  313.  
  314.                  PCBDIR    (Directory containing the System file)
  315.                  PCBDRIVE  (Drive containing the System file)
  316.  
  317.           Thus, the first line of the SINGLE configuration file, for this Door
  318.           would look like this:
  319.  
  320.                         %PCBDRIVE%%PCBDIR%\DOOR.SYS
  321.  
  322.       NOTE: This option, as described, assumes that you are running PCBoard
  323.             14.5a software. The environmental variables are automatically
  324.             created by the software for each node.
  325.  
  326.             HOWEVER, if you are running other BBS software you should be able
  327.             to set the variables EXACTLY as described below, for EACH node
  328.             (more than likely in each batch file you use to bring up EACH node):
  329.  
  330.                             PCBDRIVE=C:
  331.                             ^^^^^^^^^
  332.                             PCBDIR=\NODE2
  333.                             ^^^^^^^^
  334.  
  335.             Info with a carat (^) under it, MUST be typed as is. The rest
  336.             depends on your naming conventions.
  337.  
  338.             This, in combination with the use of the optional environmental
  339.             variable described in the NON-STANDARD COM SUPPORT section, will
  340.             allow you to use one batch file and one config file to run this
  341.             door on all nodes.
  342.  
  343.  
  344.  
  345.  
  346.                                ADOPT-A-DOOR
  347.                                ____________
  348.  
  349.     Having been a Sysop for a number of years, I have had my share of problems
  350.     and frustrations getting financial support for my board's upkeep. A fellow
  351.     Sysop left a message on my board, not long ago, about a concept that was
  352.     being used by several boards around the country.
  353.  
  354.     The concept, ADOPT-A-DOOR, allows a caller to register (ADOPT) a door. It
  355.     would be the same as sending in a donation, only this way it is earmarked
  356.     for registering a particular door. In a way, the user feels he/she is
  357.     "getting something in return". As a Door author I have decided to build
  358.     this concept into each of my Door programs. The concept replaces the
  359.     usual message "tell the Sysop to register this Door" we find in most
  360.     doors.
  361.  
  362.     If the Door is unregisterd then a message appears on the opening screen
  363.     to that effect. After finishing or suspending a game, a message screen
  364.     is displayed about the ADOPT-A-DOOR concept. The message also tells the
  365.     caller to contact the Sysop to find out if there is any further details
  366.     to the ADOPT-A-DOOR concept. Some Sysops give extra D/L time, online
  367.     time, etc to callers that ADOPT-A-DOOR.
  368.  
  369.     If the Door has been registered, either by the Sysop or other callers,
  370.     the names of those contributors will be displayed in the closing screen.
  371.  
  372.     NOTE: If you want to display the names of the callers that contributed
  373.           to registering the Door, you must create an ASCII file called
  374.           ADOPT.SYS. You create it with an Editor or Word Processor. Enter
  375.           the name(s) of the contributors (one on each line, maximum of 5
  376.           entries, each a maximum of 30 characters long). This file must be
  377.           saved, in ASCII format, and placed in the Door directory.
  378.  
  379.  
  380.  
  381.                               LEGALITIES
  382.                               __________
  383.  
  384.  
  385.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  386.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  387.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  388.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  389.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  390.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  391.       OR BREACH OF ANY WARRANTY.
  392.  
  393.  
  394.  
  395.  
  396.  
  397.                              DISTRIBUTION
  398.                              ____________
  399.  
  400.    You may make this file available for downloading from your BBS or you may
  401.    upload it to any BBS of your choice, provided that you do not make any
  402.    changes to the contents of the archive (ZIP file). The archive and its
  403.    individual contents may not be used by any service that charges any money
  404.    whatsoever, without the written permission of the author.
  405.  
  406.  
  407.  
  408.  
  409.  
  410.                              REGISTRATION
  411.                              ____________
  412.  
  413.    Registration and the subsequent insertion of the registration number into
  414.    your configuation file, allows for the display of your BBS name on the
  415.    opening and closing screen as well as the reduction of a delay built into
  416.    the opening screen display along with the ability to change certain
  417.    values in the configuration file.
  418.  
  419.    To register your copy of CRYPTO, please fill out the registration form
  420.    (REGISTER.FRM) and mail it along with the registration fee to
  421.    the name and address on the form.
  422.  
  423.    Be sure to use the proper upper/lower case when filling in your name and
  424.    BBS name, as they MUST match the way you entered them in the configuration
  425.    file.             ^^^^
  426.  
  427.    Based upon information supplied on the registration form, I will pre-
  428.    register you on my BBS. You will then be able to call SUNRISE-80 and pick
  429.    up your registration number.
  430.  
  431.  
  432.  
  433.                                  MISC
  434.                                  ____
  435.  
  436.    The latest version of CRYPTOGRAMS and other fine SUNRISE DOOR programs
  437.    are always available for download from SUNRISE-80 BBS.
  438.  
  439.    Remember, should you have any problems, questions or suggestions, be sure
  440.    to drop me a message on Sunrise-80 or in the RIME network (BBS_Doors,
  441.    PCBHints, SYSops) or on SMARTNET (SN_Sysops).
  442.