home *** CD-ROM | disk | FTP | other *** search
/ Quaaake Level & Editor 1 / Quaaake_1.iso / quake / editor / quest / quest017.doc < prev   
Encoding:
Text File  |  1996-08-22  |  13.8 KB  |  357 lines

  1.  
  2.  
  3.  
  4.                             Q U E S T
  5.                      (QUake Editing STation)
  6.                         Public Beta 1.017
  7.  
  8.                        Copyright  (c) 1996
  9.                           Chris Carollo
  10.                                and 
  11.                           Trey Harrison 
  12.  
  13.  
  14.  
  15.  
  16.  
  17. 1.0   Overview of Quake Editing
  18.  
  19. 2.0   The Quest Screen Layout
  20.  2.1   The Editing Area
  21.  2.2   The Message Area
  22.  2.3   The Tool Area
  23.  2.4   The Menu Area
  24.  2.5   The Status Area
  25.  
  26. 3.0   Editing Modes in Quest
  27.  3.1   Brush
  28.  3.2   Entity
  29.  3.3   Script
  30.  
  31. 4.0   Viewing Modes in Quest
  32.  4.1   3-D Mode
  33.  4.2   2-D Mode
  34.  
  35.  
  36.  
  37.  
  38. 1.0 Overview of Quake Editing
  39. -----------------------------
  40.  
  41.    The basic building block of all Quake maps is the brush.  A brush
  42.    is nothing more than a convex polyhedron.  Many people have given
  43.    very complex descriptions of brushes, but in truth they are pretty
  44.    simple. 
  45.  
  46.    A 3-dimensional polyhedron (plural polyhedra) is a collection of 
  47.    polygons that enclose a space.  A polyhedron must be closed, and
  48.    therefore must contain at least four polygons (or "faces"), which
  49.    would form a tetrahedron.  A cube is a polyhedron with 6 faces.
  50.    Polyhedra can consist of any number of polygons.
  51.  
  52.    A *convex* polyhedron is simply a polyhedron that has no "dents"
  53.    or places where it folds back upon itself.  If you fire any line
  54.    through a convex polyhedron, it will never intersect the polyhedron
  55.    more than twice (once on its way in, once on its way out).  If it
  56.    enters, exits, and then enters again, then the polyhedron isn't
  57.    convex.  If you know the different between a convex and concave
  58.    polygon, just apply this to a 3-dimensional case.
  59.  
  60.    Quake maps are generated from a huge merge of all the faces of all
  61.    the brushes in a map.  QBSP fuses all brushes together and discards 
  62.    the parts that are inside other brushes or outside the useable part 
  63.    of the map.  This is one of the reasons why it is important to make 
  64.    sure that maps are "sealed" - so that Quake can discard all those 
  65.    faces that are on the outside of the map.
  66.  
  67.    Another important concept is that brushes are solid.  With the exception 
  68.    of water, acid, and lava brushes (more on those later), you can not be 
  69.    "inside" a brush.
  70.  
  71.    The other primary element of Quake maps is the entity.  Entities
  72.    include player starts, enemies, weapons, powerups, and lights.
  73.  
  74.  
  75. 2.0 The Quest Screen Layout
  76. ---------------------------
  77.    
  78.    The Quest editing screen is broken into five main areas: 
  79.    
  80.    2.1 The Editing Area 
  81.    -------------------- 
  82.  
  83.       The main editing area consists of one or more viewports.  The
  84.       active viewport is designated by a bright white outline, as 
  85.       opposed to a greyer outline for inactive viewports.  To make
  86.       an inactive viewport active, simply click on it.  The camera
  87.       is manipulated using the following keys:
  88.  
  89.         A         Move Forward
  90.         Z         Move Backward
  91.         Left      Strafe Left
  92.         Right     Strafe Right 
  93.         Up        Strafe Upward
  94.         Down      Strafe Downward
  95.  
  96.         Alt-Left  Rotate left
  97.         Alt-Right Rotate right
  98.         Alt-Up    Look up
  99.         Alt-Down  Look down
  100.  
  101.         C         Zoom map in
  102.         V         Zoom map out
  103.  
  104.       Note that the strafing commands always behave consistently, 
  105.       regardless of the direction in which the camera is pointing.
  106.       However, the rotate left and rotate right commands always 
  107.       rotate as if the camera were not pointed up or down.  You can
  108.       think of this as a person turning to their left or right while 
  109.       looking at their toes or at the moon.
  110.  
  111.       The camera limitations of 90 degrees is completely intentional, 
  112.       and is not likely to change.  Elements can only be moved in
  113.       the plane parallel to the view plane (perpendicular to the view 
  114.       direction).  Allowing the user to edit at a skewed angle introduces 
  115.       many problems, all of which are eliminated by limiting the editing 
  116.       to planes parallel to the principal axes.
  117.  
  118.       The C and V keys are only applicable in 2-d mode.
  119.  
  120.       A freelook-style view option will be used to view the map, but
  121.       editing will not be allowed in this mode.
  122.  
  123.  
  124.    2.2 The Message Area
  125.    --------------------
  126.       
  127.       The message area contains informative messages about the status 
  128.       of the map and of Quest as you edit.  It can be scrolled backward 
  129.       and forward using the up and down buttons and the scrollbar on the 
  130.       right side of the area.      
  131.       
  132.    2.3 The Tool Area
  133.    -----------------
  134.  
  135.       The tool area contains buttons that can be used as shortcuts to
  136.       functions.  These buttons are:
  137.  
  138.       Moving the Camera - the buttons along the bottom of the area with
  139.          arrows are used to move and rotate the camera.
  140.  
  141.       Adding a New Brush - the button with the cube is used to add a 
  142.          new cube brush to the map.
  143.  
  144.       Copying Brushes - the button with the overlapping squares is used
  145.          to copy brushes.
  146.  
  147.       Deleting - depending on the editing mode, the button with the 
  148.          scrawled X will delete the selected brushes or entities.
  149.          [ not yet implemented ]
  150.  
  151.       Building the Map - the button with the large capital letter "B"
  152.          is used to build the map (or the current group) and enter Quake.
  153.          [ not yet implemented ]
  154.  
  155.       Selecting Textures - the button with the large capital letter "T"
  156.          is used to select the current texture.
  157.  
  158.       More buttons will be added to the tool area as they are deemed
  159.       useful.
  160.  
  161.    2.4 The Menu Area
  162.    -----------------
  163.  
  164.       The menu area can be used to execute every function available in
  165.       Quest.  It is set up in a hierarchical fashion (users of 3D Studio
  166.       will be familiar with it).  As you select a function in the menu,
  167.       another submenu (indented slightly) will appear below the current 
  168.       choices.  This menu system has the advantage of having a strongly
  169.       structured hierarchy while also allowing the user to select any
  170.       of the items along this hierarchy with a single mouse click.
  171.  
  172.    2.5 The Status Area
  173.    -------------------
  174.  
  175.       The status area is used to convey information about the current
  176.       status of Quest to the user. 
  177.  
  178.  
  179. 3.0 Editing Modes in Quest
  180. --------------------------
  181.  
  182.    There are three primary editing modes in Quest.  They are toggled
  183.    between with the TAB key.
  184.  
  185.    3.1 Brush Mode
  186.    --------------
  187.  
  188.       As described earlier, brushes are the basic building blocks of
  189.       all Quake maps.
  190.  
  191.       In Quest, only brushes that are selected may be edited.
  192.      
  193.       To select a brush, click on it's focal point (denoted by a small 
  194.       red circle at the center of the brush) while holding down Control.  
  195.       When a brush is selected, it turns yellow.  Many brushes may be 
  196.       selected at a time by holding down Control and clicking and dragging
  197.       a window around multiple focal points (be sure your initial click is 
  198.       not on a focal point, though!)  If a brush is already selected when 
  199.       it is Control-clicked on, it will become deselected.  A Control-click 
  200.       that does not select any brushes will deselect all currently selected
  201.       brushes.
  202.  
  203.       When brushes are selected, the following operations are possible:
  204.  
  205.       Vertex Movement - The vertices of selected brushes may be moved.
  206.          Vertices are denoted by cyan squares.  They can be dragged
  207.          with the left mouse button.  Multiple vertices can be selected
  208.          by holding down Shift when clicking.  If a selected vertex is
  209.          Shift-clicked on, it will be deselected.  Many vertices can
  210.          be selected at a time by Shift-clicking and dragging a window
  211.          around multiple vertices.  A click away from all vertcies will 
  212.          deselect all currently selected vertices.
  213.  
  214.       Texture Application - A texture can be applied to selected
  215.          vertices with the Texture button in the tool area or via
  216.          the Settings->Def Texture menu item.  All selected brushes 
  217.          will have the current texture applied to them.  Note that 
  218.          simply selecting brushes will not apply the current texture 
  219.          to them - you must select the desired brushes, THEN choose 
  220.          the texture.  Only when a texture is chosen is it applied to 
  221.          selected brushes.
  222.  
  223.       Copy Brush - Brushes may be duplicated as a method of adding
  224.          new brushes.  After selecting the brushes to be copied, 
  225.          click on the Copy button.  Then hit Ctrl-A to select all
  226.          vertices in the selected brushes, and drag the copied brushes 
  227.          to their new location.  Be sure not to delselect the brushes
  228.          after clicking all copy buttons, or you will have two identical
  229.          overlapping brushes.
  230.  
  231.       Delete Brush - The Delete button, pressing DEL, or selecting
  232.          Delete->Brush from the menu will delete all selected brushes 
  233.          from the map.
  234.  
  235.       Split Face - The face of a selected brush may be split.  When
  236.          splitting a brush face, you will need to select two points 
  237.          on the same face of a single brush.  These points can be 
  238.          either vertices, edges, or one of each.  An edge is created 
  239.          between the two selected points.  If a selected point is on
  240.          an edge, the edge is divided in two and a new vertex is added.
  241.          
  242.          [ Face splitting is not yet implemented ]
  243.  
  244.       Merge Face/Vertex - Really a special case of vertex movement,
  245.          vertices and faces can be merged.  If a vertex is moved on 
  246.          top of another vertex in the brush, they will be merged into
  247.          a single vertex.  If vertex movement causes a face to disappear, 
  248.          it will be removed from the brush, and its edges will be merged.
  249.      
  250.          [ Face merging is not yet implemented ]
  251.  
  252.       Group/Name - Brushes can be assembled into groups.  These groups
  253.          can be named, displayed individually, built individually,
  254.          and more.  To create a group of brushes, simply select them
  255.          and execute Create->Group, or click on the Create Group button.
  256.          This will create a dialog that will allow you to specify the
  257.          name of the group.
  258.  
  259.          [ Brush grouping is not yet implemented ]
  260.  
  261.       New brushes can be created with the Create->Brush family of 
  262.       menu items, or with the Create Brush button.  When a brush
  263.       is created, it is placed a certain distance in front of the
  264.       current camera position.  It can then be selected and placed
  265.       where it is desired.  
  266.  
  267.       The following keyboard shortcuts are available in Brush Mode:
  268.  
  269.          Ctrl-A:  Select all vertices in all selected brushes.
  270.  
  271.  
  272.    3.2 Entity Mode
  273.    ---------------
  274.  
  275.       Entities are much simpler to work with than brushes.  In the 
  276.       3-d world, they simply have a location.  The only operations 
  277.       on entities are addition, modification, movement, and deletion.
  278.  
  279.       Entities can be adding using the Create->Entity menu tree.  Many
  280.       of the stock entity types are available there.  More will be
  281.       added as I determine their classnames.
  282.  
  283.       A short description is displayed in the status area as you
  284.       move the mouse pointer over entities.
  285.  
  286.       Entities are moved much as vertices are.  Shift allows you to 
  287.       select entities, which can then can be dragged to their new
  288.       positions.  
  289.  
  290.       The complexity of entities lies in the fact that entities can 
  291.       have attributes that define thier properties.  For example,
  292.       certain items may have light values, and when an item appears 
  293.       (skill level, coop, deathmatch, etc) is defined with an attribute.
  294.  
  295.       The edit entity button, Edit->Entity, or Ctrl-E will create an
  296.       Edit Entity dialog, which will allow you to manually enter
  297.       attributes.  When you click on OK, the displayed attributes will 
  298.       be applied to all selected entities.
  299.  
  300.       The delete button, prssing DEL, or selecting Delete->Entity from
  301.       the menu will delete all selected entities from the map.
  302.  
  303.             
  304.    3.3 Script Mode
  305.    ---------------
  306.  
  307.       Scripts are basically just attributes on brushes.  Not all
  308.       brushes will have attributes - in fact, most brushes in 
  309.       the map won't.  Just those brushes with a special behavior 
  310.       (lifts, doors, crushers, platforms, and the brushes that
  311.       trigger these events) will need to have a script.  Triggering
  312.       events is very simple in Quake - coming in contact with a
  313.       brush set as a trigger is usually sufficient.
  314.  
  315.       Scripts can be done for single or multiple brushes - Quake
  316.       allows for both.
  317.  
  318.       Scripts are created by defining the type of object you're
  319.       creating (lift, door, etc), and then defining points along 
  320.       its movement path.  These points are depicted as lines from 
  321.       the focal point of the object, with arrows displaying the 
  322.       direction of movement.  
  323.  
  324.       [ The implementation of scripts are not yet finalized.  This 
  325.         is just a rough estimate of how I'd like them to work ]
  326.        
  327.  
  328. 4.0 Viewing Modes in Quest
  329. --------------------------
  330.  
  331.    As of Quest 1.017, only two viewing modes are implemented.  In both
  332.    the 3-D Wireframe and the 2-D Modes, pressing B will toggle fullbright
  333.    mode, where there is no depth clipping or shading.
  334.  
  335.    F1 will toggle a fullscreen viewport.
  336.  
  337.    4.1 3-D Wireframe Mode
  338.    ------------
  339.  
  340.       3-D Wireframe Mode is the primary mode of Quest.  It is used as a 
  341.       realtime-updated view of the map in three dimensions.  3-D mode is
  342.       useful for selecting brushes and vertices, because it is fairly
  343.       easy to see exactly what is selected, which can be confusing in
  344.       2-D mode.
  345.  
  346.    4.2 2-D Mode
  347.    ------------
  348.  
  349.       2-D Mode (or Flat Mode) is toggled with the F key.  2-D mode is 
  350.       very useful for alignment and movement, which perspective views 
  351.       can make almost impossible.  
  352.  
  353.       Note that in 2-D mode, sections of the map may be behind the 
  354.       camera and therefore not displayed, even when fullbright is 
  355.       enabled.
  356.  
  357.