home *** CD-ROM | disk | FTP | other *** search
/ Deathday Collection / dday.bin / utils / verda020 / verda.doc < prev    next >
Text File  |  1994-02-28  |  16KB  |  338 lines

  1.               Viewer/Editor for Registered Doom Addicts
  2.                       VERDA v0.20 -- 28 Feb 94
  3.  
  4. VERDA is an add-on utility to work with DOOM by id software.  It can
  5. be used to view various pieces of map information on WAD files, both
  6. shareware and registered versions, as well as PWAD files.  You can
  7. choose to use VERDA to modify your primary WAD file, or you can edit
  8. PWAD files instead.  However, in keeping with the wishes of id
  9. software, it will not modify a shareware WAD file, and in order to
  10. edit a PWAD file you must have access to a registered WAD file.
  11.  
  12. System Requirements
  13. ^^^^^^^^^^^^^^^^^^^
  14. VERDA requires a VGA screen, a mouse(for graphic related things), and
  15. enough memory to read in map info.  It has been compiled to run on a
  16. 80286 with no math co-processor.  It should work with v1.1 or v1.2 of
  17. DOOM.
  18.  
  19. What exactly does it do?
  20. ^^^^^^^^^^^^^^^^^^^^^^^^
  21. In short, VERDA can be used to examine and modify map information in
  22. the WAD file.  A dump and patch capability exists that lets you dump certain
  23. information from the WAD file to an ascii file, modify it, then patch
  24. the new info back into the WAD file.  This is handy for distributing
  25. edited versions of the WAD file by only distributing changes you made.
  26.  
  27. The primary mode, however is a graphical map mode and requires a mouse.
  28.  
  29. Currently, you can edit the following:
  30.  
  31. THINGS - These include barrels, imps, radiation suits, light posts, etc.
  32.    VERDA has a fairly complete thing editor.  You can change anything
  33.    to anything else, change skill levels the item appears at, and of course
  34.    move them around.  You cannot add or delete items, but that should
  35.    be in the next VERDA release.
  36.  
  37. LINES - These connect two vertices in the map.  They can be used to trigger
  38.    various actions when walking across the line, or throwing a switch that
  39.    is attached to that line.  These include raising and lowering
  40.    sectors, teleporting, etc.  You can change the action that is triggered
  41.    and change which sector is trigger by the line.  The map display shows
  42.    which sectors are triggered by the selected line and vice-versa.  Lines
  43.    also have paramters such as: Block sound, block monsters, etc.  These
  44.    can be edited as well.
  45.  
  46. SIDES - These contain information about the images that appear on the walls.
  47.    You can edit which image appears on which wall.
  48.  
  49. SECTORS - These are bounded areas on the map that have a constant
  50.    floor height and ceiling height.  You can select a sector and see which
  51.    lines can trigger that sector.  You can change the following information
  52.    for a sector:
  53.     Floor Image,    Floor Height
  54.     Ceiling Image,    Ceiling Height
  55.     Light Level,    
  56.     Sector Properties: Blinking lights, go dark, acid sector, etc.
  57.  
  58.    You can also change which line(s) trigger the sector action given above.
  59.  
  60. NODES - These can be displayed, but not edited.
  61.  
  62. Using VERDA
  63. ^^^^^^^^^^^
  64. VERDA(with no command line arguments) looks for DOOM.WAD in the
  65. directory it is run from.  A different WAD file can be specified with
  66. the -w option.  VERDA -? gives a list of possible options, also listed
  67. below:
  68.  
  69. Usage: verda [options]
  70.  
  71.   [-w] wadfilename   :specify wad file (doom.wad default)
  72.                    ('-w' is only optional if first arg)
  73.  
  74.   -pw PWADfile         :Uses PWAD file for all editing, only one
  75.                         maplevel per PWAD supported.  With this
  76.                         option, original IWAD file is not modified
  77.  
  78.   -e Episode_Num     :specify an initial episode
  79.  
  80.   -m Map_Num         :specify an initial map number
  81.  
  82.   -p patchfilename   :specify a patch file to modify WAD/PWAD file
  83.                         (operates in batch mode)
  84.  
  85.   -d <descr> fname   :dumps (in patch file format) to file fname
  86.                         <descr> first three chars significant, things, sects, etc.
  87.                         (operates in batch mode)
  88.  
  89.  
  90. VERDA comes up in a textmode main menu.  Following are the main menu choices:
  91.  
  92.     <E> key -- cycle current episode number up
  93.            with <Shift>, cycle down
  94.  
  95.     <M> key -- cycle current map number up
  96.            with <Shift>, cycle down
  97.  
  98.     <P> key -- read an ascii patch file and apply patch to WAD
  99.            or PWAD file, as appropriate.
  100.  
  101.     <D> key -- dump an ascii patch file, or a binary PWAD file.
  102.            Prompts for what kind of file to dump and
  103.            for filename.  The ascii patch file can be
  104.            edited and used to patch WAD or PWAD files.
  105.  
  106.     <L> key -- Gives a list of all items in the current level, and
  107.            displays the x,y pos and skill flags, in text mode.
  108.            Use <B> key to back up in list, <SPACE> to go forward.
  109.  
  110.     <O> key -- Similar to <L> but gives a sorted list, of unique
  111.            things, and how many of each one.
  112.  
  113.     <H> key -- Displays header information with starting address, and
  114.            cnt for THINGS, LINES, SIDES, etc. in the WAD file.
  115.  
  116.     <V> key -- Enter the Map viewing/editing mode.  This is where you
  117.     or       will spend most of your time in VERDA.  That is why
  118.     <RETURN>   the <RETURN> key is provided as a quick way to get to
  119.            map mode.
  120.  
  121.   The current Episode/Map level is shown at the bottom of the screen and
  122. all other commands will only relate to that particular level.  The 
  123. options to specify what kind of info to dump are not case sensitive
  124. and are given here:
  125.  
  126.   T - Things - Things are weapons, enemies, barrels, etc.
  127.   L - Lines  - Lines connect the vertices, and draw the maps
  128.   I - sIdes  - Sides are associated with lines provide images for them
  129.   V - Verts  - Vertexes are the points where lines end
  130.   G - seGs   - Not fully understood
  131.   S - Ssects - SubSectors.
  132.   N - Nodes  - Not fully understood
  133.   C - seCts  - Defines an area with a specific height, floor & ceil image, etc.
  134.   A - All    - Dumps all of the above into one file (for given Episode/Map)
  135.   P - PWADfile - this one option does not dump an ascii file, as do
  136.          the rest, but instead dumps a binary PWAD file from the
  137.          current episode/map of the IWAD file.  This PWAD
  138.          file can then be edited separately.
  139.  
  140. Some notes about PWAD files:
  141.  
  142.    PWAD files are like mini-WAD files that can be loaded into DOOM
  143. using the -file option.  It appears that they must have the extension
  144. .WAD to work properly.  When DOOM reads in a PWAD file, it looks to
  145. see what is in that file and uses anything that is in the PWAD file
  146. instead of the corresponding information in the original IWAD file.
  147. So if you have a PWAD file with a new map for Episode 2/Map 3, DOOM
  148. will play using the original IWAD file until you get to Episode 2/ 
  149. Map 3 and then it will use the PWAD data.  Therefore PWAD files
  150. provide an easy way to play around with editing a level, without
  151. changing the original IWAD file.  Also note that if you use the -wart
  152. command line parameter of doom to specify an episode and map to jump to,
  153. doom automatically looks for EaMb.WAD, where 'a' is the specified episode
  154. and 'b' is the specified map.
  155.  
  156.    VERDA lets you decide if you want to edit your original WAD file,
  157. or use PWAD files.  If you decide to edit your original file, it is
  158. recommended that you dump "all" to a file for a particular map 
  159. before you edit anything in the original IWAD file.  This will let
  160. you patch the WAD file back to its original configuration, without
  161. having to have a backup of the whole WAD file.  Of course it is also
  162. comforting to know that you have those original distribution
  163. diskettes around somewhere...  The dump file contains information
  164. about what Episode/Map and type of information was dumped.
  165. Therefore, to patch in a file use the <P> key and the only response
  166. required is the filename -- the correct items will be patched.
  167.  
  168.  
  169. Map Mode Description
  170. ^^^^^^^^^^^^^^^^^^^^
  171. The map mode of VERDA is entered by using either the <V> key or
  172. <RETURN> from the main menu to view the map.  Hopefully the interface
  173. here is fairly intuitive. You can use the <PageUp>/<PageDn> keys to
  174. zoom the map in and out -- centered on the mouse cursor.  The
  175. <left>/<right>/<up>/<down> arrow keys are used to pan around in the map.
  176.  
  177. VERDA v0.20 supports the following editing modes: things, lines,
  178. sides, sectors, and nodes.  The specifics of these modes are given
  179. below, but first some information about VERDA editing that is mode
  180. independent.  
  181.  
  182. The lower right had window of the screen is the DATA area.
  183. Information about the currently selected object is displayed here.
  184. This includes object type and number, and other information that is
  185. specific to the object type(e.g., wall description for SIDES, skill
  186. level bits for THINGS, etc).  You can use the keypad +/- keys to step
  187. up/down to the next/previous object number (except in THING mode).
  188. When you have selected the object that you want to edit and the DATA
  189. area is displaying information for that object, use the <SPACE> bar
  190. to enter edit mode.  Your options will appear in the upper right
  191. hand window, which is the MENU area.  Move the mouse cursor over the
  192. action you want to perform and click the left mouse button.  You may
  193. get a window full of options to pick from if you select change wall
  194. type for example.  All of the choices may not fit in the window, so
  195. use PgUp/PgDn to scroll through the list, then click the mouse on the
  196. one you want to select.  When you have completed editing that object,
  197. use the <SPACE> bar (or <ESC>) to leave the editing mode for that
  198. object.  You can then select the next object that you want to change
  199. and repeat the above. 
  200.  
  201.  
  202. THING Mode --  Toggle on/off with <T> key.
  203.  
  204.    When you first enter the map, this is the default mode.  Things
  205. are displayed on the map, with different symbols for different types
  206. of things.  Arrows are used for any thing where the angle is
  207. meaningful, player starts and enemies.  Player starts are shown in
  208. white, to make them easier to find.  Special items (ammo, bonus
  209. items, etc) are shown as circles.  Weapons are shown as stars.  Other
  210. items appear as squares.  
  211.  
  212.    As you move the pointer over a "thing" the relevant information is
  213. displayed in the lower right hand window: what it is, orientation,
  214. skill level flags, etc.  To move a "thing", simply put the pointer
  215. over it, hold down the left mouse button and drag the item to its new
  216. location.  When you release the item, it is drawn at its new
  217. position.  There are no checks for illegal options, such as putting
  218. things in a wall, or on top of another thing -- so feel free to
  219. experiment if you are curious.  You can rotate an item by pressing
  220. <R> or <Shift-R> while the mouse pointer is over the item.  To change
  221. thing characteristics other than position and orientation, move the
  222. mouse pointer over the item and press the <SPACE> bar to bring up the
  223. editing menu.  Use the mouse to select the desired action.  
  224.  
  225. LINE Mode -- Toggle on/off with <L> key
  226.  
  227.   You select the current line by either using the keypad +/- key to
  228. step through the lines, or by moving the mouse over a line and
  229. clicking the left mouse button.  The current line is highlighted in
  230. white on the map.  A line may have one or two SIDES associated with it.
  231. The side indices are displayed in the DATA area in line mode.  There is
  232. also a flag field with bits that define whether the line blocks
  233. enemies, sounds or you, whether or not the line should show up in the
  234. automap, and whether or not it should show up as a door.  These
  235. fields can be toggled, and when the <SPACE> bar is used to go into
  236. line edit mode, the toggle actions appear in the MENU area of the screen.
  237.  
  238.   The line may have an action flag associated with it.  If so, there
  239. is a tag field with a number that matches the tag field in one or
  240. more sectors.  This indicates that this line can trigger a certain
  241. action for those sectors.  The action is listed in the DATA area of
  242. the screen, and the tagged sectors are highlighted in yellow.
  243. Actions are normally triggered by walking over the line.  If the
  244. action requires a <SPACE> bar to throw a switch, this action has a <->
  245. symbol in front of the action description.  This is a useful feature
  246. for seeing how certain actions are triggered.  We have not seen this
  247. in any other editor yet.  You can also modify the action or the
  248. sector tag number.
  249.  
  250. SIDE Mode -- Toggle on/off with the <I> key (sIdes)
  251.  
  252. Sides can be selected with the mouse similar to lines (described
  253. above).  Since there are possibly two-sides associated with a given
  254. line, the mouse click selects the first side for that line.  Use the
  255. <TAB> key to select the other side (if present).  The sides are what
  256. describe the images seen on the walls.  There are three image
  257. description fields associated with each side:  An upper side, a full
  258. side, and a lower side.  If the side describes a normal wall, the
  259. full description is used.  If the side describes an area with a
  260. window, then the upper and lower descriptions are used for the area
  261. above and below the window, i.e., they may have different images.
  262. The images for a certain SIDE can be changed by using the <SPACE> bar to
  263. enter edit mode, then selecting the appropriate field.  A list of
  264. Wall descriptions will appear to select from.
  265.  
  266. SECTOR Mode -- Toggle on/off with <C> key (seCtor)
  267.  
  268. You can highlight a specific sector by clicking the mouse while the
  269. pointer is on a line of the desired sector.  Since each line could
  270. have two sectors associated with it, use the <TAB> key to move to the
  271. other sector for the selected line.
  272.  
  273. When the current sector is highlighted, if the line tag field is
  274. non-zero then that sector can be triggered from a line somewhere.
  275. The line(s) that trigger that sector are highlighted in yellow on the
  276. map display.  This is the logical converse of the action in LINE mode
  277. described above.  
  278.  
  279. Each sector has a ceiling and floor description, and a ceiling and
  280. floor height, all of which are displayed for the current sector and
  281. which can be edited.  Additionally there is a sector property field
  282. which is used to make the sector act like acid (health hit), or count
  283. as a secret in the end tally, or have blinking lights.  This field is
  284. displayed and can also be edited.  There is also a static light level
  285. that can be set anywhere from 0 -> 0xff.
  286.  
  287.  
  288. NODE Mode -- Toggle on/off with <N> key
  289.  
  290. We still haven't fully deciphered the purpose of the NODE fields.  However,
  291. you can step through and display them with the Keypad +/- keys and
  292. maybe you can figure them out....
  293.  
  294. Map Mode Command Summary
  295. ^^^^^^^^^^^^^^^^^^^^^^^^
  296.     Left Mouse
  297.     Button        - Select line/side/sector under current mouse pointer
  298.     <TAB>         - Move to next object associated with this line
  299.             (mostly for sides and sectors)
  300.     <SPACE>       - Toggle edit mode for currently selected object
  301.     <ESC>         - Exit whatever you are doing -- will prompt you
  302.                     if you need to save changes
  303.     <PgDn/PgUp>   - Zoom In/Out
  304.           - Also used to page through a list of selectable items
  305.     <Arrow Keys>  - Pan around
  306.     <HOME>        - Return Map to original zoom, recentered
  307.     <Keypad-5>    - Center Map with current zoom
  308.  
  309.     <R>           - Rotate a "thing" +45 degrees if mouse over thing
  310.     <Shift-R>     - Rotate -45 degrees
  311.     <T>           - Toggle Thing mode
  312.     <L>           - Toggle Line mode
  313.     <I>           - Toggle sIde mode
  314.     <C>           - Toggle seCtor mode
  315.     <N>           - Toggle Node mode
  316.     <+/->         - Step Up/Down through lines, sides, sectors, and nodes
  317.     <Shift>       - with above to step through faster
  318.     <Alt-S>       - Save changes to the current WAD or PWAD file
  319.  
  320. Future Versions
  321. ^^^^^^^^^^^^^^^
  322. Vaporware is never very popular to talk about, but we do it anyway.
  323. This version of VERDA is greatly improved over the previous release,
  324. and we expect future releases to add new features as well.  We expect
  325. that the next release will include the ability to add and delete
  326. objects, instead of just changing them.  And of course, we are
  327. working to decipher the rest of the information (primarily NODES)
  328. needed to be able to build a workable level from scratch.
  329.  
  330. Authors
  331. ^^^^^^^
  332. VERDA is being developed as a team effort by Mike Carter, Robert
  333. Fenske, and Bob Robison.  
  334.  
  335. We are very interested in feedback on this program.  Send comments,
  336. complaints, suggestions, words of encouragement, etc. to the authors.
  337. Our email address is verda@swri.edu.
  338.