Difference between revisions of "Universal Wolfenstein Map Format"

From ECWolf Wiki
(Overview: Removed the part about the new format being forced since it hasn't been true for awhile. You can use old format maps in WADs/PK3s with the PLANES lump see the techdemo for example.)
(New stuff in 1.3)
Line 28: Line 28:
 
After the header information is set one or more of each of the following blocks can be defined.
 
After the header information is set one or more of each of the following blocks can be defined.
 
* '''plane''' { ''properties'' }
 
* '''plane''' { ''properties'' }
* '''planemap''' { ''{<tile>,<sector>,<zone>}, ...'' }
+
* '''planemap''' { ''{<tile>,<sector>,<zone>[,<tag>]}, ...'' }
 
:Assigns tiles, sectors, and zones to each map tile. Each plane should have a corresponding planemap.
 
:Assigns tiles, sectors, and zones to each map tile. Each plane should have a corresponding planemap.
 
* '''sector''' { ''properties'' }
 
* '''sector''' { ''properties'' }
Line 53: Line 53:
 
* '''blockingwest = <bool>;'''
 
* '''blockingwest = <bool>;'''
 
:Sets the side of the tile as blocking. Default is true.
 
:Sets the side of the tile as blocking. Default is true.
 +
* '''dontoverlay = <bool>;''' {{new}}
 +
:Prevents the tile from appearing on the overlay map.
 +
* '''mapped = <int>;''' {{new}}
 +
:Sets if the tile should appear on the auto map even if the player hasn't seen it. The value must be greater than the [[MAPINFO/Skill_definition|skill]]'s MapFilter property in order to be seen.
 
* '''offsethorizontal = <bool>;'''
 
* '''offsethorizontal = <bool>;'''
 
* '''offsetvertical = <bool>;'''
 
* '''offsetvertical = <bool>;'''
 
:Offsets the texture by a half tile as commonly seen in doors.
 
:Offsets the texture by a half tile as commonly seen in doors.
 +
* '''soundsequence = "<string>";''' {{new}}
 +
:Sets the [[SNDSEQ|sound sequence]] to use for events regarding this tile.
 
* '''textureeast = "<string>";'''
 
* '''textureeast = "<string>";'''
 
* '''texturenorth = "<string>":'''
 
* '''texturenorth = "<string>":'''
Line 61: Line 67:
 
* '''texturewest = "<string>";'''
 
* '''texturewest = "<string>";'''
 
:Sets the textures to use on each side of the tile.
 
:Sets the textures to use on each side of the tile.
 +
* '''textureoverhead = "<string>";''' {{new}}
 +
:Sets the texture to be used for the tile on the auto map.
  
 
== Things ==
 
== Things ==

Revision as of 22:04, 24 June 2014

The Universal Wolfenstein Map Format (UWMF) is a text based, extendable, specification for defining map structures. At the current time ECWolf is not a complete implementation of the specification.

Overview

UWMF is loosely based on the textual map format for Doom known as Universal Doom Map Format (UDMF). UWMF keeps the main concepts present in vanilla Wolf3d map editing. At its core, the format still supports the idea of planes of data which act as canvas which can be "painted." The big difference now is that the set of textures is defined on the map by name instead of a global index. This makes maps a whole lot more portable than before. In the future editors will, however, likely hide most of the details in defining the palettes for textures, flats, and sound zones (previously floor codes). Technically each individual wall side on a map could be given its own unique texture, if desired.

One thing the format does away with is special floor codes. A secret exit is defined by assigning a secret exit trigger to a wall. "Deaf" enemies are defined by simply flagging them as such. The format also handles special triggers which are possible to assign uniquely to each side of a wall - for example, one way doors or pushwalls that can be activated only from a certain direction.

Currently ECWolf does not implement the entirety of the new format, and no editor is directly capable of creating it. Maps can be created by using the export feature present in WDC and HWE. This is for two main reasons: whilst the format allows things to be placed independently on different walls of the grid, no editor is capable of providing this granularity; and the format is designed assuming the possibility of stacking planes, a goal for ECWolf 2.x. Currently maps are limited to one plane (a plane in the new format is a Z layer).

Note that ECWolf planes are a different concept from planes in vanilla Wolfenstein 3D. In the latter case the term 'plane' refers to the wall/floor layer or the object layer, whereas in ECWolf the term refers to a complete 2-d map layout including all objects and walls.

In order to harness the full power of the ECWolf engine, this map format will need to be used. It is, however, not required as binary format maps can be translated on the fly with some limitations.

Globals

  • namespace = "Wolf3D";
Sets the namespace of the properties used by this map. Must be the first item in a map.
  • name = "<string>";
Sets the name of the map. This can be overridden in MAPINFO.
  • tilesize = <integer>;
Sets the width, in pixels, of a standard map tile.
  • width = <integer>;
Width of the map in tiles.
  • height = <integer>;
Height of the map in tiles.

After the header information is set one or more of each of the following blocks can be defined.

  • plane { properties }
  • planemap { {<tile>,<sector>,<zone>[,<tag>]}, ... }
Assigns tiles, sectors, and zones to each map tile. Each plane should have a corresponding planemap.
  • sector { properties }
  • tiles { properties }
  • thing { properties }
  • trigger { properties }
  • zone { }

Planes

Defines a single plane of tiles. Unlike in the binary format a plane contains all information for one slice of the level's Z-axis. In other words most levels have one plane.

  • depth = <integer>;
Height of the plane in pixels.

Sectors

Defines the floor and ceiling texture for a tile.

  • textureceiling = "<string>";
  • texturefloor = "<string>";

Tiles

Defines a set of textures and properties to use for the walls in a map tile.

  • blockingeast = <bool>;
  • blockingnorth = <bool>;
  • blockingsouth = <bool>;
  • blockingwest = <bool>;
Sets the side of the tile as blocking. Default is true.
  • dontoverlay = <bool>; (New from 1.3)
Prevents the tile from appearing on the overlay map.
  • mapped = <int>; (New from 1.3)
Sets if the tile should appear on the auto map even if the player hasn't seen it. The value must be greater than the skill's MapFilter property in order to be seen.
  • offsethorizontal = <bool>;
  • offsetvertical = <bool>;
Offsets the texture by a half tile as commonly seen in doors.
  • soundsequence = "<string>"; (New from 1.3)
Sets the sound sequence to use for events regarding this tile.
  • textureeast = "<string>";
  • texturenorth = "<string>":
  • texturesouth = "<string>";
  • texturewest = "<string>";
Sets the textures to use on each side of the tile.
  • textureoverhead = "<string>"; (New from 1.3)
Sets the texture to be used for the tile on the auto map.

Things

  • ambush = <bool>;
Sets the ambush flag for the thing. Default is false.
  • angle = <integer>;
Angle of the spawning point in degrees.
  • patrol = <bool>;
Spawns the thing as patrolling. Default is false.
  • skill1 = <bool>;
  • skill2 = <bool>;
  • skill3 = <bool>;
  • skill4 = <bool>;
Sets the skill levels in which the thing will spawn. Default is false.
  • type = <integer>;
Gives the editor number (as defined in DECORATE) of thing to spawn.
  • x = <float>;
  • y = <float>;
  • z = <float>;
Gives the coordinates of the spawning point of the thing. In pixels.

Triggers

  • action = <integer>;
Sets the action special to execute for this trigger.
  • activateeast = <bool>;
  • activatenorth = <bool>;
  • activatesouth = <bool>;
  • activatewest = <bool>;
Sets the faces on which the trigger will activate. Default is true.
  • arg0 = <integer>;
  • arg1 = <integer>;
  • arg2 = <integer>;
  • arg3 = <integer>;
  • arg4 = <integer>;
Arguments to pass to the action. Default is 0.
  • playercross = <bool>;
Allows the player to activate the line special by crossing the face. Default is false.
  • playeruse = <bool>;
Allows the player to activate the line special. Default is false.
  • monsteruse = <bool>;
Allows monsters to activate the line special. Default is false.
  • repeatable = <bool>;
Allows the special to be activated multiple times. Default is false.
  • secret = <bool>;
The trigger will count as a secret and will be tallied on first activation. Default is false.
  • x = <integer>;
  • y = <integer>;
  • z = <integer>;
Gives the coordinate of the map tile this trigger applies to.

Zones

Zones are areas in which sound can travel through. There are no properties for zones at this time, but they must be defined.

See Also