home *** CD-ROM | disk | FTP | other *** search
/ GEMini Atari / GEMini_Atari_CD-ROM_Walnut_Creek_December_1993.iso / files / bbs / dip_v14 / dipinstr.doc < prev    next >
Text File  |  1991-08-30  |  11KB  |  226 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.                            Door Interface Program
  7.                                    (DIP)
  8.                                 version  1.4
  9.                         (c) 1990-91 by Jeff Fehlman
  10.                             All rights reserved.
  11.  
  12.  
  13.      PURPOSE:
  14.  
  15.           This program was written to allow on-line games to be run
  16.      on a BBS system that might not otherwise be able to run them. 
  17.      It does this by writing an information file in the format the
  18.      game expects.  In addition, DIP provides a menu interface with
  19.      the user and log user actions if desired.
  20.  
  21.      INPUT:
  22.  
  23.           DIP expects the username to be passed to it upon execu-
  24.      tion.  This is all that it requires.
  25.  
  26.      OUTPUT:
  27.  
  28.           DIP provides FOREM.DAT, DORINF01.DAT, and USERNAME.DAT
  29.      data files, written to the location specified in the setup
  30.      menu.  There is a hook in the program to write a STARNET.DAT
  31.      file however the author has found no use for it (this may or
  32.      may not be implemented in a future version)!  In addition, a
  33.      LOG file is written if desired.
  34.  
  35.      SETUP:
  36.  
  37.           This package should include:
  38.                                            DIP.TTP
  39.                                            DIPSYSOP.PRG
  40.                                            DIPINSTR.DOC
  41.                                            REGISTER.FRM
  42.  
  43.           In addition DIP will create a data file for each menu
  44.      generated and a log file (if specified).  It is probably best
  45.      to keep all these files in the same folder although it is 
  46.      only necessary to keep DIP.TTP and DIPSYSOP.PRG together.
  47.      
  48.           To start, install DIP.TTP into your BBS system as a door.
  49.      Consult your BBS documentation for this procedure.  DIP was
  50.      created and tested on Intersanctum BBS (with TOS v1.0, if it
  51.      matters) and ST-Keep.  Basically, for IS, one specifies the
  52.      path and name (DIP.TTP) and writes "#u" in the parameter list
  53.      to pass the username to DIP.  Use on other BBS systems may or
  54.      may not work, depending upon the idiosyncrasies of the system
  55.      in question.  Now just run the DIP Door!  What will appear will
  56.      be a minimum DIP menu consisting of a title, "Door Interface
  57.      Program" and two menu items, Door (M)aintenance and e(X)it.
  58.  
  59.      MAIN MENU OPTION MENU:
  60.  
  61.           To set up your menu, type "M" from the DIP menu.  The 
  62.      system will bring up the Main Menu Option window.  Use the
  63.      "TAB" key to toggle from the "BBS Name", "Menu Title" and 
  64.      "Time Limit" options (NOTE:  It will also toggle through the
  65.      "Bulletin Path" and "LOG Path" fields but it is not recom-
  66.      mended to manually enter these fields.).  First, enter your
  67.      BBS name followed by <RETURN>, then the title you wish to
  68.      appear at the top of the menu, followed by <RETURN>.  The
  69.      time limit allows access to the menu only for the amount of
  70.      time you specify.
  71.           Now you are ready to specify the menu options.  Using 
  72.      your mouse you may specify whether or not the menu will dis-
  73.      play your BBS name, a bulletin of your choice or a "welcome"
  74.      message.  In addition you may choose to record a LOG file of
  75.      user activities in the menu system.
  76.           Specify Bulletin path/name.  If you have chosen to run
  77.      a bulletin at the beginning of the menu, click your mouse in
  78.      the "yes" box of this window.  A file selection window will
  79.      appear.  Using this window, specify the path and file name of
  80.      the ASCII file that will be your bulletin (make sure that you
  81.      have previously set the "Display Bulletin" flag to "yes").
  82.           Specify LOG file path/name.  If you have chosen to keep
  83.      a log of user activity (by clicking on "yes" for the "Record
  84.      LOG file" flag), click on the "yes" box of this window.  A
  85.      file selection window will appear where you should specify
  86.      the path and file name of the LOG.  Failure to do so will
  87.      result in errors being posted to the users.  AFTER this has
  88.      been done you should click on "yes" for "Initialize LOG file".
  89.      This will start your LOG (failure to do so will also result
  90.      in errors being posted to the users and possibly make menu
  91.      selections inaccessible).
  92.           Now click on the "Save" button.  This will save your
  93.      changes to disk and bring you back to the DIP menu.  Whenever
  94.      you make a change to the Main Menu Option menu you must save
  95.      it from this menu.
  96.  
  97.      MENU EDIT OPTION MENU:
  98.  
  99.           Click on "Edit Door" to enter this menu.  From here you
  100.      may create, delete, edit and move menu items.  To exit this
  101.      menu click on "Cancel".  "Create" and "Edit" will bring you
  102.      to the Edit Door Option Menu.
  103.  
  104.      EDIT DOOR OPTION MENU:
  105.  
  106.           This is where you will specify the game/program para-
  107.      meters for each menu item.  First, type in the title you
  108.      wish displayed in the menu.  Then select the emulation mode
  109.      required by the game/program.  This will set defaults in the
  110.      remaining fields.  The emulation modes are as follows:
  111.  
  112.           DORINF01 - Creates a DORINF01.DEF type file
  113.           USERNAME - Creates an ASCII file with the user's name
  114.           FOREM    - Creates a FOREM.DAT type file
  115.           STARNET  - Disabled
  116.           TEXT     - Specifies that the "program" is a ASCII text
  117.                      file.
  118.           DIP MENU - Specifies that the "program" is a DIP sub-
  119.                      menu (registered version ONLY!).
  120.  
  121.           The "Console Only" flag allows program maintenance pro-
  122.      grams (or anything else) to be accessible only in the con-
  123.      sole mode.  It will be invisible to the modem user.
  124.           The "LOG Program" flag tells DIP to keep a record of
  125.      activities related to this program (NOTE:  the "Record LOG
  126.      File" option in the Main Menu Option Menu must be set to 
  127.      "yes" and the LOG file specified and initialized).
  128.           The "Send LOCAL" and "Send Username" flags should be
  129.      already set.  They are listed in case you would like to 
  130.      override the default (not recommended).
  131.           Specify Program Path/Name.  Click on "yes" in this box
  132.      to bring up the file section window.  Specify the name and
  133.      path to the program/game you wish to run.
  134.           Specify Data File Path/Name.  Click on "yes" in this
  135.      box to specify the path and/or name of the emulation file
  136.      DIP will create (the FOREM.DAT and DORINF01.DEF names ap-
  137.      pear already).  The text file path and name is specified
  138.      here also.  
  139.           Your finished!  Click on "Save" and you will be brought
  140.      back to the Menu Edit Option Menu.  Repeat the process as 
  141.      needed.
  142.  
  143.      VERSION 1.4 ENHANCEMENTS:
  144.  
  145.           DIP now supports VT-52, ANSI and ASCII graphic modes.
  146.      There are two methods inwhich the graphic mode is determined.
  147.      First, DIP looks for a file called DIPNAME.DAT in it's home
  148.      directory.  This file must have the following format:
  149.  
  150.      USERNAME  -- The name to be passed to the target program.
  151.      #         -- The number cooresponding to the desired graphic
  152.                   mode where:
  153.                                0 - ASCII
  154.                                3 - VT-52 color
  155.                                5 - ANSI color
  156.  
  157.      If this file is not found a menu will appear allowing the 
  158.      user to select their graphic mode.
  159.  
  160.           In addition, you may now add your own graphic colors
  161.      to DIP bulletins or text files.  Below are the color codes
  162.      recognized by DIP (note the <ESC> denotes the ASCII 27):
  163.  
  164.          <ESC>00         Black foreground
  165.          <ESC>01         Red foreground
  166.          <ESC>04         Blue foreground (sometimes green in VT-52)
  167.          <ESC>07         White foreground
  168.          <ESC>08         Black background
  169.          <ESC>09         Red background
  170.          <ESC>12         Blue background (sometimes green in VT-52)
  171.          <ESC>15         White background
  172.          <ESC>18         Erase screen
  173.  
  174.           Two 'undocumented' commands exist in the DIP menu now:
  175.  
  176.                '?' will redisplay the current menu.
  177.                '!' will display the graphic mode menu and allow the
  178.                    user to change their mode.
  179.  
  180.           Finally, the user's name and time in DIP will be displayed
  181.      on the console monitor.  This information is not sent through
  182.      the modem.
  183.  
  184.      NOTE:  DIP will NOT run on the normal Atari desktop.  Run it
  185.      within your BBS or an auxiliary desktop.  In addition, your
  186.      modem MUST be turned ON for DIP to operate properly.
  187.  
  188.      WARRANTY AND DISCLAIMER:
  189.  
  190.           No warranty is given or implied in any way.  Use of 
  191.      these programs is solely at the risk of the user.  The 
  192.      author shall not be responsible for any damages or loss
  193.      of time or materials due to the use of these programs.
  194.  
  195.      SHAREWARE NOTICE:
  196.  
  197.           These programs and their associated documentation may
  198.      be freely distributed as SHAREWARE so long as they are not
  199.      separated or modified in any way.  This means that you are
  200.      free to give copies of the program to friends, upload it to
  201.      bulletin boards, etc.  The programs may NOT be sold or in-
  202.      included with a commercial product without the express 
  203.      written consent of the author.  Also, this documentation 
  204.      may not be reprinted without the express written consent of
  205.      the author.   
  206.           Users are licensed to operate the Door Interface Program
  207.      (DIP) on their computers for the purpose of test and 
  208.      evaluation on a trial basis for a limited trial period.  It 
  209.      is not possible to reasonably define any definitive limits of
  210.      a fair and equitable time period for evaluation, therefore it
  211.      is left to the user's judgment and sense of fair play as to
  212.      the time required to make a decision as to its usefulness.  
  213.      If the user decides the program is not of sufficient merit 
  214.      to warrant purchase through registration, the program should
  215.      be removed from their computer.  Otherwise, if the program is
  216.      deemed useful and is in regular use on the user's computer
  217.      system, registration is required.  If you end up using the
  218.      program, you are expected to become a registered user by 
  219.      sending a shareware payment of $10.00 to $15.00 along with
  220.      the registration form to:
  221.  
  222.      Jeff Fehlman
  223.      P.O. Box 5332
  224.      Fair Oaks, CA 95628-9106
  225.  
  226.