home *** CD-ROM | disk | FTP | other *** search
/ Action Ware 12: Heretic & Hexen / actionware12.iso / acware12 / editors / heep701 / readme.doc < prev    next >
Text File  |  1995-05-11  |  19KB  |  477 lines
  1.                     DeeP and HeeP Documentation
  2.                     ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  3.  
  4.             ┌─────────────────────────────────────────┐
  5.             │    (c) 1995 Sensor Based Systems, Inc.  │
  6.             │        DoomEnhancedEditorProgram        │
  7.             │      HereticEnhancedEditorProgram       │
  8.             │  █████████                   █████████  │
  9.             │   ██     █                    ██     █  │
  10.             │   ██     █ jackv56036@AOL.com ██     █  │
  11.             │   ██     █                    ██     █  │
  12.             │   ██     █  ███████  ███████  ████████  │
  13.             │   ██     █  ██       ██       ██        │
  14.             │   ██     █  █████    █████    ██        │
  15.             │   ██     █  ██       ██       ██        │
  16.             │  █████████  ███████  ███████  ██ tm     │
  17.             │        75454.773@COMPUSERVE.COM         │
  18.             │                                         │
  19.             └─────────────────────────────────────────┘
  20.  
  21.  
  22.                    Sensor Based Systems, Inc.
  23.                       17010 NE 190th St
  24.                    Woodinville, WA 98072-8237
  25.  
  26.                       jackv56036@AOL.com
  27.                     75454.773@COMPUSERVE.COM
  28.                         (206) 827-8794
  29.  
  30.  
  31.       >>>    All references to DeeP also apply to HeeP    <<<
  32.  
  33.            DEU users, please review the Help information.
  34.            Although many things look the same, there's
  35.            lot's more you can do (over 101)!
  36.  
  37.            Don't forget that clicking the Right Mouse button
  38.            will edit an object. In addition, clicking the
  39.            Right Mouse Button in any menu selection exits
  40.            the menu (Esc also works). This is the quickest
  41.            way to navigate the menus!!
  42.  
  43.     ┌───────────────────────┐
  44.     │   Table of Contents   │
  45.     └───────────────────────┘
  46.  
  47.     For Ordering Information see  15.
  48.  
  49.     1.  Machine Requirements/VESA video
  50.     2.  Installation
  51.     3.  How to start DeeP/HeeP
  52.     4.  Command line options
  53.     5.  The DeeP.CFG and HeeP.CFG file and defaults
  54.     6.  The DeeP Main Menu
  55.     7.  The DeeP Map/Mission Editor
  56.     8.  The commands
  57.     9.  Tutorial
  58.    10.  DPMI DeeP and DeePbsp
  59.    11.  Registered DeePbsp
  60.    12.  DeeP and Windows  << Be sure to view this
  61.    13.  DeeP and QEMM     << Be sure to view this
  62.    14.  Future stuff
  63.    15.  Ordering information
  64.  
  65.    ──────────────────────────────────────────────────────────────────────
  66.    ──────────────────────────────────────────────────────────────────────
  67.  
  68.  
  69. 1. Machine Requirements / VESA video BIOS
  70.    ──────────────────────────────────────
  71.  
  72.    a. A 386 and above
  73.    b. A math co-processor is highly recommended. Speeds up DeePbsp about 4X.
  74.    c. A VGA monitor.
  75.    d. A VESA compatible video board with 512Kb. If you don't have a VESA
  76.       board or other problems, UNIVBE may work (see below).
  77.    e. 540kb free memory.
  78.    f. HIMEM.SYS loaded   in CONFIG.SYS.
  79.    g. FILES=20 or higher in CONFIG.SYS.
  80.    h. Approximately 1.4 MB of disk space.
  81.    i. Enough additional disk space to save DOOM levels you make.
  82.    j. A mouse (keyboard is a lot harder and some features are mouse only).
  83.    k. DOS 6.2 is optional, but again makes everything else easier.
  84.    l. If you can, Shadow the Video and System BIOS. DOOM just tells you not
  85.       to, for the reasons listed below (shadowing exaggerates the problems).
  86.  
  87.    m. Overview of system considerations:
  88.  
  89.    DeeP and DeePbsp stress the DRAM refresh setting more than many programs.
  90.  
  91.    If you have problems with the video, check the wait states on your DRAM.
  92.    If they are set too low, you will experience "lockups" or strange
  93.    symptoms. (Windows should also be GP faulting a lot and HERETIC behaves
  94.    erratically.)
  95.  
  96.    There is no "normal" system out there, but be careful if you have
  97.    a ZERO wait setting and your memory is 70ns or higher. Some 60ns chips
  98.    also do not work (on a 33Mhz system), depending on the DRAM and the board.
  99.  
  100.    We have not found "ram" check programs that bring out these flaws. Every-
  101.    thing looks fine and stuff may even appear to work for a while. But if
  102.    your system likes to act up at random, take a second look at the settings.
  103.  
  104.    Any system that has a "tweaked" speed (someone upped the clock speed) is
  105.    asking for trouble.
  106.  
  107.    Use Smartdrive, it helps speed up help and especially the display of 
  108.    textures and sprites!.
  109.  
  110.    DOOM works fine (in fact loads much faster) with Smartdrv (latest 
  111.    Smartdrv anyway), but your system has to have more than 4MB.  Smartdrive does 
  112.    take memory away from the DeeP, so if you run out of memory, please reduce 
  113.    the size of the Smartdrive cache (how big did you make it?).
  114.  
  115.    If your system acts up with Smartdrive, then of course do not use it.
  116.  
  117.    DOS 6.2 is recommended. Use HIMEM.SYS and load DOS high 
  118.    (OK to do with DOOM.)
  119.  
  120.    The default assumes a VESA compatible video board with 512Kb of memory
  121.    (more video memory is OK).
  122.  
  123.    Some older boards are not VESA compatible, but they are SVGA with
  124.    512kb or more. In other cases, the VESA BIOS does not work correctly
  125.    (ATI is one). VESA software drivers that you can load anytime may solve
  126.    your problems.
  127.  
  128.    UNIVBE is such a driver and will probably work and be fast to boot.
  129.    This driver is available from SBS and from many FTP sites.
  130.  
  131.    This product is NOT made by SBS, but SciTech Software. Unzip the file
  132.    UVBE51BD.ZIP in the same directory as DeeP (or another if you like).
  133.  
  134.    Follow the instructions given, but they are fairly simple. 
  135.    Enter > UNIVBE /? to get a list of the options.
  136.  
  137.    For most, entering " > UNIVBE -l " works. This loads the driver high
  138.    and autodetects your board.
  139.  
  140.    Even for VESA boards, this program may speed up your video for all your
  141.    applications (DOOM works ok with it.)
  142.  
  143.    If you can play DOOM reliably, you will probably be able to run DeeP.
  144.  
  145. 2. Installation
  146.    ──────────────────────────────────────
  147.  
  148.    DeeP.ZIP is the shareware zipped distribution files for DeeP and HeeP.
  149.  
  150.    DeePreg.ZIP and HeePreg.ZIP are the zipped registered distribution files
  151.    for DeeP and HeeP.
  152.  
  153.    In the examples below, the same directory is shown for DeeP and Heep.
  154.    If you run both programs, it is more efficient to put them both in the
  155.    same directory, so that the DPMI programs (discussed at end) are easily
  156.    available. Also, since the same help file is used for both, it makes it
  157.    easier to maintain. If you split them, support programs are either
  158.    required in the ROOT directory or available via the DOS PATH. These are
  159.    DeeProot.exe, HeeProot.exe and the DPMI programs discussed below in DeePbsp.
  160.  
  161.    If you get a new version of one program and not the other, be careful that
  162.    you don't read newer instructions that don't apply to the older program!).
  163.    In that case, you may wish to rename the help files and use altF5 to set
  164.    the files as required and/or put them in their own directory.
  165.  
  166.  
  167.    Use PKUNZIP (2.04 or later) to unzip DeeP.ZIP into any directory on your
  168.    hard drive. PKUNZIP is available from many sources, probably including
  169.    the one you obtained DeeP from.  (Now this was probably in a zipped file
  170.    so you already know how to do this, right?)
  171.  
  172.    Replace the DOOM2 directory with HERETIC if you have HERETIC and not
  173.    DOOM. The name is for illustration, this is just one way to do it!
  174.  
  175.    Example for DOOM II (c:> prompt assumed): ------------------------
  176.  
  177.       cd\DOOM2                             [go to DOOM II directory    ]
  178.  
  179.       mkdir DeeP                           [create a directory for DeeP]
  180.       cd Deep                              [go to directory            ]
  181.  
  182.  
  183.       -- for the shareware version--
  184.  
  185.          pkunzip a:DeeP.ZIP \doom\deep     [unzip from your a: drive.]
  186.  
  187.       -- for the registered version--
  188.  
  189.          pkunzip a:DeePreg.ZIP \doom\deep  [unzip from your a: drive.]
  190.  
  191.  
  192.  
  193. 3. How to start DeeP
  194.    ──────────────────────────────────────
  195.  
  196.    DeeP is started by typing:  DeeP  <command line options>
  197.    HeeP is started by typing:  HeeP  <command line options>
  198.  
  199.    The file ~DEEP.WAD is created when you rebuild Nodes from DeeP.
  200.    The file ~HEEP.WAD is created when you rebuild Nodes from HeeP.
  201.  
  202.   ~DEEP.WAD and ~HEEP.WAD contain a copy of your last saved level. You can 
  203.    use this to restore (use COPY) in case something goes wrong with the node 
  204.    building. 
  205.  
  206.    You will get the message level "YOUR.WAD" (whatever you called it) not 
  207.    found.
  208.  
  209.    This can happen if you have a memory conflict, you are running in WINDOWS 
  210.    and didn't modify SYSTEM.INI, you just ran out of memory(?) or
  211.    something else.
  212.  
  213.    When running from DeeP, the message will flash and you won't be able to 
  214.    tell what happened. But you never see the DeePbsp screen come up. That's 
  215.    your first clue that something is amiss.
  216.  
  217.    Then you might want to use the temporary file (or use the one named .BAK,
  218.    although the .BAK is prior to your changes).
  219.  
  220.    Use the DOS COPY command to copy the file back to the original name.
  221.  
  222.           >>> !!  CAUTION !! <<
  223.  
  224.    DO NOT USE the ~DEEP.WAD or ~HEEP.WAD as direct input. Copy it and give it
  225.    a different name if you want to use it again. Failure to do this will 
  226.    result in the loss of all data in the level!
  227.  
  228.  
  229. 4. Command line options
  230.    ──────────────────────────────────────
  231.  
  232.    The command line options are explained in DeeP by entering the H (help)
  233.    usage command.  Enter ? to see all the Help.
  234.  
  235.  
  236. 5. The DeeP.CFG and HeeP.CFG File
  237.    ──────────────────────────────────────
  238.  
  239.    The file called DeeP.CFG contains all the options you set in DeeP.
  240.    The file called HEEP.CFG contains all the options you set in HeeP.
  241.  
  242.    If you mess up the setting, delete this file to restore it to the defaults.
  243.    It is possible for this file to get corrupted due to "normal" DOS FAT table
  244.    allocation errors. We suggest you delete the file and start over when any
  245.    FAT error for this file is reported. Inexplicable behavior can sometimes be
  246.    traced to a corrupted .CFG file.
  247.  
  248.    The DeeP.CFG and HeeP.CFG files contain the status of your options and
  249.    the last files edited, etc.
  250.  
  251.    The largest complete path name for any file is 42 characters!
  252.    This includes the drive specification "C:\".
  253.  
  254.    The largest default path (either explicit or implied by the directory you
  255.    are in) is 27 characters.
  256.  
  257.    For example: C:\DOOM2\DeeP is 13 characters long.
  258.  
  259.    The default path is always added to any file you read or write,
  260.    so don't forget to count it.
  261.  
  262.  
  263. 6. The DeeP Main Menu
  264.    ──────────────────────────────────────
  265.  
  266.    DeeP has online documentation to help you run it. Type "?" and press enter.
  267.    This brings up a help screen that explains what each option does in full
  268.    detail. The complete documentation is listed here as well as in Edit,
  269.    under "All Help".
  270.  
  271.    In Map edit mode, F1 brings up more help and even more help for the
  272.    menu items on the top bar!
  273.  
  274.    You can print the documentation by selecting the Print button.
  275.  
  276.  
  277. 7. DeeP Map Level Editor
  278.    ──────────────────────────────────────
  279.  
  280.    Type E to start the map editor. The map editor is an editor of the level.
  281.    Select the level from the menu shown. This brings up a map of the
  282.    level you have chosen to edit, for example, MAP10 (DOOM II) or E2M3 for
  283.    DOOM and HERETIC.
  284.  
  285.    Once in the editor set all the options in the Edit pull-down menu
  286.    to automatically restart, set colors and other working defaults.
  287.  
  288.    The editor has Four Editing Modes. In each edit mode you can Add, Delete
  289.    or Change the type of object selected.
  290.  
  291.    The four editing modes are:
  292.  
  293.    a.  Sector Mode
  294.    b.  Vertices Mode
  295.    c.  Thing Edit Modes
  296.    d.  Linedef and Sidedef Modes
  297.  
  298.    The online help has explanations for each of these functions.
  299.    Registered DeeP will contain the latest explanations of these functions
  300.    and more tutoring.
  301.  
  302.  
  303. 8. The Commands
  304.    ──────────────────────────────────────
  305.  
  306.    Use the built-in F1 help to examine the commands. Start with ? at the
  307.    DOS character mode commands and select the top sections by activating them
  308.    and then pressing F1. For example, press Alt+S and then press F1 to see
  309.    the help for Save.
  310.  
  311.  
  312. 9.  Tutorial
  313.    ──────────────────────────────────────
  314.  
  315.    Print the file TUTOR.DOC for beginning help on using DeeP to create and
  316.    edit levels. It is also useful for persons new to DeeP, since it also
  317.    show how to use the commands.
  318.  
  319.    The file textures are incorrect for HeeP, but can be quickly changed using
  320.    the F10 fix missing textures feature.
  321.  
  322.  
  323. 10. DPMI DeeP and DeePbsp
  324.    ──────────────────────────────────────
  325.  
  326.    The DPMI versions of DeeP and DeePbsp require that you have HIMEM.SYS 
  327.    installed in your CONFIG.SYS file. If you don't, it WON'T WORK. There are 
  328.    further notes below. We wish it was simpler, but this is out of our control, 
  329.    since we have to use the tools available at reasonable cost to us (Borland).
  330.  
  331.    Your CONFIG.SYS file also requires a FILES=20 ( or more ) statement.
  332.  
  333.    We do NOT have control when the program starts, so we can't tell you
  334.    what to do in the opening screen!
  335.  
  336.    DeePbsp is an improved node builder that was made using information from
  337.    BSP 1.2 and DEU 5.21.
  338.  
  339.    DeePbsp is about 2-10 times faster than BSP, can distinquish smaller
  340.    vertex spacing and features a display to see how your level is progressing
  341.    as it is being built.
  342.  
  343.    In addition, DeepBsp can build nodes from within a grouped PWAD, so
  344.    DO NOT substitute another node builder, since it won't work right when
  345.    run by DeeP!!
  346.  
  347.    DeePbsp is automatically run by selecting "Yes" when asked whether you want
  348.    the nodes built or not.
  349.  
  350.    DeePbsp COPIES the reject map "as is", so be sure to clear the reject area
  351.    with DeeP when requested.
  352.  
  353.    Experiment with the DeeP clear REJECT options (see File, Save with Build)
  354.    to see if you need to work with the REJECT to speed up your level.
  355.  
  356.    (DeePbsp formerly was called TBSP. TBSP does clear the reject map.)
  357.  
  358.    There is a check in DeePbsp for viruses or allocation errors. The message
  359.    !!! Warning DEEPBSP size wrong? !!! appears if it detects an error. An
  360.    extra startup delay is added (so you can see the message). The program
  361.    continues to execute.
  362.  
  363.    A change in the program size indicates a serious error in the FAT
  364.    file allocation or a virus! So try to find out why it's complaining.
  365.  
  366.    If you get an ATAN2 error, you forgot to run the total check on the level
  367.    and you have overlapping vertices or other errors in your level.
  368.  
  369.    YOU SHOULD TEST BUILDING NODES ON YOUR SYSTEM FIRST TO BE SURE IT WORKS!
  370.  
  371.    You can run DeePbsp by hand by entering C:\..DeePbsp INWAD.WAD OUTWAD.WAD
  372.  
  373.    Fill in the C:\.. path with yours and use your name for the wad files to
  374.    test with.  It's best to test with an original id level so that we have
  375.    a level that we know is ok!
  376.  
  377.    Observe any errors (if there's a problem it will happen right away) and
  378.    read below for how to fix it.
  379.  
  380.  
  381. 11. Registered DeePbsp
  382.     ──────────────────
  383.  
  384.     The registered version of DeePbsp does not have any delay with the
  385.     following considerations:
  386.  
  387.     a. DeePbsp must not be renamed to some other name.
  388.     b. The registered version of DeeP or Heep must be in the same directory
  389.        as DeePbsp.
  390.  
  391.     If a delay occurs, the registered version of DeeP or HeeP is damaged or
  392.     you renamed DeePbsp. Please reinstall.
  393.  
  394.  
  395. 12. DeeP and Windows   <<<<<<<  be sure to read this >>>>>>>>
  396.     ────────────────
  397.  
  398.    DeeP requires the programs 32RTM.EXE, DPMIVM.OVL, BGI32.DLL and 
  399.    METWND08.DLL in the directory where DeeP was installed as well as the
  400.    .FNT files included.
  401.  
  402.             ------->   WINDOWS Modifications <-------
  403.  
  404.    If you run DeeP from within windows, SYSTEM.INI must have the following
  405.    line added (use DOS EDIT ) after the line [386Enh]        (Change the
  406.    c:\DOOM2\DeeP to reflect the location where you installed the program).
  407.  
  408.            device = c:\DOOM2\DEEP\WINDPMI.386
  409.  
  410.  
  411. 13. DeeP and QEMM      <<<<<<<  be sure to read this >>>>>>>>
  412.     ────────────────────────────────────
  413.  
  414.     If you use QEMM, the QDPMI.SYS driver and the Borland RTM.EXE used by
  415.     DeeP do not work together. You will get an Exception = 000cH..etc.,
  416.     from QDPMI. We don't know at this time who should change their code. If
  417.     anyone knows more about this, please let us know. Meanwhile, we'll try
  418.     to find out too.
  419.  
  420.     DEVICE=QDPMI.SYS
  421.  
  422.     The program QDPMI.SYS appears to be installed if you used the default
  423.     config when you installed QEMM.
  424.  
  425.     Remove the DEVICE=QDPMI.SYS from the CONFIG.SYS file or make an alternate
  426.     boot setup that doesn't use this file.
  427.  
  428.     You may not need QDPMI.SYS at all! Refer to QHINTS.DOC for information.
  429.  
  430. 14. Future stuff
  431.    ──────────────────────────────────────
  432.  
  433.    Now that DeeP and HeeP are DPMI we are much closer to the next step:
  434.  
  435.    1. Ability to merge in stuff from other WADs (cut and paste).
  436.    2. More complete Dir viewing box in the editor (registered).
  437.    3. Add more prebuilt functions, rising stairs and rotating stairs are
  438.       on the list for now.
  439.    4. And more...
  440.  
  441. 15. Ordering Information
  442.     ────────────────────
  443.  
  444.    >>>      To order the Registered version     <<<   
  445.                  of DPMI DeeP or HeeP                  
  446.                                                
  447.    1. Register Online with CompuServe GO SWREG :         
  448.                                                
  449.       The Registration ID for DeeP is 5392.
  450.       The Registration ID for HeeP is 4553.
  451.  
  452.       The current ShareWare version is found in 
  453.       the ACTION forum (GO GAM586).
  454.                                                
  455.    2. See ORDER.FRM for Mailing Instructions.  
  456.  
  457.       Select Print Order Form under Help in Edit to 
  458.       let DeeP or HeeP print the form.
  459.                                                
  460.    3. Register online with Master card or Visa   
  461.                                                
  462.       Fighting Eagle BBS (317) 662-8122         
  463.                                                
  464.       Home board of DEEP and HEEP               
  465.       14 lines, over 10,000 Wad Files           
  466.       Game play and support Conference          
  467.                                                
  468.       Call Today and start your new adventure as   
  469.             a DOOM or HERETIC wad author.               
  470.  
  471.    ──────────────────────────────────────────────────────────────────────
  472.                           The End
  473.    ──────────────────────────────────────────────────────────────────────
  474.                                                
  475.  
  476.  
  477.