home *** CD-ROM | disk | FTP | other *** search
/ Quake 'em / QUAKEEM.BIN / quake / programs / quest02 / quest.doc < prev    next >
Encoding:
Text File  |  1996-03-06  |  7.1 KB  |  173 lines
  1.  
  2.                                 
  3.                                 ---------
  4.                                 Q U E S T
  5.                                 ---------
  6.                                    0.2
  7.  
  8.                            (C) Copyright 1996
  9.                               Chris Carollo
  10.                         carollo@cis.ohio-state.edu
  11.  
  12.                          A QUake Editing STation.
  13.                               
  14.  
  15. --------
  16. OVERVIEW
  17. --------
  18.  
  19. Quest is my first attempt at writing a multi-purpose editor for the
  20. DeathMatch Test for Quake.  It isn't particularly user-friendly, and
  21. requres a little knowledge of some of the Quake structures.
  22.  
  23. First of all, unpack the ID1.PAK file into its respective directories.
  24. There are plenty of utilities to do this, and I personally don't see PAK
  25. files hanging around.  In my opinion, BSP and MDL files are the files of
  26. interest.
  27.  
  28. New with version 0.2, Quest can edit the bitmaps that Quake uses to
  29. texturemap the levels.  Read the new Bitmap Mode section for information
  30. on how to use this Mode.
  31.  
  32. With the release of the Unofficial Quake Specs 3.0, true level editing
  33. seems surprisingly possible (though by no means simple).  Because of this,
  34. I'm starting an almost complete re-write of Quest, with the aim of creating
  35. a TRUE level editor.  So, unless some critical bugs are discovered, 0.2 is
  36. going to be the last version for a while.
  37.  
  38. I have yet to decide whether a translation into Windows is in Quest's best
  39. interest.  While the interface would be easy to use, it is not going to
  40. be quite as customizable as I would like.  Opinions?  E-mail me. :)
  41.  
  42.  
  43.  
  44. --------------
  45. STARTING QUEST
  46. --------------
  47.  
  48. Starting Quest is simply a matter of typing "QUEST <bspfile>" where
  49. <bspfile> is the file you wish to edit.  You will then find yourself in
  50. Main Mode...
  51.  
  52.  
  53.  
  54. ---------
  55. MAIN MODE
  56. ---------
  57.  
  58. When in Main Mode, you will see a prompt similar to the following:
  59.  
  60. - test1.bsp >
  61.  
  62. The leading dash indicates that you are currently in Main Mode, as opposed
  63. to Item Mode or Bitmap Mode (soon to be added).  Following the dash is the
  64. name of the BSP file that you are currently editing.  And finally the >
  65. finishes the prompt.
  66.  
  67. Typing "?" or "h" will list the commands available to you:
  68.  
  69.   I        Enter Item Mode.  See the ITEM MODE section for more info on
  70.             this.
  71.   S        Save BSP file As.  This command will prompt you for the new
  72.             filename of the BSP file that is currently being edited.
  73.   s        Save BSP file.  This command simply saves any changes that have
  74.             been made to the BSP file that is currently being edited.
  75.   !        Shell to DOS.
  76.   X        Exit from Quest.
  77.  
  78.  
  79.  
  80. ---------
  81. ITEM MODE
  82. ---------
  83.  
  84. When in Item Mode, you can (surprisingly enough) edit any of the items
  85. found in the BSP file.  There are basically two ways to add objects to the
  86. BSP file:  You can use the limited Add function of Quest, or Merge an item
  87. text file to the list of objects.  The first option is simpler and quicker
  88. for simple items, but doesn't allow you to define all attributes of the
  89. objects.  The second option allows you complete flexability at the cost of
  90. having to know how to properly define an object.
  91.  
  92. Typing "?" or "h" will list the commands available to you:
  93.  
  94.   A        Add an item to the BSP file.  Quest will prompt you for a
  95.             ClassName, Origin, Angle and Light value.  Note that the light
  96.             value does not actually change the lighting of the level.  The
  97.             lighting is stored elsewhere in the BSP file, but it is my guess
  98.             that these light objects are used in creating this other
  99.             structure, so I left the ability to change light value in Quest.
  100.   D        Dump to an item text file.  This will dump all the objects in a
  101.             BSP file to an editable text file.  Useful if you want to edit
  102.             this text file and insert it into the BSP file.
  103.   E        Edit and item.  This option will first prompt you for the object
  104.             number of the item you wish to edit (see the list function).
  105.             It will then ask which attribute of the item you wish to edit,
  106.             and then the new values for the item.
  107.   I        Import an item text file.  This will replace the current item
  108.             data of a BSP file with the data in the specified item text file.
  109.   L        List all the items in a level, and certain attributes of each of 
  110.             item.  It is not meant to be a complete reference list of
  111.             items, but more for identification purposes.
  112.   M        Merge an item text file.  This is identical to the Import
  113.             funtion, but adds the items to the current items rather than
  114.             over-writing them.
  115.   R        Remove an item.  This will first ask for confirmation of your
  116.             intent to remove the item, and then removes it from the level.
  117.   !        Shell to DOS.
  118.   X        Return to Main Mode.
  119.  
  120.            
  121.  
  122. -----------
  123. BITMAP MODE
  124. -----------
  125.  
  126. Bitmap mode allows you to import/export/view any of the bitmaps that Quake
  127. uses for texturemapping of the levels.
  128.  
  129. Typing "h" or "?" will list the commands available to you:
  130.  
  131.   L     List the bitmaps in the BSP file.  This will list the numbers,
  132.          names, and dimensions of all the bitmaps.  It is useful because
  133.          most of the other commands require a bitmap number as a
  134.          parameter.
  135.   N     Rename the specificed bitmap.  It seems that Quake references
  136.          textures by number rather than by name, because the names of the
  137.          textures can be changed without any ill effects in the actual game.
  138.   R     Replace the specified bitmap with a PCX.  There a few steps you
  139.          must take to properly replace a bitmap in Quake.  First, size the
  140.          PCX that you want to import to the size of the bitmap that you
  141.          want to replace.  If the sizes are different, Quake will crash.
  142.          (I don't know if this is a bug in Quest, or just a property of
  143.          Quake.  If there are other editors out there that let you import
  144.          bitmaps of different sizes, please let me know!).  Secondly,
  145.          you have to map the PCX to be imported to Quake's palette.  To
  146.          do this, run PALMAP (included with Quest) followed by quake.pal
  147.          and then the filename of the PCX to be imported.  Then you can
  148.          use this command in Quest to import the texture into Quake.
  149.   V     View the specified bitmap.  This will switch to 320x200x256 mode
  150.          and draw the specified texture to the screen.
  151.   W     Write a bitmap to a PCX.  This allows you to save a Quake texture
  152.          as a PCX, which could then possibly be edited and re-imported.
  153.   !     Shell to DOS.
  154.   X     Return to Main Mode.
  155.  
  156.  
  157.  
  158. -------
  159. CONTACT
  160. -------
  161.  
  162. Quest is obviously a very rough editor at this point, but I'm in a
  163. continuous state of adding new features.  There are obviously numerous
  164. bugs, which I'd like squish, or you you have a complaint, request, or
  165. whatever...feel free to e-mail me.  Here's my contact info:
  166.  
  167. Chris Carollo
  168. carollo@cis.ohio-state.edu
  169. http://www.cis.ohio-state.edu/~carollo
  170.  
  171.  
  172. Have fun!
  173.