Editing Quake Map Format

The Quake .map Format is a plain text file which contains definitions of [[Brush|brushes]] and [[Entity|entities]] to be used by [[QBSP]] and its related compiling tools to create a [[Quake_BSP_Format|.bsp file]] used by Quake as levels. They are generally created by [[Mapping_tools#General_Purpose_Editors|level editing software]].

=A simple map=
 {
 "spawnflags" "0"
 "classname" "worldspawn"
 "wad" "E:\q1maps\Q.wad"
 {
 ( 256 64 16 ) ( 256 64 0 ) ( 256 0 16 ) mmetal1_2 0 0 0 1 1
 ( 0 0 0 ) ( 0 64 0 ) ( 0 0 16 ) mmetal1_2 0 0 0 1 1
 ( 64 256 16 ) ( 0 256 16 ) ( 64 256 0 ) mmetal1_2 0 0 0 1 1
 ( 0 0 0 ) ( 0 0 16 ) ( 64 0 0 ) mmetal1_2 0 0 0 1 1
 ( 64 64 0 ) ( 64 0 0 ) ( 0 64 0 ) mmetal1_2 0 0 0 1 1
 ( 0 0 -64 ) ( 64 0 -64 ) ( 0 64 -64 ) mmetal1_2 0 0 0 1 1
 }
 }
 {
 "spawnflags" "0"
 "classname" "info_player_start"
 "origin" "32 32 24"
 }

This is an example of a simple map. There is a [[Worldspawn]] entity, a special entity which contains all of a map's solid geometry as well as some map properties, which has a single [[brush]] defined, and an [[info_player_start]] entity.

==Structure==
 {
 entity
 {
  brush (optional)
 }
 }

The general structure of a .map file is to contain entity objects between { } brackets, and to nest brushes within these objects.

==Entity definition==
 {
 "spawnflags" "0"
 "classname" "info_player_start"
 "origin" "32 32 24"
 }

An [[Entity|entity]] is simply defined by its classname, its origin, and its various [[Entity_guide|keys]]. An entity may also contain a brush, if it's of a type which uses a brush. An example of this is the worldspawn entity seen in our simple map, which contains a brush.

==Brush definition==
 {
 ( 256 64 16 ) ( 256 64 0 ) ( 256 0 16 ) mmetal1_2 0 0 0 1 1
 ( 0 0 0 ) ( 0 64 0 ) ( 0 0 16 ) mmetal1_2 0 0 0 1 1
 ( 64 256 16 ) ( 0 256 16 ) ( 64 256 0 ) mmetal1_2 0 0 0 1 1
 ( 0 0 0 ) ( 0 0 16 ) ( 64 0 0 ) mmetal1_2 0 0 0 1 1
 ( 64 64 0 ) ( 64 0 0 ) ( 0 64 0 ) mmetal1_2 0 0 0 1 1
 ( 0 0 -64 ) ( 64 0 -64 ) ( 0 64 -64 ) mmetal1_2 0 0 0 1 1
 }

A [[brush]] consists of several faces, each of which is defined by a [http://en.wikipedia.org/wiki/Plane_%28geometry%29 plane] and additional texture information. The actual geometry of the brush is only defined by the planes, of which there must be at least four. Each plane defines a [http://en.wikipedia.org/wiki/Half-space_(geometry) half space], that is, an infinite set of points that is bounded by a plane. The intersection of these half spaces forms a [http://en.wikipedia.org/wiki/Convex_set convex] [http://en.wikipedia.org/wiki/Polyhedron polyhedron]. Note that the actual [http://en.wikipedia.org/wiki/Vertex_%28computer_graphics%29 vertices] of the brush are '''NOT''' stored in the map file. The vertices are determined by BSP (or a level editing program) by computing the intersections of the planes.

In the example shown here, this brush is a 6 sided cuboid. The plane of its first face is defined by 3 points, ( 256 64 16 ) ( 256 64 0 ) ( 256 0 16 ). The other information supplied is the texture used by the face. "mmetal1_2" is the name of the texture, a single plane may only have a single texture. "0 0 0 1 1" are how the texture is display, and are respectively "X offset" "Y offset" "Rotation" "X scale" and "Y scale".

The plane points ( p1 ) ( p2 ) ( p3 ) are interpreted as follows. The plane points must be arranged such that the [http://en.wikipedia.org/wiki/Cross_product cross product] of the vectors (p3 - p1) and (p2 - p1) is not null, that is, the three points must be linearly independent. Then, the normalized cross product represents the [http://en.wikipedia.org/wiki/Plane_(geometry) normal vector] of the plane. Every point p for which (p - p1) * normal <= 0, where * is the [http://en.wikipedia.org/wiki/Dot_product dot product], holds is considered to be in the half space defined by the plane. Every other point is considered not to be in the half space.

The '''intersection of half spaces''' interpretation of brushes does not yield the vertices, however. While there are [http://www.sciencedirect.com/science/article/pii/0304397579900550 efficient methods] to compute them directly, the QBSP compiler uses a different approach. Starting with the edges and vertices of a huge cube (usually ranging from -4096 to 4096 in each dimension), the edges of the cube are intersected with the planes of the faces. Upon each intersection, new edges and vertices are generated that replace some of the old ones until all planes have been used. Note that due to floating point inaccuracies, there may be slight errors in the position of each vertex. This may lead to QBSP warnings when it '''heals''' degenerate vertices and edges.

In the example used here, all plane points have integer coordinates. In the original Quake map format, only integer coordinates are allowed. This has some advantages and drawbacks. The major advantage is that integer numbers can be written to text files without loss of precision, which is not always true for floating point numbers. The major drawback is that not every plane can be accurately represented using integer coordinates for its points. This becomes problematic when brushes are rotated arbitrarily or when the vertices are edited directly. That is why most modern Quake compilers allow floating point coordinates for plane points.

==Valve variation of the format==

On top of the original format and its non-integer variation, Quake tools (notably TrenchBroom and ericw-tools) support Valve 220 format. Major difference between both stems from how texture coordinates are represented. Quake standard format for plane definition:

 ( x1 y1 z1 ) ( x2 y2 z2 ) ( x3 y3 z3 ) TEXTURE Xoffset Yoffset rotation Xscale Yscale

is thus replaced with:

  ( x1 y1 z1 ) ( x2 y2 z2 ) ( x3 y3 z3 ) TEXTURE [ Tx1 Ty1 Tz1 Toffset1 ] [ Tx2 Ty2 Tz2 Toffset2 ] rotation Xscale Yscale

Simple cubes would look like this in standard and Valve formats respectively:

 // Game: Quake
 // Format: Standard
 // entity 0
 {
 "classname" "worldspawn"
 // brush 0
 {
 ( -16 -64 -16 ) ( -16 -63 -16 ) ( -16 -64 -15 ) __TB_empty -0 -0 -0 1 1
 ( -64 -16 -16 ) ( -64 -16 -15 ) ( -63 -16 -16 ) __TB_empty -0 -0 -0 1 1
 ( -64 -64 -16 ) ( -63 -64 -16 ) ( -64 -63 -16 ) __TB_empty 0 0 0 1 1
 ( 64 64 16 ) ( 64 65 16 ) ( 65 64 16 ) __TB_empty 0 0 0 1 1
 ( 64 16 16 ) ( 65 16 16 ) ( 64 16 17 ) __TB_empty -0 -0 -0 1 1
 ( 16 64 16 ) ( 16 64 17 ) ( 16 65 16 ) __TB_empty -0 -0 -0 1 1
 }
 }

----

 // Game: Quake
 // Format: Valve
 // entity 0
 {
 "classname" "worldspawn"
 "mapversion" "220"
 // brush 0
 {
 ( -16 -64 -16 ) ( -16 -63 -16 ) ( -16 -64 -15 ) __TB_empty [ 0 -1 0 -0 ] [ 0 0 -1 -0 ] -0 1 1
 ( -64 -16 -16 ) ( -64 -16 -15 ) ( -63 -16 -16 ) __TB_empty [ 1 0 0 -0 ] [ 0 0 -1 -0 ] -0 1 1
 ( -64 -64 -16 ) ( -63 -64 -16 ) ( -64 -63 -16 ) __TB_empty [ -1 0 0 0 ] [ 0 -1 0 0 ] 0 1 1
 ( 64 64 16 ) ( 64 65 16 ) ( 65 64 16 ) __TB_empty [ 1 0 0 0 ] [ 0 -1 0 0 ] 0 1 1
 ( 64 16 16 ) ( 65 16 16 ) ( 64 16 17 ) __TB_empty [ -1 0 0 -0 ] [ 0 0 -1 -0 ] -0 1 1
 ( 16 64 16 ) ( 16 64 17 ) ( 16 65 16 ) __TB_empty [ 0 1 0 -0 ] [ 0 0 -1 -0 ] -0 1 1
 }
 }