home *** CD-ROM | disk | FTP | other *** search
/ Doom 2 Explosion / Doom2Explosion.bin / doom2exp / programs / deu51 / readme.1st < prev    next >
Text File  |  1994-04-28  |  18KB  |  542 lines
  1.                =======================
  2.                          DEU
  3.  
  4.                 DOOM EDITOR UTILITIES
  5.  
  6.                      Version 5.1
  7.                =======================
  8.  
  9. CONTENTS
  10. ========
  11.  
  12. What is DEU?
  13.  
  14. Distribution
  15.  
  16. Legalese
  17.    Copyright
  18.    Disclaimers
  19.    Copyleft
  20.  
  21. Running DEU.
  22.    Requirements
  23.    Installation
  24.    Quickstart
  25.  
  26. Revision History
  27.  
  28. Future Plans
  29.  
  30. Contacting the Authors
  31.    Contributions to the DEU effort
  32.    Updates to the Program
  33.    Updates to the Manual
  34.  
  35. Credits
  36.  
  37.  
  38.  
  39.  
  40. WHAT IS DEU?
  41. ============
  42.  
  43. DEU is a WAD file editor.  Use it to edit one level, then save it in a 
  44. patch WAD file (PWAD), or in the main WAD file.
  45.  
  46. You may use it with both the registered and the shareware versions of 
  47. DOOM, but you won't be allowed to save your changes if you are using the 
  48. shareware version (this is ID's will, since it might otherwise discourage 
  49. people from registering).
  50.  
  51. You can do almost anything to any level: move, add or remove monsters and 
  52. powerups, change the wall colours and positions, create new lifts, doors, 
  53. acid pools, crushing ceilings... or even create a new level from scratch!
  54. If other Doom editors won't let you do it, then DEU it!
  55.  
  56.  
  57.  
  58. DISTRIBUTION
  59. ============
  60.  
  61. The latest version of DEU is available at the following FTP sites:
  62.  
  63. For European users:
  64.        bear.montefiore.ulg.ac.be (139.165.8.25)
  65.        /pub/doom/deu/deu??.zip
  66.  
  67. For other countries:
  68.        ocf.unt.edu (129.120.9.151)
  69.        /pub/doom/deu/deu??.zip
  70.  
  71. You will probably also find it on other FTP sites, such as ftp.uwp.edu,
  72. wuarchive.wustl.edu, doom.hope.edu...
  73.  
  74.  
  75.  
  76.  
  77.  
  78.  
  79. LEGALESE...
  80. ===========
  81.  
  82. Copyright
  83. ~~~~~~~~~
  84. DOOM is a trademark of id Software.
  85.  
  86. DEU has been created by Brendon Wyber and Raphaël Quinet
  87. DEU is NOT an id Software product.
  88.  
  89. Disclaimers
  90. ~~~~~~~~~~~
  91. id Software cannot and will not provide support for DEU.
  92.  
  93. id Software will not provide support for ANY file that has been modified 
  94. or created by DEU.
  95.  
  96. DEU will not allow you to modify the shareware version of DOOM.  It is 
  97. illegal to alter DEU to operate on the shareware version of DOOM.
  98.  
  99. The authors of DEU will not provide support or be liable for damage caused 
  100. by the use of DEU.
  101.  
  102. It is illegal to distribute the registered version of the DOOM.WAD file in 
  103. any form, original or modified.
  104.  
  105. The authors of DEU reserve the right to add or remove any functionality of 
  106. the DEU software.
  107.  
  108. Copyleft...
  109. ~~~~~~~~~~~
  110.  
  111. DEU is a public domain program.  This means you can do anything you want 
  112. with it.  However, it would be considered polite if you did the following 
  113. things:
  114.  
  115.      * If you alter this executable, call it something else.
  116.        We would like to be the only people to release DEU named programs.
  117.  
  118.      * ... and... Give us credit. E.g.
  119.        Bob's Amazing Doom Editor, Version 1.00.
  120.        Copyright 1994 Bob Bobbingbob. All rights reserved.
  121.        [Derived from DEU v5.00 by Brendon Wyber and Raphaël Quinet.]
  122.        This credit notice should appear when you start the program, or in
  123.        an "about" box (if your program has a graphical interface).
  124.  
  125.      * Refrain from distributing pwads that work with the shareware
  126.        version of the game.  You only need to use one object or texture
  127.        from the registered version and this will do the trick.
  128.  
  129.      * Do NOT use the source to make an editor for the shareware
  130.        version.  ID doesn't want shareware editors around.
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137. RUNNING DEU
  138. ===========
  139.  
  140. Requirements:
  141. ~~~~~~~~~~~~~
  142. You need a PC with a VGA screen and enough memory to load the levels data.  
  143. If you can play DOOM, you will probably be able to run DEU.  A mouse is 
  144. not required,  but editing will be easier if you have some plastic rodent.
  145.  
  146. Installation:
  147. ~~~~~~~~~~~~~
  148. Unzip it into any directory on your hard drive using commands like:
  149.  
  150.        mkdir \games\doom\deu                [create a directory for it.]
  151.  
  152.        pkunzip a:deu51.zip \games\doom\deu  [unzip from your a: drive.]
  153.  
  154. Quickstart:
  155. ~~~~~~~~~~~
  156. (for a more complete list of available commands, see DEU.TXT)
  157.  
  158.  
  159. To run DEU just type:
  160.  
  161.     DEU
  162.  
  163.  
  164. You should then be presented with the prompt.  Use the following basic 
  165. commands:
  166.  
  167.     ?   This displays a list of commands and their valid syntax.
  168.  
  169.     EDIT [<episode> <level> ]
  170.        This  command calls up the editor for the given map.  The edited
  171.        level is then saved into a PWAD file of the given name.  If you
  172.        don't enter any parameters you will be presented with a menu to
  173.        choose from.
  174.  
  175.     QUIT
  176.        This quits the program.
  177.  
  178. For starters, type:
  179.  
  180.     E 1 1      [Edit episode 1, mission 1 ]
  181.  
  182. When the editor starts up, it should display the map.  The editor will now 
  183. let you insert, delete and edit objects in the map.  In the centre of the 
  184. map is a crosshair (or your mouse pointer) which marks your current 
  185. position.  Little x's represent the Things.  Different colours represent 
  186. different types of Things.
  187.  
  188. Then press F1 for help, or just play around.
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195. REVISION HISTORY
  196. ================
  197.  
  198. By Raphaël Quinet:
  199.  
  200. 5.10   26 Apr 94
  201.        Better Nodes builder (but there is still a bug somewhere...).
  202.        Better memory management.  You can now edit huge levels (E2M7).
  203.        Changes in the menus, new menu under the 'F8' key.
  204.        New 'Preferences' menu ('F5').
  205.        Better automatic error checkers.  Show the object in error.
  206.        Keep the selection when you switch from one editor to another.
  207.        Missing textures displayed in red in the info box.
  208.        Better texture viewer (faster, and displays the texture size).
  209.        The debug mode now creates a log file (DEU.LOG).
  210.        New commands to Scale or Rotate any object or group of objects.
  211.        Automatic jump to object for 'N', 'P' and 'J'.
  212.        New features "make door from Sector", "make lift", ...
  213.        New keys:
  214.            O: copy any object or group of object
  215.            R: display a 'ruler' cursor (check wall length, etc.).
  216.            Shift-G: increase the grid size ('G' decreases it).
  217.            Shift-Ins: may be used instead of 'Ins' to close the polygon.
  218.        New commands (main menu):
  219.            I[nclude] to include any raw binary file in a PWAD.
  220.            X[tract] to extract any object to a raw binary file.
  221.        New command line options:
  222.            -i (-infobar) displays the info bar when you start the editor.
  223.            -a (-addselbox) use an additive selection box.
  224.            -qq (-quieter) when you are in a library...
  225.  
  226. 5.00   30 Mar 94
  227.        Automatic Nodes builder!.
  228.        Drop-down menus with menu bar.
  229.        Selection box to select a group of objects.
  230.        Smart add/delete for Vertices to split/join LineDef(s).
  231.        New "insert common shapes" and "misc. ops." menus.
  232.        VESA and SuperVGA support.
  233.        Removed the Nodes and Segs editors (obsolete).
  234.        The Things editor shows the size of the objects.
  235.        Sprite and texture viewers (256 colors).
  236.        New arguments "-help", "-bgi", "-fakecursor", "-color2",...
  237.        Added a config file for DEU.
  238.        New keys: 
  239.            F2 Save
  240.            Scroll Lock to turn of auto scrolling.
  241.            F9 Insert complex objects.
  242.            F10 Error checker and miscellaneous operations.
  243.        New commands (main menu):
  244.            G[roup] to create a compound wad file with all open pwads.
  245.            V[iew] to view a sprite.
  246.            S[ave] to save one object in a separate wad file.
  247.        MANUAL.DOC renamed to DEU.TXT, DEU.TXT renamed to README.1ST
  248.        DEUTUTOR.ZIP contains a step-by-step tutorial for DEU.
  249.  
  250.  
  251.  
  252. 4.31   8 Mar 94
  253.        New mouse interface.
  254.        Object detection algorithm improved slightly.
  255.        Mark/unmark any object and edit/move all marked objects at once.
  256.        New command line parameters.
  257.        May now add or delete ANY type of object.
  258.        Most LineDef types are now recognized.
  259.        Different colors are used for special LineDefs or Sectors.
  260.        New "snap to grid" and "zoom on pointer" features.
  261.        New keyboard shortcuts: "T", "V", "L" & "S".
  262.        Many bug fixes.  BlockMap builder bug has been fixed.
  263.        The "-debug" bug (!) has been fixed.
  264.        A manual file, "MANUAL.DOC".  Read this to find how to use DEU.
  265.  
  266. 4.20   25 Feb 94
  267.        Improved selection method for Sectors and LineDefs.
  268.        New dialog box asks for a WAD file name after editing a level.
  269.        New Thing, LineDef and Sector types are recognized.
  270.        Using the "large" memory model, as the code is becoming... large.
  271.        "Read" command.
  272.        "EDIT" command parameters now optional.
  273.  
  274. 4.10   17 Feb 94
  275.        Can change wall, floor and ceiling textures.
  276.        Total control over the LineDef and Sector attributes.
  277.        Lots of improvements in the editors.
  278.        The keyboard arrows may be used to move the mouse pointer.
  279.        'Ins' duplicates the last Thing selected.
  280.        'Tab' key now documented in the help screen.
  281.        'DUMP' command now documented in the main DEU menu.
  282.        'N','P' (or '<','>') keys to jump to the Next/Previous object.
  283.  
  284. 4.00   16 Feb 94
  285.        Mouse support. Pointer may now move around the screen.
  286.        Map scrolls if the pointer reaches the edge of the screen.
  287.        User interface totally revamped.
  288.        Can use the mouse buttons to manipulate objects.
  289.        More Things recognized (DeathMatch starts, lamps, candles...).
  290.        New editing modes: Vertexes, LineDefs, SideDefs, Sectors...
  291.        Some keyboard commands changed.
  292.        Saving disabled for the shareware version.
  293.  
  294. By Brendon Wyber:
  295.  
  296. 3.01   29 Jan 94
  297.        Bug fix, can now edit levels higher than 3.
  298.  
  299. 3.00   29 Jan 94
  300.        Second Release.  Merged DDIR and DEDT into one program.
  301.        Replaced THING DATA files with PWAD files.
  302.        Released with source code.
  303.  
  304. 2.00   26 Jan 94
  305.        First release.  Had two programs DDIR and DEDT and used
  306.        text THING DATA files.
  307.  
  308. 1.00   Never
  309. Really sucked!
  310.  
  311.  
  312.  
  313.  
  314.  
  315. FUTURE PLANS
  316. ============
  317.  
  318. ********
  319. Beavis and Butthead viewing a Boy George video...
  320.  
  321. Butthead:       ...This must be what people look like in the future...
  322. Beavis:         "The future sucks!  Change it!"
  323. Butthead:       "I may be cool Beavis, but I can't change the future."
  324. ********
  325.  
  326. * Use gcc and a dos extender instead of Turbo C.  DEU will be much faster
  327.   and will be able to use all available memory (normal or extended).
  328.  
  329. * Port to Linux and X Window.
  330.  
  331. * 3D previewer with hidden line removal.
  332.  
  333. * Add scrollbars to some dialog boxes.
  334.  
  335. * Bitmap editor and GIF support.
  336.  
  337. * New graphical interface instead of the text-only main menu.
  338.  
  339. * Get rid of a few nasty little bugs.
  340.  
  341.  
  342.  
  343.  
  344. CONTACTING THE AUTHORS
  345. ======================
  346.  
  347. * Raphaël (DEU code)
  348.   E-mail: quinet@montefiore.ulg.ac.be
  349.   Snail mail: Raphaël Quinet
  350.               9 rue des Martyrs
  351.               B-4550 Nandrin
  352.               Belgium
  353.  
  354. * Brendon (DEU code)
  355.   E-mail: b.wyber@csc.canterbury.ac.nz
  356.   Snail mail: Brendon Wyber
  357.               63 Shirley Road
  358.               Christchurch 1
  359.               New Zealand
  360.  
  361. * Steve (DEU documentation)
  362.   E-mail: bareman@hope.cit.hope.edu
  363.   Snail mail: Steve Bareman
  364.               869 136th Ave
  365.               Holland Michigan 49424
  366.               USA
  367.  
  368.  
  369. Note: Please do not send a message asking when the next version will be
  370.       released.  The only thing you will do is slow down the DEU 
  371.       development.  And please read the following paragraphs before
  372.       sending anyhting by E-mail...  Thanks.
  373.  
  374.  
  375.  
  376.  
  377. Contributions to the DEU effort...
  378. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  379. If you would like to make a contribution to the DEU effort, please use the 
  380. following guidelines.
  381.  
  382. The authors reserve the right to accept or reject any submissions (even if 
  383. all submissions have been accepted so far...).  All submissions must be to 
  384. the Public Domain and any ownership is forfeited.  Credit for useful 
  385. information will be given in the "Credits..." section of this file.
  386.  
  387. Updates to the Program
  388. ~~~~~~~~~~~~~~~~~~~~~~
  389. Contact Brendon and Raphaël before submitting code.
  390.  
  391. If you write an extension to DEU, try keeping all of it in a separate 
  392. file.  This will facilitate the integration in the version under 
  393. development.
  394.  
  395. If you send a bug fix or a small patch to the code, the favourite format 
  396. is a Un*x "diff -c" file (context diff).
  397.  
  398. Updates to the Manual
  399. ~~~~~~~~~~~~~~~~~~~~~~
  400. Send Updates for manual to Steve Bareman, Brendon and Raphaël.
  401.  
  402. Please send ONLY the sections you wish to update, complete with Section 
  403. numbers.  Each section should be sent as a separate section.  If you 
  404. contribute a *NEW* section please preceed it with the text "*** NEW 
  405. SECTION # ***".
  406.  
  407. The subject header of your message should include "DEU DOC's".
  408.  
  409. Bug Reports
  410. ~~~~~~~~~~~
  411. Send bug reports to Brendon and Raphaël.
  412.  
  413. Read the docs thoroughly before reporting any bugs.  Some of them are 
  414. features, not bugs...
  415.  
  416. Please include the version number of DEU you are running and be as 
  417. specific as possible in your description.  I you want us to fix your
  418. problem, you'd better help us reproduce it easily.
  419.  
  420. The subject header of your message should include "DEU BUG REPORT".
  421.  
  422. Suggestions for Enhancements to DEU program
  423. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  424. Send your suggestions to Brendon and Raphaël.
  425.  
  426. Thanks for your support!
  427.  
  428.  
  429.  
  430.  
  431.  
  432.  
  433. CREDITS
  434. =======
  435.  
  436. Many thanks go to the following people.  We won't speak in superlatives,
  437. because we would then need a few more pages to write this...  Let's just 
  438. say that these people did great things for DOOM or DEU:
  439.  
  440. * Everybody at id software for making such great games!
  441.  
  442. * Brendon Wyber                   (b.wyber@csc.canterbury.ac.nz)
  443.      The first version of this program was written by Brendon Wyber.
  444.      Map display, Things editor.
  445.  
  446. * Raphaël Quinet                  (quinet@montefiore.ulg.ac.be)
  447.      Much of this program was written by Raphaël Quinet.
  448.      New interface (mouse, menus, etc).
  449.      Ability to edit Vertices, Linedefs, Sidedefs, Sectors, and last
  450.      but certainly not least an AUTOMATIC NODES BUILDER.
  451.      Even if I rewrote nearly 90% of the code, this editor still has its
  452.      strong DEU roots... :-)
  453.      I appreciate comments and suggestions about this program.
  454.  
  455. * Matt Fell                       (matt.burnett@acebbs.com)
  456.      Author of the great Unofficial Doom Specs.  Making this program
  457.      would have been impossible if the Specs didn't exist.
  458.      You should take this file as a technical reference and companion
  459.      manual for DEU.  Get the file "dmspec13.txt" by anonymous FTP on
  460.      "wuarchive.wustl.edu" (/incoming/MSDOS_UPLOADS/games/doomstuff).
  461.  
  462. * Steve Bareman                   (bareman@hope.cit.hope.edu)
  463.      Rewrote the documentation (this file and DEU.TXT)
  464.      Author of the DEU tutorial (look in DEUTUTOR.ZIP).
  465.      Constant promoter of including source code with the editor.
  466.      For a good FTP...
  467.          anonymous @ doom.hope.edu (198.110.98.2)
  468.         (Registered DOOM patches, DEU, and various doom utils for
  469.          Registered DOOMers only.)
  470.  
  471. * Trevor Phillips                 (rphillip@cc.curtin.edu.au)
  472.      Textures viewer in 256 colors
  473.      Many, many suggestions and improvements to the DEU code.
  474.  
  475. * Alistair Brown                  (A.D.Brown@bradford.ac.uk)
  476. * Chris Phillips                  (chrisp@halcyon.com)
  477. * Colin Reed and Dylan Cuthbert   (dyl@cix.compulink.co.uk)
  478.      Lots of infos about the Nodes objects.
  479.      They fixed the bug(s) in my Nodes builder.
  480.  
  481. * Dewi Morgan                     (D.Morgan@bradford.ac.uk)
  482.      Drop-down menus and menu bar.
  483.      Rewrote and reorganized part of this file.
  484.      Numerous improvements and suggestions.
  485.      Now working on a GIF support for DEU.
  486.  
  487. * Will Ellett                     (wellet@cs.uah.edu)
  488.      Configuration file (DEU.INI) and better command line parsing.
  489.      Lots of suggestions for DEU.
  490.  
  491. * Barry Bloom                     (barry@noc.unt.edu)
  492.      Maintainer of the official DEU distribution site for the USA:
  493.           the DOOM-only FTP server: ocf.unt.edu (129.120.9.151)
  494.           (DOOM add-ons and utils, collection of WAD files, ...)
  495.      Also sent some useful suggestions and bug reports.
  496.  
  497.  
  498.  
  499. * Sven Neuhaus                    (sven@lilly.ping.de)
  500. * Billy Chow                      (billy.chow@engineering.oxford.ac.uk)
  501.      The most efficient beta-testers!  They keep on finding bugs that
  502.      most other people never see...
  503.  
  504. * Jeremy Blackman                 (wraven@helser51.res.iastate.edu)
  505. * Brian Downing                   (bdowning@ncsa.uiuc.edu)
  506. * Ted Vessenes                    (tedv@geom.umn.edu)
  507. * Ed Boling                       (edb9140@tamsun.tamu.edu)
  508. * Greg Grimsby                    (stu_gwgrimsb@vax1.acs.jmu.edu)
  509. * Michael Emmons                  (ie78hc0z@solix.fiu.edu)
  510. * Ryan Budney                     (rybu@jazz.math.ualberta.ca)
  511. * Tom Neff                        (tneff@panix.com)
  512. * Cameron Newham                  (cam@iinet.com.au)
  513.      Numerous comments, suggestions for improvements, and bug reports.
  514.      They were amongst the first to have faith in DEU and support it.
  515.  
  516. * Dietrich Hempelmann             (avatar@uni-paderborn.de)
  517.      Designed the "DEU 5" logo in DEU.TXT.  Great ascii-art... 
  518.  
  519. * Jean-Serge Gagnon               (js@gaaj.cosmos.uottawa.ca)
  520.      Helped Steve with the docs and improved the DEU tutorial.
  521.      If you want to see a good WAD file, get FOREST.WAD...
  522.  
  523. * Sean Malloy                     (malloy@crash.cts.com)
  524.      Updated the docs for the stairs, sent some interesting suggestions
  525.      and bug reports.
  526.  
  527. * Chirstian Johannes Sladetsch    (s924706@yallara.cs.rmit.oz.au)
  528.      Better texture display, working on XMS support (memory swapping).
  529.  
  530. * Craig Smith                     (bcs@cs.tamu.edu)
  531.      Ideas for improvements in the memory allocation routines.
  532.  
  533. * Tim Dedischew                   (kfdedisc@vela.acs.oakland.edu)
  534.      Working on a realistic 3D previewer for DEU.
  535.  
  536. We certainly forgot one or two heroes of the DEU quest...  Apologies if 
  537. your name is not here and you deserve it.  Just drop us a note and we will
  538. change that for the next release.
  539.  
  540. Have a nice DOOM!
  541.  
  542.