stjr/UltimateZoneBuilder
0
0
Fork 0
mirror of https://git.do.srb2.org/STJr/UltimateZoneBuilder.git synced 2024-11-26 22:01:45 +00:00
Code Issues Projects Releases Packages Wiki Activity

@ Some documentation on the Game Configurations in the reference manual

Browse source
This commit is contained in:
codeimp 2010-01-11 15:49:03 +00:00
parent 6f1abda51f
commit 90d867db6a
6 changed files with 445 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
Help/Contents.hhc
View file

@ -184,6 +184,18 @@
<param name="Name" value="About Game Configurations"> <param name="Name" value="About Game Configurations">
<param name="Local" value="gameconfigs.html"> <param name="Local" value="gameconfigs.html">
</OBJECT> </OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Name" value="Basic Settings">
<param name="Local" value="gc_basicsettings.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Name" value="Map Format Settings">
<param name="Local" value="gc_formatsettings.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Name" value="Resource Settings">
<param name="Local" value="gc_resourcesettings.html">
</OBJECT>
</UL> </UL>
<LI> <OBJECT type="text/sitemap"> <LI> <OBJECT type="text/sitemap">
<param name="Name" value="Scripting Configurations"> <param name="Name" value="Scripting Configurations">

9
Help/default.css
View file

@ -43,7 +43,7 @@ pre
background: #f4f4f4; background: #f4f4f4;
color: #515151; color: #515151;
width: 400px; width: 400px;
margin: 0px 0px 10px 20px; margin: 10px 0px 10px 20px;
font: 100% Courier New,Courier,sans-serif; font: 100% Courier New,Courier,sans-serif;
text-align: left; text-align: left;
padding: 5px 5px 5px 10px; padding: 5px 5px 5px 10px;
@ -140,3 +140,10 @@ a img
color: #8C8C8C; color: #8C8C8C;
text-align: center; text-align: center;
} }
.fat
{
color: #515151;
font-size: 1.1em;
}

5
Help/gameconfigs.html
View file

@ -18,7 +18,10 @@
<div id="contents"> <div id="contents">
<p> <p>
B These configurations are the largest and most complex ones. A Game Configuration contains all the settings that determine Doom Builder's behavior when editing your map and optional features that are specific to certain map formats can be enabled or disabled here. A Game Configuration also keeps all information about hardcoded actions and things in the game, which Doom Builder cannot find in the WAD files. You can find the Game Configurations in &quot;Configurations&quot; directory, which is a subdirectory of your Doom Builder's program directory. Subdirectories are not searched by Doom Builder for configurations, but you can use them for include files.
</p>
<p>
Many settings in Doom Builder's user interface as bound to the available Game Configurations. This is because the user often wants to use different resources and compilers for a different project. When Doom Builder starts up and detects a new Game Configuration file, it will automatically create default settings for that configuration. The following default settings are read from the Game Configuration (only when first detected by Doom Builder): <a href="gc_basicsettings.html#testparameters">testparameters</a>, <a href="gc_basicsettings.html#testshortpaths">testshortpaths</a>, <a href="gc_basicsettings.html#defaultsavecompiler">defaultsavecompiler</a>, <a href="gc_basicsettings.html#defaulttestcompiler">defaulttestcompiler</a>, <a href="gc_thingsfilters.html">thingsfilters</a> and <a href="gc_texturesets.html">texturesets</a>.
</p> </p>
</div> </div>
</body> </body>

132
Help/gc_basicsettings.html Normal file
View file

@ -0,0 +1,132 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<title>Game Configuration - Basic Settings</title>
<meta http-equiv="content-type" content="text/html; charset=iso-8859-1" />
<link rel="stylesheet" type="text/css" href="default.css" media="screen" title="Default" />
</head>
<body>
<object type="application/x-oleobject" classid="clsid:1e2a7bd0-dab9-11d0-b93a-00c04fc99f9e">
<param name="keyword" value="Configurations">
<param name="keyword" value="Game Configurations">
</object>
<div id="title"><h1>Game Configuration - Basic Settings</h1></div>
<div id="contents">
<p>
<b class="fat">type</b> (string)<br />
This indicates the type of configuration to prevent accedential use of a different configuration. Must always be the string "Doom Builder 2 Game Configuration".<br />
<br />
<b class="fat">game</b> (string)<br />
The name that is displayed in Doom Buider for your Game Configuration.<br />
<br />
<b class="fat">engine</b> (string)<br />
Game engine/sourceport name. This is used as the UDMF namespace for UDMF map format interface. It currently has no other function.<br />
<br />
<b class="fat">defaultlumpname</b> (string)<br />
Default lump name suggested when creating a new map and selecting this configuration.<br />
<br />
<b class="fat">testparameters</b> (string)<br />
Default parameters used to launch the test game engine. See <a href="w_gameconfigurations.html">Game Configurations window</a> for the available parameter placeholders.<br />
<br />
<b class="fat">testshortpaths</b> (boolean)<br />
Set to <b>true</b> to use MSDOS 8.3 format paths and filenames by default. Default is <b>false</b>. The user can still change this in the <a href="w_gameconfigurations.html">Game Configurations window</a>.<br />
<br />
<b class="fat">defaultsavecompiler</b> (string)<br />
Name of the Nodebuilder Compiler Configuration structure to use as the default settings for the compiler that is used when saving the map. The user can still change this in the <a href="w_gameconfigurations.html">Game Configurations window</a>.<br />
<br />
<b class="fat">defaulttestcompiler</b> (string)<br />
Name of the Nodebuilder Compiler Configuration structure to use as the default settings for the compiler that is used when testing the map. The user can still change this in the <a href="w_gameconfigurations.html">Game Configurations window</a>.<br />
<br />
<b class="fat">skills</b> (structure)<br />
This defines the skill options the user has available with this game engine/project. The settings in this structure are expected to be numbers with string values (the descriptive name for the skill level).<br />
<br />
Example:
<pre>
skills
{
1 = "I'm too young to die";
2 = "Hey, not too rough";
3 = "Hurt me plenty";
4 = "Ultra-Violence";
5 = "Nightmare!";
}
</pre>
<br />
<b class="fat">linetagindicatesectors</b> (boolean)<br />
When <b>true</b>, Doom Builder will highlight sectors associated with the same tag number when a line is highlighted. This is only really useful for Doom format maps, because Hexen format and UDMF format has no single tag on linedefs (in those formats, the arguments of the linedef's action can be tags, which also works to highlight sectors). The default is <b>false</b>.<br />
<br />
<b class="fat">soundlinedefflag</b> (integer or string)<br />
This lets Doom Builder know the <a href="gc_linedefflags.html">linedef flag</a> that indicates where sound should be blocked. Doom Builder uses this to give the line a special color and plugins can use this information to perform operations related to blocking sound lines. For map formats that use numeric flags (Doom and Hexen) this must be an integer specifying the flag value of the Block Sound flag. For map formats that use named flags (UDMF), this must be a string indicating the name of the Block Sound flag.<br />
<br />
<b class="fat">singlesidedflag</b> (integer or string)<br />
This lets Doom Builder know the <a href="gc_linedefflags.html">linedef flag</a> that indicates a line with only one side. Doom Builder will set this flag value on a linedef when it changes a line to become single sided and removes the flag from a linedef when it becomes double sided. Plugins can also use this information to perform operations on linedefs. For map formats that use numeric flags (Doom and Hexen) this must be an integer flag value. For map formats that use named flags (UDMF), this must be a string indicating the name of the flag.<br />
<br />
<b class="fat">doublesidedflag</b> (integer or string)<br />
This lets Doom Builder know the <a href="gc_linedefflags.html">linedef flag</a> that indicates a line with two sides. Doom Builder will set this flag value on a linedef when it changes a line to become double sided and removes the flag from a linedef when it becomes single sided. Plugins can also use this information to perform operations on linedefs. For map formats that use numeric flags (Doom and Hexen) this must be an integer flag value. For map formats that use named flags (UDMF), this must be a string indicating the name of the flag.<br />
<br />
<b class="fat">impassableflag</b> (integer or string)<br />
This lets Doom Builder know the <a href="gc_linedefflags.html">linedef flag</a> that indicates a line which blocks players and monsters. Doom Builder uses this to give the line a special color and plugins can use this information to perform operations related to blocking sound lines. For map formats that use numeric flags (Doom and Hexen) this must be an integer specifying the flag value of the Impassable flag. For map formats that use named flags (UDMF), this must be a string indicating the name of the Impassable flag.<br />
<br />
<b class="fat">makedoortrack</b> (string)<br />
Name of a texture to use on the walls when making a door.<br />
<br />
<b class="fat">makedooraction</b> (integer)<br />
Linedef action number to put on the lines when making a door.<br />
<br />
<b class="fat">makedoorarg#</b> (0 .. 4) (integer)<br />
Arguments for the linedef action number to put on the lines when making a door.<br />
<br />
<b class="fat">generalizedlinedefs</b>(boolean)<br />
Set to <b>true</b> to support generalized linedef actions. This makes the gen_linedeftypes structure mandatory. Default value is <b>false</b>.<br />
<br />
<b class="fat">generalizedsectors</b> (boolean)<br />
Set to <b>true</b> to support generalized sector effects. This makes the gen_sectortypes structure mandatory. Default value is <b>false</b>.<br />
<br />
<b class="fat">doomlightlevels</b> (boolean)<br />
Set this to <b>false</b> to use linear lighting in Doom Builder. Normally Doom Builder uses a simulation of Doom's light levels. Default value is <b>true</b>.<br />
<br />
<b class="fat">start3dmode</b> (integer)<br />
Thing type number that Doom Builder will use to keep your Visual Mode camera position stored in the map. Doom Builder will place a single thing of this type in your map and move it along as you move in Visual Mode.<br />
<br />
<b class="fat">skyflatname</b> (string)<br />
Name of the flat that is interpreted as sky (meaning there is no ceiling). Doom Builder and plugins can use this information for various purposes.<br />
<br />
<b class="fat">maxtexturenamelength</b> (integer)<br />
Maximum length of texture names in characters. This is used by Doom Builder to limit the input fields in the user interface and to check the validity of texture names in resources. This does NOT determine the actual limitation on the texture names in the map file format. Default value is 8.<br />
<br />
<b class="fat">defaultthingflags</b> (structure)<br />
This defines what the default flags should be first the first new thing when inserted. In map formats that use numeric thing flags, the settings in this structure should be the numeric flags to set. In map formats that use named flags, the settings must be the names of the flags to set. The value of the settings is optional and is ignored by Doom Builder.<br />
<br />
Example for numeric flags:
<pre>
defaultthingflags
{
1;
2;
4;
32;
}
</pre>
<br />
Example for named flags:
<pre>
defaultthingflags
{
skill1;
skill2;
skill3;
single;
coop;
}
</pre>
<br />
</p>
</div>
</body>

163
Help/gc_formatsettings.html Normal file
View file

@ -0,0 +1,163 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<title>Game Configuration - Map Format Settings</title>
<meta http-equiv="content-type" content="text/html; charset=iso-8859-1" />
<link rel="stylesheet" type="text/css" href="default.css" media="screen" title="Default" />
</head>
<body>
<object type="application/x-oleobject" classid="clsid:1e2a7bd0-dab9-11d0-b93a-00c04fc99f9e">
<param name="keyword" value="Configurations">
<param name="keyword" value="Game Configurations">
</object>
<div id="title"><h1>Game Configuration - Map Format Settings</h1></div>
<div id="contents">
<p>
<b class="fat">formatinterface</b> (string)<br />
Interface class name in Doom Builder that is used to read and write the map data.
<ul>
<li>For Doom map format, use "DoomMapSetIO". This is a map format that uses numeric flags.
<li>For Hexen map format, use "HexenMapSetIO". This is a map format that uses numeric flags.
<li>For UDMF map format, use "UniversalMapSetIO". This is a map format that uses named flags.
</ul>
<br />
<b class="fat">gamedetect</b> (structure)<br />
This is used to determine if the Game Configuration is suitable for the opened WAD file. None of the settings in this structure have any impact on the actual editing, limitations or storage of the map, but only assist the user when opening WAD files that have not been opened with Doom Builder before (when no .dbs file is available). The setting names in this structure are the lump names that must be checked for. The value of these settings (integers) indicates which rule applies to the lump name for a positive check. Valid values are:
<ul>
<li><b>1</b> - At least one of these lumps must exist.
<li><b>2</b> - None of these lumps must exist.
<li><b>3</b> - All of these lumps must exist.
</ul>
Example:<br />
<pre>
gamedetect
{
TEXTMAP = 2;
ENDMAP = 2;
EXTENDED = 2;
BEHAVIOR = 3;
E1M1 = 2;
E1M2 = 2;
E1M3 = 2;
MAP01 = 1;
MAP02 = 1;
MAP03 = 1;
}
</pre>
<br />
<b class="fat">maplumpnames</b> (structure)<br />
This structure describes the lumps that make up the complete map, including scripts and nodes. It must also indicate what Doom Builder is supposed to do with these lumps and/or where the lumps come from. These lumps are normally written by the map format interface class, but some could be generated by the nodebuilder compiler or stored by Doom Builder directly. In this structure, there should be a structure for every map lump. The name of the structure should be the lump name, in uppercase. For the map header (which name differs) you can use the name <b>~MAP</b>. The following settings should be in the lump structure (unless the default value applies):<br />
<ul>
<li><b class="fat">required</b> (boolean).<br />
<b>True</b> to indicate that this lump is a required lump for the map. Default is <b>false</b>.<br />
<br />
<li><b class="fat">blindcopy</b> (boolean).<br />
Set this to <b>true</b> when Doom Builder should copy this lump along with the map without using it. Default is <b>false</b>.<br />
<br />
<li><b class="fat">nodebuild</b> (boolean).<br />
When set to <b>true</b>, this indicates that the nodebuilder compiler generates or modifies this lump. Default is <b>false</b>.<br />
<br />
<li><b class="fat">allowempty</b> (boolean).<br />
Set to <b>true</b> to allow the nodebuilder to leave this lump empty. Default is <b>false</b>.<br />
<br />
<li><b class="fat">script</b> (string).<br />
When this is set, it indicates that this lump can be edited with the script editor. The contents of this lump will be loaded in the script editor automatically. Set the value to the .cfg filename (without path) of a Script Configuration to use.<br />
</ul>
Example:<br />
<pre>
maplumpnames
{
~MAP
{
required = true;
blindcopy = true;
nodebuild = false;
}
THINGS
{
required = true;
nodebuild = true;
allowempty = true;
}
LINEDEFS
{
required = true;
nodebuild = true;
allowempty = false;
}
SIDEDEFS
{
required = true;
nodebuild = true;
allowempty = false;
}
VERTEXES
{
required = true;
nodebuild = true;
allowempty = false;
}
SEGS
{
required = false;
nodebuild = true;
allowempty = false;
}
SSECTORS
{
required = false;
nodebuild = true;
allowempty = false;
}
NODES
{
required = false;
nodebuild = true;
allowempty = false;
}
SECTORS
{
required = true;
nodebuild = true;
allowempty = false;
}
REJECT
{
required = false;
nodebuild = true;
allowempty = false;
}
BLOCKMAP
{
required = false;
nodebuild = true;
allowempty = false;
}
SCRIPTS
{
required = false;
nodebuild = false;
script = "ZDoom_ACS.cfg";
}
}
</pre>
<br />
</p>
</div>
</body>

126
Help/gc_resourcesettings.html Normal file
View file

@ -0,0 +1,126 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<title>Game Configuration - Resource Settings</title>
<meta http-equiv="content-type" content="text/html; charset=iso-8859-1" />
<link rel="stylesheet" type="text/css" href="default.css" media="screen" title="Default" />
</head>
<body>
<object type="application/x-oleobject" classid="clsid:1e2a7bd0-dab9-11d0-b93a-00c04fc99f9e">
<param name="keyword" value="Configurations">
<param name="keyword" value="Game Configurations">
</object>
<div id="title"><h1>Game Configuration - Resource Settings</h1></div>
<div id="contents">
<p>
<b class="fat">decorategames</b> (string)<br />
Fill this to the game names to support DECORATE actors from. Only the DECORATE actors who's game name is in this string will be loaded. If this setting is not set, DECORATE lumps are not loaded.<br />
<br />
Example:
<pre>
decorategames = "heretic raven";
</pre>
<br />
<b class="fat">mixtexturesflats</b> (boolean)<br />
Doom Builder will allow the use of flats on walls and textures on floors when this is set to <b>true</b>. Textures and flats will be mixed with priority to the original purpose. For textures this means that textures override flats with the same name, for flats this means that flats override textures with the same name. Default is <b>false</b>.<br />
<br />
<b class="fat">defaulttexturescale</b> (decimal)<br />
The scale of textures when no scale is known. This is a scalar value: 0.5 is half the original size and double the resolution. Default is 1.0.<br />
<br />
<b class="fat">defaultflatscale</b> (decimal)<br />
The scale of flats when no scale is known. This is a scalar value: 0.5 is half the original size and double the resolution. Default is 1.0.<br />
<br />
<b class="fat">scaledtextureoffsets</b> (boolean)<br />
Determines if texture offsets are in world coordinates (unscaled by texture scale) or texture coordinates. Set to <b>true</b> to use texture coordinates. Default is <b>false</b>.<br />
<br />
<b class="fat">textures</b> (structure)<br />
This lists the marker lump names that indicate the begin and end of a list of textures that Doom Builder should load. There must be a separate structure for each range, for which the structure name doesn't matter. The range must have a 'start' setting and an 'end' setting of which the values must be the names of the start and end lumps (strings). Please note that PNAMES, TEXTURE1 and TEXTURE2 lumps do not need to be in the game configuration, they are always loaded when available.<br />
<br />
Example:
<pre>
textures
{
zdoom1
{
start = "TX_START";
end = "TX_END";
}
}
</pre>
<br />
<b class="fat">patches</b> (structure)<br />
This lists the marker lump names that indicate the begin and end of a list of patches that Doom Builder should load. There must be a separate structure for each range, for which the structure name doesn't matter. The range must have a 'start' setting and an 'end' setting of which the values must be the names of the start and end lumps (strings). Note that Doom Builder does not load all patches, only those that are used by the textures.<br />
<br />
Example:
<pre>
patches
{
standard1
{
start = "P_START";
end = "P_END";
}
standard2
{
start = "PP_START";
end = "PP_END";
}
}
</pre>
<br />
<b class="fat">sprites</b> (structure)<br />
This lists the marker lump names that indicate the begin and end of a list of sprites that Doom Builder should load. There must be a separate structure for each range, for which the structure name doesn't matter. The range must have a 'start' setting and an 'end' setting of which the values must be the names of the start and end lumps (strings). Note that Doom Builder does not load all sprites, only those that are used by the <a href="gc_thingsettings.cfg">things</a>.<br />
<br />
Example:
<pre>
sprites
{
standard1
{
start = "S_START";
end = "S_END";
}
}
</pre>
<br />
<b class="fat">flats</b> (structure)<br />
This lists the marker lump names that indicate the begin and end of a list of flats that Doom Builder should load. There must be a separate structure for each range, for which the structure name doesn't matter. The range must have a 'start' setting and an 'end' setting of which the values must be the names of the start and end lumps (strings).<br />
<br />
Example:
<pre>
flats
{
standard1
{
start = "F_START";
end = "F_END";
}
}
</pre>
<br />
<b class="fat">colormaps</b> (structure)<br />
This lists the marker lump names that indicate the begin and end of a list of colormaps that Doom Builder should load. There must be a separate structure for each range, for which the structure name doesn't matter. The range must have a 'start' setting and an 'end' setting of which the values must be the names of the start and end lumps (strings).<br />
<br />
Example:
<pre>
colormaps
{
standard1
{
start = "C_START";
end = "C_END";
}
}
</pre>
<br />
</p>
</div>
</body>