Difference between revisions of "Map format"

From DoomWiki.org

[checked revision][checked revision]
(Added clarification opening paragraph about the relationship between map formats and source ports)
m (Hexen map format: Remove an unneeded "the" + rephrase 2nd-person address)
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Doom engine]] [[Commercial games|games]] and [[source port]]s make use of several different '''map formats'''.  There are currently three commonly used formats, each using different syntax for storing a map's data.  Different source ports can utilize a map format in different ways, meaning a project in a given map format does not guarantee compatibility with any specific source port.
+
[[Doom engine]] [[Commercial games|games]] and [[source port]]s make use of several different '''map formats'''.  There are currently three commonly used formats, each using different syntax for storing a map's data.  Different source ports can utilize a map format in different ways, meaning a project in a given map format does not necessarily guarantee compatibility with any specific source port.
  
 
==Doom map format==
 
==Doom map format==
Line 6: Line 6:
 
A Doom-format map normally has the following lumps in this sequence: map header, [[THINGS]], [[LINEDEFS]], [[SIDEDEFS]], [[VERTEXES]], [[SEGS]], [[SSECTORS]], [[NODES]], [[SECTORS]], [[REJECT]], [[BLOCKMAP]].
 
A Doom-format map normally has the following lumps in this sequence: map header, [[THINGS]], [[LINEDEFS]], [[SIDEDEFS]], [[VERTEXES]], [[SEGS]], [[SSECTORS]], [[NODES]], [[SECTORS]], [[REJECT]], [[BLOCKMAP]].
  
'''"Boom format"''' is a colloquial term referring to maps using features introduced with [[Boom]], such as [[deep water]] effects, [[translucent]] walls, [[conveyor belts]], generic [[linedef]] types and [[Boom#Features|other features]]. It is the same as the Doom map format, however maps which use these extra features are not compatible with vanilla Doom, but will run in any source port with Boom compatibility.
+
'''"Boom format"''' is a colloquial term referring to maps using features introduced with [[Boom]], such as [[deep water]] effects, [[translucent]] walls, [[conveyor belts]], generic [[linedef]] types and [[Boom#Features|other features]]. Similarly, '''"MBF format"''' refers to maps which make use of [[MBF]]'s features beyond those offered by Boom. These formats are the same as the Doom map format, however maps which use these extra features are not compatible with vanilla Doom, but will run in any source port with Boom or MBF compatibility.
  
 
==Hexen map format==
 
==Hexen map format==
 
Developed by [[Raven Software]] to support the enhanced features of [[Hexen]], most notably [[ACS|Action Code Scripting]], this is an extension of the Doom map format. [[ZDoom]] pioneered using this format for the other games, making it known as "Doom-in-Hexen", "Heretic-in-Hexen", and so on. This is somewhat of a misnomer: only the map format is affected, a "Doom-in-Hexen" map is still a map for Doom and will not work properly in Hexen.
 
Developed by [[Raven Software]] to support the enhanced features of [[Hexen]], most notably [[ACS|Action Code Scripting]], this is an extension of the Doom map format. [[ZDoom]] pioneered using this format for the other games, making it known as "Doom-in-Hexen", "Heretic-in-Hexen", and so on. This is somewhat of a misnomer: only the map format is affected, a "Doom-in-Hexen" map is still a map for Doom and will not work properly in Hexen.
  
The [https://doomshack.org/~doomkid/Utilities/ZWADCONV.zip ZWadConv] and [https://doomshack.org/~doomkid/Utilities/WinZWadConv.zip WinZWadConv] utilities convert Doom-formatted maps to the ZDoom's Doom-in-Hexen map format. For this reason, the Hexen format is a good choice for updating a vanilla or limit removing wad if you want to add advanced features to the project, such as [[3D floor]]s or [[slope]]s.
+
The [https://doomshack.org/~doomkid/Utilities/ZWADCONV.zip ZWadConv] and [https://doomshack.org/~doomkid/Utilities/WinZWadConv.zip WinZWadConv] utilities convert Doom-formatted maps to ZDoom's Doom-in-Hexen map format. For this reason, the Hexen format is a good choice for updating a vanilla or limit removing wad if one wants to add advanced features to the project, such as [[3D floor]]s or [[slope]]s.
  
 
A Hexen-format map has the same sequence of lumps as a Doom-format map, followed by a [[BEHAVIOR]] lump for compiled ACS, and optionally an uncompiled [[SCRIPTS]] lump at the end. However, the [[THINGS]] and [[LINEDEFS]] lumps are different and incompatible (the size of a single element is respectively 20 bytes instead of 10 and 16 bytes instead of 14), so even if a Hexen-format map does not use ACS, the BEHAVIOR lump is necessary to prevent the map from being interpreted incorrectly.
 
A Hexen-format map has the same sequence of lumps as a Doom-format map, followed by a [[BEHAVIOR]] lump for compiled ACS, and optionally an uncompiled [[SCRIPTS]] lump at the end. However, the [[THINGS]] and [[LINEDEFS]] lumps are different and incompatible (the size of a single element is respectively 20 bytes instead of 10 and 16 bytes instead of 14), so even if a Hexen-format map does not use ACS, the BEHAVIOR lump is necessary to prevent the map from being interpreted incorrectly.

Revision as of 03:47, 29 June 2021

Doom engine games and source ports make use of several different map formats. There are currently three commonly used formats, each using different syntax for storing a map's data. Different source ports can utilize a map format in different ways, meaning a project in a given map format does not necessarily guarantee compatibility with any specific source port.

Doom map format

The oldest format, as originally devised by id Software, sometimes referred to as vanilla Doom format (or limit removing format if the map surpasses the static limits of vanilla Doom). It is a binary format used by the classic Doom series, but also by Chex Quest, Heretic and Strife, with some differences in their sets of line specials. Maps created using this format will be compatible with all source ports. This format does not support ACS, line specials cannot have arguments, things cannot have specials, arguments, and other features present in more advanced formats.

A Doom-format map normally has the following lumps in this sequence: map header, THINGS, LINEDEFS, SIDEDEFS, VERTEXES, SEGS, SSECTORS, NODES, SECTORS, REJECT, BLOCKMAP.

"Boom format" is a colloquial term referring to maps using features introduced with Boom, such as deep water effects, translucent walls, conveyor belts, generic linedef types and other features. Similarly, "MBF format" refers to maps which make use of MBF's features beyond those offered by Boom. These formats are the same as the Doom map format, however maps which use these extra features are not compatible with vanilla Doom, but will run in any source port with Boom or MBF compatibility.

Hexen map format

Developed by Raven Software to support the enhanced features of Hexen, most notably Action Code Scripting, this is an extension of the Doom map format. ZDoom pioneered using this format for the other games, making it known as "Doom-in-Hexen", "Heretic-in-Hexen", and so on. This is somewhat of a misnomer: only the map format is affected, a "Doom-in-Hexen" map is still a map for Doom and will not work properly in Hexen.

The ZWadConv and WinZWadConv utilities convert Doom-formatted maps to ZDoom's Doom-in-Hexen map format. For this reason, the Hexen format is a good choice for updating a vanilla or limit removing wad if one wants to add advanced features to the project, such as 3D floors or slopes.

A Hexen-format map has the same sequence of lumps as a Doom-format map, followed by a BEHAVIOR lump for compiled ACS, and optionally an uncompiled SCRIPTS lump at the end. However, the THINGS and LINEDEFS lumps are different and incompatible (the size of a single element is respectively 20 bytes instead of 10 and 16 bytes instead of 14), so even if a Hexen-format map does not use ACS, the BEHAVIOR lump is necessary to prevent the map from being interpreted incorrectly.

Most ZDoom-family ports feature compatibility with Doom-in-Hexen format maps.

Universal Doom Map Format

Main article: UDMF

The UDMF, or "textmap" format, was developed specifically with extensibility in mind and does not suffer from the limitations that affect the binary formats. Ports which support UDMF format include GZDoom, Eternity, 3DGE, K8Vavoom and Zandronum. Each of these source ports has support for a variety of advanced mapping features such as 3D floors and deep water which can be taken advantage of using UDMF format.

A UDMF map has the following lumps: map header, TEXTMAP, ZNODES, REJECT, DIALOGUE, BEHAVIOR, ENDMAP. Of those, only the header, TEXTMAP and ENDMAP are mandatory; all others are optional, though they may be needed for certain features.

Sources

This article incorporates text from the open-content ZDoom documentation project article Map format.