EDukeWiki - User contributions [en]

Talk:DEF Language

2009-05-08T11:19:51Z

One:

==from source==

This seems to be missing the palmap definitions: (defineconv, {bluepal, brownpal, greypal, greenpal, redpal, specpal}), among other things. -[[User:Hendricks 266|Hendricks266]] 17:31, 7 May 2009 (PDT)

typedef struct { char *text; int32_t tokenid; } tokenlist;
static tokenlist basetokens[] =
{
{ "include", T_INCLUDE },
{ "#include", T_INCLUDE },
{ "define", T_DEFINE },
{ "#define", T_DEFINE },

// deprecated style
{ "definetexture", T_DEFINETEXTURE },
{ "defineskybox", T_DEFINESKYBOX },
{ "definetint", T_DEFINETINT },
{ "definemodel", T_DEFINEMODEL },
{ "definemodelframe",T_DEFINEMODELFRAME },
{ "definemodelanim", T_DEFINEMODELANIM },
{ "definemodelskin", T_DEFINEMODELSKIN },
{ "selectmodelskin", T_SELECTMODELSKIN },
{ "definevoxel", T_DEFINEVOXEL },
{ "definevoxeltiles",T_DEFINEVOXELTILES },

// new style

{ "model", T_MODEL },
{ "voxel", T_VOXEL },
{ "skybox", T_SKYBOX },
{ "tint", T_TINT },
{ "texture", T_TEXTURE },
{ "tile", T_TEXTURE },
{ "music", T_MUSIC },
{ "sound", T_SOUND },

// other stuff
{ "undefmodel", T_UNDEFMODEL },
{ "undefmodelrange", T_UNDEFMODELRANGE },
{ "undefmodelof", T_UNDEFMODELOF },
{ "undeftexture", T_UNDEFTEXTURE },
{ "undeftexturerange", T_UNDEFTEXTURERANGE },
{ "alphahack", T_ALPHAHACK },
{ "alphahackrange", T_ALPHAHACKRANGE },
{ "spritecol", T_SPRITECOL },
{ "2dcol", T_2DCOL },
{ "fogpal", T_FOGPAL },
{ "loadgrp", T_LOADGRP },
{ "dummytile", T_DUMMYTILE },
{ "dummytilerange", T_DUMMYTILERANGE },
{ "setuptile", T_SETUPTILE },
{ "setuptilerange", T_SETUPTILERANGE },
{ "animtilerange", T_ANIMTILERANGE },
{ "cachesize", T_CACHESIZE },
{ "dummytilefrompic",T_IMPORTTILE },
{ "tilefromtexture", T_TILEFROMTEXTURE },
};

static tokenlist modeltokens[] =
{
{ "scale", T_SCALE },
{ "shade", T_SHADE },
{ "zadd", T_ZADD },
{ "frame", T_FRAME },
{ "anim", T_ANIM },
{ "skin", T_SKIN },
{ "detail", T_DETAIL },
{ "glow", T_GLOW },
{ "specular", T_SPECULAR },
{ "normal", T_NORMAL },
{ "hud", T_HUD },
{ "flags", T_FLAGS },
};

static tokenlist modelframetokens[] =
{
{ "pal", T_PAL },
{ "frame", T_FRAME },
{ "name", T_FRAME },
{ "tile", T_TILE },
{ "tile0", T_TILE0 },
{ "tile1", T_TILE1 },
{ "smoothduration", T_SMOOTHDURATION },
};

static tokenlist modelanimtokens[] =
{
{ "frame0", T_FRAME0 },
{ "frame1", T_FRAME1 },
{ "fps", T_FPS },
{ "flags", T_FLAGS },
};

static tokenlist modelskintokens[] =
{
{ "pal", T_PAL },
{ "file", T_FILE },
{ "surf", T_SURF },
{ "surface", T_SURF },
{ "intensity", T_PARAM },
{ "scale", T_PARAM },
{ "detailscale", T_PARAM },
{ "specpower", T_SPECPOWER },
{ "specfactor", T_SPECFACTOR },
};

static tokenlist modelhudtokens[] =
{
{ "tile", T_TILE },
{ "tile0", T_TILE0 },
{ "tile1", T_TILE1 },
{ "xadd", T_XADD },
{ "yadd", T_YADD },
{ "zadd", T_ZADD },
{ "angadd", T_ANGADD },
{ "hide", T_HIDE },
{ "nobob", T_NOBOB },
{ "flipped",T_FLIPPED},
{ "nodepth",T_NODEPTH},
};

static tokenlist voxeltokens[] =
{
{ "tile", T_TILE },
{ "tile0", T_TILE0 },
{ "tile1", T_TILE1 },
{ "scale", T_SCALE },
};

static tokenlist skyboxtokens[] =
{
{ "tile" ,T_TILE },
{ "pal" ,T_PAL },
{ "ft" ,T_FRONT },{ "front" ,T_FRONT },{ "forward",T_FRONT },
{ "rt" ,T_RIGHT },{ "right" ,T_RIGHT },
{ "bk" ,T_BACK },{ "back" ,T_BACK },
{ "lf" ,T_LEFT },{ "left" ,T_LEFT },{ "lt" ,T_LEFT },
{ "up" ,T_TOP },{ "top" ,T_TOP },{ "ceiling",T_TOP },{ "ceil" ,T_TOP },
{ "dn" ,T_BOTTOM },{ "bottom" ,T_BOTTOM },{ "floor" ,T_BOTTOM },{ "down" ,T_BOTTOM }
};

static tokenlist tinttokens[] =
{
{ "pal", T_PAL },
{ "red", T_RED },{ "r", T_RED },
{ "green", T_GREEN },{ "g", T_GREEN },
{ "blue", T_BLUE },{ "b", T_BLUE },
{ "flags", T_FLAGS }
};

static tokenlist texturetokens[] =
{
{ "pal", T_PAL },
{ "detail", T_DETAIL },
{ "glow", T_GLOW },
{ "specular",T_SPECULAR },
{ "normal", T_NORMAL },
};

static tokenlist texturetokens_pal[] =
{
{ "file", T_FILE },{ "name", T_FILE },
{ "alphacut", T_ALPHACUT },
{ "detailscale", T_XSCALE }, { "scale", T_XSCALE }, { "xscale", T_XSCALE }, { "intensity", T_XSCALE },
{ "yscale", T_YSCALE },
{ "specpower", T_SPECPOWER }, { "parallaxscale", T_SPECPOWER },
{ "specfactor", T_SPECFACTOR }, { "parallaxbias", T_SPECFACTOR },
{ "nocompress", T_NOCOMPRESS },
{ "nodownsize", T_NODOWNSIZE },
};

static tokenlist sound_musictokens[] =
{
{ "id", T_ID },
{ "file", T_FILE },
};

static tokenlist tilefromtexturetokens[] =
{
{ "file", T_FILE },
{ "name", T_FILE },
{ "alphacut", T_ALPHACUT },
{ "xoffset", T_XOFFSET },
{ "xoff", T_XOFFSET },
{ "yoffset", T_YOFFSET },
{ "yoff", T_YOFFSET },
};
: Palmap support was dropped at some point and Polymer specification may not be finalized yet(it still can be changed). Apart from this, the page is up to date. --[[User:One|One]] 04:19, 8 May 2009 (PDT)

==cleanup==

This page needs some serious cleanup. First, we should get rid of all this EDuke32-native rubbish. Second, there's a lot of stuff that needs to be added, including palmaps by Hunter, normal maps, parallax maps, setuptile, tilefromtexture, (the animation tilefromtexture command), and many more things. The best place to look for a complete index is the source; I'm just not sure where. -[[User:Hendricks 266|Hendricks266]] 19:00, 4 May 2009 (PDT)

==old comments==
Maybe the commands should just be listed here with links to separate pages for each command(not subcommands). Got a bit to big this way I think.

/Parkar

JonoF has a list of the DEF commands [http://jonof.edgenetwork.org/index.php?p=jfbuild.def here], for additional reference.

Cheers, 
[[User:Hendricks 266|Hendricks266]] @ 12:22, 18 February 2007 (PST)

DEF Language

2009-05-05T16:39:27Z

One:

New to JFDuke3D\EDuke32 are DEF files. These parsed scripts allow redefinition of flat, Hightile textures, 3D models, miscellaneous settings, and, possibly, in the future, higher-quality sounds and music, and enhanced cutscenes.

Comments can be used by prefixing the text with a double forward-slash (C++ style), <code>//</code>, or surrounding the text with <code>/* (comment here) */</code> (C style).

<div class="floatleft">__TOC__</div>

== Definitions ==

=== texture ===

'''texture''' '''''<tilenum> { ... }'''''

Defines a Hightile texture to replace an ART-file tile. '''''<tilenum>''''' may be a number, or a defined label.

The brace-enclosed block may contain these instructions:

==== pal ====

'''pal''' '''''<palnum> { ... }'''''

Replaces the palette '''''<palnum>'''''. If a palette has no pal definition palette 0 definition will be used. Tint will not be used on palettes defined with this instruction.

The brace-enclosed block may contain these instructions:

===== file =====

'''file''' '''''<filename>''''' 
'''name''' '''''<filename>'''''

Defines which texture file to use. File may be any PNG, JPG, TGA, BMP, GIF or PCX file. This instruction must be supplied.

===== alphacut =====

'''alphacut''' '''''<cutoff-value>'''''

Sets the level of transparency at which a pixel in the texture is considered opaque. Pixels with more transparency than the cut-off are not drawn to the screen when rendered. The default setting is 0.32, which is just below the 33% transparency level of Build. If your texture has areas that are more transparent than the default, you can lower the cut-off level to preserve that detail.

===== nocompress =====

'''nocompress'''

Prevents the texture from being compressed using S3TC if texture compression is enabled.

===== nodownsize =====

'''nodownsize'''

Prevents the texture from being downsized.

===== scale =====

'''xscale''' '''''<value>''''' 
'''yscale''' '''''<value>'''''

Sets the scale of the hightile texture in relation to the original texture. A '''''<value>''''' of 1.0 makes it the same size, higher makes it cover more then the original tile and smaller makes it cover a smaller area. '''xscale'''(aka '''scale''', '''detailscale''', '''intensity''') sets the horizontal scale and '''yscale''' sets the vertical scale.

==== detail ====

'''detail''' '''''{ ... }'''''

Defines a [[Detail_mapping|detail texture]] for the texture. The brace-enclosed block may contain these instructions:

===== file =====

'''file''' '''''<filename>'''''

Specifies which detail texture file to use. File may be any PNG, JPG, TGA, BMP, GIF or PCX file. This instruction must be supplied.

===== scale =====

'''scale''' '''''<value>'''''

'''''<value>''''' is a positive floating-point value that'll determine how much your detail map should repeat on your diffuse map (if you want your detail map to repeat five times, use a 1/5 scale : 0.2).

==== glow ====

'''glow''' '''''{ ... }'''''

Defines a [[Glow_mapping|glow map]] for the texture. The brace-enclosed block may contain these instructions:

===== file =====

'''file''' '''''<filename>'''''

Specifies which glow map file to use. This instruction must be supplied.

=== tint ===

'''tint''' '''''{ ... }'''''

Defines a Hightile texture tint to simulate palette effects normally used on ART-file tiles. The brace-enclosed block may contain these instructions:

==== pal ====

'''pal''' '''''<palnum>'''''

The palette number the tint applies to.

==== color ====

'''red''' '''''<value>''''' 
'''green''' '''''<value>''''' 
'''blue''' '''''<value>''''' 
'''r''' '''''<value>''''' 
'''g''' '''''<value>''''' 
'''b''' '''''<value>'''''

Specifies a color component value, in the range of 0 to 255. Unspecified components are assumed to be 255 and any out of range values are clamped to the maximum or minimum as appropriate.

==== flags ====

'''flags''' '''''<flags>'''''

Specifies any special processing effects to use for the tint. The value of flags may be the sum of any of these values:

* 0 = no effects
* 1 = convert to greyscale
* 2 = invert colors

=== skybox ===

'''skybox''' '''''{ ... }'''''

Defines a skybox that overrides a parallaxing floor or ceiling in OpenGL Polymost rendering mode. The brace-enclosed block may contain these instructions:

==== tile ====

'''tile''' '''''<tilenum>'''''

Specifies the ART file tile to override.

==== pal ====

'''pal''' '''''<palnum>'''''

Specifies the palette number the skybox should happen for.

==== facename ====

'''facename''' '''''<filename>'''''

Defines a single face of the skybox where facename may be any of these keywords appropriate for the face in question:

Front Right Back Left Top Bottom
ft rt bk lf up dn
front right back left top bottom
forward lt ceiling floor
ceil down

'''NOTE:''' All six faces are required to be specified.

=== model ===

'''model''' '''''<filename> { ... }'''''

Defines a model to replace certain sprites in the game when running in OpenGL Polymost mode. '''''<filename>''''' is the model file in md2 or md3 format.

'''Note:''' md2 is considered deprecated.

The brace-enclosed block may contain these instructions:

==== scale ====

'''scale''' '''''<value>'''''

'''''<value>''''' is a (possibly fractional) value specifying a scaling factor for the model when it is rendered, eg. 1.5 for one-and-a-half times as big.

==== shade ====

'''shade''' '''''<shade-offset>'''''

'''''<shade-offset>''''' is an integer value specifying how much to bias the sprite's shade value by. A negative value for this makes the model brighter. Conversely, a positive value makes it darker.

==== zadd ====

'''zadd''' '''''<offset>'''''

'''''<offset>''''' is a (possibly fractional) value specifying a height offset for the model. Quake models are aligned in the center while Build models are aligned at the floor. Using this command will allow Build to use Quake models without modification to the MD2/3 file itself.

==== flags ====

'''flags''' '''''<flags>'''''

Specifies any special properties the model should have, the values of which should be added together to combine multiple options.
*0: default value
*1: Prevents the the model from being affected by the tints.

==== skin ====

'''skin''' '''''{ ... }'''''
Defines a skin to be used on the model for all frames declared after this command. The brace-enclosed block may contain these instructions:

===== pal =====

'''pal''' '''''<palnum>'''''

Specifies which palette this skin maps to.

===== surface =====

'''surface''' '''''<surfnum>'''''

Specifies which MD3 surface this skin should be applied to. This has no significance for MD2 models.

===== file =====

'''file''' '''''<filename>'''''

Specifies the texture file to use for the skin. File may be any PNG, JPG, TGA, BMP, GIF or PCX file

'''IMPORTANT:''' If your model exists in a subdirectory (ie. the model filename includes a path to the .md2/3) you will need to give the same path to filename if the skin is in the same directory.

==== anim ====

'''anim''' '''''{ ... }'''''

Defines an animation from a group of frames in the model. The brace-enclosed block may contain these instructions:

===== frame =====

'''frame0''' '''''<framename>''''' 
'''frame1''' '''''<framename>'''''

Specifies the names of the start ('''frame0''') and end ('''frame1''') frames of the animation.

===== fps =====

'''fps''' '''''<fps>'''''

Specifies the frame rate at which the animation should play. This value may be fractional.

===== flags =====

'''flags''' '''''<flags>'''''

Specifies any special properties the animation should have, the values of which should be added together to combine multiple options.

Valid options are:
* 0 = none (looping animation)
* 1 = one-shot (plays beginning to end once and stops on the last frame).

==== frame ====

'''frame''' '''''{ ... }'''''

Defines a range of ART-file tiles to correspond with the given frame/animation of the model. The brace-enclosed block may contain these instructions:

===== name =====

'''name''' '''''<framename>''''' 
'''frame''' '''''<framename>'''''

If '''''<framename>''''' is identical to the starting frame of an animation, the engine will play that animation, otherwise the replacement will be static. You can choose to use the '''frame''' or '''name''' versions of this instruction as both are identical.

===== tile =====

'''tile''' '''''<tilenum>''''' 
'''tile0''' '''''<tilenum>''''' 
'''tile1''' '''''<tilenum>'''''

Use the tile instruction to specify an ART-file tile which this model should replace. Use the '''tile0''' and '''tile1''' instructions together to specify a range of ART-file tiles. If you use '''tile0''', you must also have a '''tile1'''. You may not use the same instruction twice to specify multiple ranges.

===== smoothduration =====

'''smoothduration''' '''''<value>'''''

If smoothduration is non-zero switching from another animation to the one defined by that frame block will trigger an intermediary animation smoothing state of duration '''''<value>''''' seconds.

===== pal =====

'''pal''' '''''<value>'''''

Makes the model definition exclusive for the this pal. This allow to assign different models for different pal.

==== hud ====

'''hud''' '''''{ ... }'''''

Defines a range of ART-file tiles to use with a heads-up-display. The brace-enclosed block may contain these instructions:

===== tile =====

'''tile''' '''''<tilenum>''''' 
'''tile0''' '''''<tilenum>''''' 
'''tile1''' '''''<tilenum>'''''

'''tile0''' and '''tile1''' together specify a range of ART-file tiles which this model frame should replace when rendered as part of the HUD. You can specify individual tiles using a single tile command.

===== offset =====

'''xadd''' '''''<offset>''''' 
'''yadd''' '''''<offset>''''' 
'''zadd''' '''''<offset>''''' 
'''angadd''' '''''<offset>'''''

Use these offsets to fine-tune the location of the model placement. '''xadd''', '''yadd''', and '''zadd''' are position offsets relative to the viewer's orienation. You can use floating point values with them. '''angadd''' is a Build angle offset. (512 = 90 degrees, 1024 = 180 degrees, etc...).

===== hide =====

'''hide'''

Some weapons use multiple ART tiles for constructing the gun or animation. Use this option to hide parts that you don't need in your replacement.

===== nobob =====

'''nobob'''

By default, the HUD model offset is affected by the player bobbing offset when the player is walking. Use this option to disable that.

===== flipped =====

'''flipped'''

Use this option to apply the settings inside the hud block only if the object is normally rendered x-flipped (mirror image). Some weapons, such as the devastator, are rendered in 2 pieces, the left devastator is actually a mirror image of the right.

===== nodepth =====

'''nodepth'''

Use this to render a HUD model without the use of the depth buffer. Normally, you should avoid this. The one exception where this is useful is for the spinning nuke menu pointer because it should always be in front - and it just happens to be convex ... which is the one case that is safe with the depth buffer disabled … a rather fortunate coincidence. [[Image:Smile.gif]]

==== detail ====

'''detail''' '''''{ ... }'''''

Defines a [[Detail_mapping|detail texture]] for the model. The brace-enclosed block may contain these instructions:

===== file =====

'''file''' '''''<filename>'''''

Specifies which detail texture file to use. File may be any PNG, JPG, TGA, BMP, GIF or PCX file. This instruction must be supplied.

===== scale =====

'''scale''' '''''<value>'''''

'''''<value>''''' is a positive floating-point value that'll determine how much your detail map should repeat on your diffuse map (if you want your detail map to repeat five times, use a 1/5 scale : 0.2).

===== surface =====

'''surface''' '''''<surfnum>'''''

Specifies which MD3 surface this detail texture should be applied to. This has no significance for MD2 models.

==== glow ====

'''glow''' '''''{ ... }'''''

Defines a [[Glow_mapping|glow map]] for the model. The brace-enclosed block may contain these instructions:

===== file =====

'''file''' '''''<filename>'''''

Specifies which glow map file to use. This instruction must be supplied.

===== surface =====

'''surface''' '''''<surfnum>'''''

Specifies which MD3 surface this glow map should be applied to. This has no significance for MD2 models.

=== voxel ===

'''voxel''' '''''<filename> { ... }'''''

Defines a voxel to replace sprites. filename is the name of the .KVX file containing the voxel. The brace-enclosed block may contain these instructions:

==== tile ====

'''tile''' '''''<tilenum>''''' 
'''tile0''' '''''<tilenum>''''' 
'''tile1''' '''''<tilenum>'''''

Use these instructions to map tiles that should be rendered as a voxels. Use '''tile''' to map a single tile to be rendered as voxels and '''tile0''', '''tile1''' together define a range of tiles to be rendered as voxels. The '''tile0''' instruction should appear before the '''tile1''' instruction to define a correct range.

==== scale ====

'''scale''' '''''<value>'''''

'''''<value>''''' is a (possibly fractional) value specifying a scaling factor for the voxelmodel when it is rendered, eg. 1.5 for one-and-a-half times as big.

=== music ===

==== id ====

'''id''' '''''<value>'''''

'''''<value>''''' is "Intro", "Briefing", "Loading" or "ExLy"(where x-episode, y-level). 

==== file ====

'''file''' '''''<filename>'''''

Specifies which music file to use. File may be any MID or OGG(OpenAL is required) file.

=== sound ===

==== id ====

'''id''' '''''<value>'''''

Specifies the ID of sound. The ID can be found in DEFS.CON.

==== file ====

'''file''' '''''<filename>'''''

Specifies which music file to use. File may be any WAV,VOC,OGG(OpenAL is not required) file.

== Un-Definitions ==

The main use for these is for cases in which the .ART files are somewhat different, and you want to ensure compatibility for the new art without new textures or models. A good example of this is the [http://www.freewebtown.com/hendricks266/nwhrp.html Duke: Nuclear Winter HRP] by [[User:Hendricks 266|Hendricks266]]. (see undef.def)

=== undeftexture ===

'''undeftexture''' '''''<tile>'''''

This is for undefining Hightile textures.

==== undeftexturerange ====

'''undeftexturerange''' '''''<tile0> <tile1>'''''

Same as '''undeftexture''', but with a range of tiles.

=== undefmodel ===

'''undefmodel''' '''''<tile>'''''

This is for undefining 3D models.

==== undefmodelrange ====

'''undefmodelrange''' '''''<tile0> <tile1>'''''

Same as '''undefmodel''', but with a range of tiles.

==== undefmodelof ====

'''undefmodelof''' '''''<tile>'''''

Same as '''undefmodel''', but all the tiles grouped together within the same .DEF code block are un-defined.

Support of '''undefmodelof''' seems to be broken at this time. Using it in your .DEF files will result in crashing upon compiling.

== Misc ==

=== alphahack ===

'''alphahack''' '''''<tilenum> <value>'''''

'''alphahack''' is a deprecated command to improve alpha filtering of highres art of '''''<tilenum>'''''. '''''<value>''''' is always -1.

==== alphahackrange ====

'''alphahackrange''' '''''<tilenum1> <tilenum2> <value>'''''

Same as '''alphahack''', but with a range of tiles.

=== animtilerange ===

'''animtilerange''' '''''<tilenum1> <tilenum2> <speed value> <animation value>'''''

Animates hightile textures the same way as 8 bit art does. Hightile art needs to be defined first.

=== dummytile ===

'''dummytile''' '''''<tilenum> <x-dimension> <y-dimension>'''''

Used in DEF files to create a blank tile at location '''<''tilenum''>''' of the dimensions '''<''x-dimension''>''' and '''<''y-dimension''>'''. This allows the creation of placeholder tiles for use with definetexture\texture without having to edit .ART files.

==== dummytilerange ====

'''dummytilerange''' '''''<tilenum1> <tilenum2> <x-dimension> <y-dimension>'''''

Same as '''dummytile''', but with a range of tiles.

=== setuptile ===

'''setuptile''' '''''<tilenum> <x-dimension> <y-dimension> <x-offset> <y-offset>'''''

Used in DEF files to setup the properties which are applied to the highres replacement of the tile. This allows the creation of placeholder tiles for use with definetexture\texture without having to edit .ART files.
Unlike '''dummytile''' this command won't draw black squares and accepts the offsets.

==== setuptilerange ====

'''setuptilerange''' '''''<tilenum1> <tilenum2> <x-dimension> <y-dimension> <x-offset> <y-offset>'''''

Same as '''setuptile''', but with a range of tiles.

=== dummytilefrompic ===

'''dummytilefrompic''' '''''<tileID> <file>'''''

=== tilefromtexture ===

'''tilefromtexture''' '''''{ ... }'''''

==== file ====

'''file''' '''''<filename>''''' 
'''name''' '''''<filename>'''''

==== alphacut ====

'''alphacut''' '''''<value>'''''

==== xoffset ====

'''xoffset''' '''''<value>''''' 
'''xoff''' '''''<value>'''''

==== yoffset ====

'''yoffset''' '''''<value>''''' 
'''yoff''' '''''<value>'''''

=== include ===

'''include''' '''''<filename>''''' 
'''#include''' '''''<filename>'''''

Processes the script commands in '''''<filename>''''' at the point of the '''include''' call.

=== define ===

'''define''' '''''<label> <integer-value>''''' 
'''#define''' '''''<label> <integer-value>'''''

Declares '''''<label>''''' to represent the numeric value '''''<integer-value>'''''. '''''<integer-value>''''' can be a label, in which case the value of the label given is used.

'''NOTE:''' You may find it convenient to include DEFS.CON (for JFDuke3D) or NAMES.H to predefine many of the tile names in the art file.

=== loadgrp ===

'''loadgrp''' '''''<.GRP\.ZIP file>'''''

The DEF equivalent of the '''/g''' command line switch. '''loadgrp''' can only be used in the originating .DEF file; it is usually '''duke3d.def''' or the .DEF file specified by the '''/h''' command line switch.

=== noautload ===

'''noautload'''

Disables the autoload dir feature.

=== cachesize ===

'''cachesize''' '''''<size>'''''

Specifies the size of the cache in Kb.

=== fogpal ===

'''fogpal''' '''''<palette number> <red intensity> <green intensity> <blue intensity>'''''

'''fogpal''' defines a palette a sector-based fog effect. To use it, change the pal of your sector to the pal defined with '''fogpal'''.

Intensities range from 0-63. Palettes 26, 27, 28 and 29 are pre-defined for you as white, red, green and blue respectively. Sector visibility controls fog density.

== Mapster32 ==

=== 2dcol ===

'''2dcol''' '''''<colornum> <red> <green> <blue>'''''

'''2dcol''' is a definition of a color to be used in the 2D mode of [[Mapster32]], in conjunction with '''spritecol''' that works similarly to '''tint''' and '''definetint'''. '''''<colornum>''''' is a unique identifier, similar to [[define|defines]] and [[gamevar|gamevars]]. '''''<red>''''', '''''<green>''''', and '''''<blue>''''' are the RGB color values that are mixed together to get your custom color.

Certain low values are already hard-coded, and redefining them will change colors of the default layout. If you know the correct value, you can replace the default colors used for '''all''' the sprites. You truly have the power to customize Mapster32. Lime green 2D mode background, anyone?

=== spritecol ===

'''spritecol''' '''''<tilenum> <normalcolornum> <blockingcolornum>'''''

'''spritecol''' is a definition of the color a sprite will appear in 2D mode, instead of the standard sky blue and hot pink, or another special color (like yellow for hard-coded enemies or white for the [[Special_Sprite_Reference_Guide|special sprites]]). '''<''normalcolornum''>''' is the '''<''colornum''>''' of the '''2dcol''' definition of your color for the standard sprite color as defined by '''<''tilenum''>'''. The same goes for '''<''blockingcolornum''>''', except that this value is for when the sprite has the first bit of [[cstat]] set (1) (<code>[']+[B]</code> keys in [[Mapster32]]), which is the blocking flag.

=== spritehotkey ===

'''spritehotkey''' '''''<key> <spriteID>'''''

Pressing a key from 1 to 0 on the upper row before pressing S will make the inserted sprite's picnum change according to this definition.

=== tilegroup ===

'''tilegroup''' '''''<groupname> { ... }'''''

Defines group for tile tile selector(Press T in the tile seletor). Mapster32 loads TILES.CFG on startup.

==== tile ====

'''tile''' '''''<tilenum>''''' 
'''tilerange''' '''''<tilenum1> <tilenum2>''''' 
'''tiles''' '''''{ <tile1> <tile2> ... <tileN> }'''''

Adds tiles to the group. Names can be found in DEFS.CON.

==== hotkey ====

'''hotkey''' '''''<value>'''''

Specifies the hotkey for the group.

==== colors ====

'''colors''' '''''<value1> <value2>'''''

Colors are the colors for Blocking OFF and Blocking ON.

=== alphabet ===

'''alphabet''' '''''{ ... }'''''

Defines alphabet for the input text feature(Ctrl+T). Mapster32 loads TILES.CFG on startup.

==== map ====

'''map''' '''''<value> <tile>'''''

==== mapa ====

'''mapa''' '''''<string> <tile>'''''

==== maprange ====

'''maprange''' '''''<value1> <value2> <tile>'''''

==== maprangea ====

'''maprangea''' '''''<char1> <char2> <tile>'''''

==== offset ====

'''offset''' '''''<value> <offset>'''''

==== offseta ====

'''offseta''' '''''<string> <offset>'''''

== Deprecated Commands ==

=== definetexture ===

'''definetexture''' '''''<tile-number> <palette-number> <x-center> <y-center> <x-size> <y-size> <filename>'''''

Defines a Hightile texture to replace an ART-file picture. '''''<tile-number>''''' may be an number, or a defined label. Use a value of 0 for '''''<x-center>''''' and '''''<y-center>''''' and a value of -1 for '''''<x-size>''''' and '''''<y-size>''''' for now until these values are actually used. '''''<filename>''''' may be any PNG, JPG, TGA, BMP, GIF or PCX file.

=== definetint ===

'''definetint''' '''''<palette-number> <red> <green> <blue> <flags'''''

Defines a Hightile texture tint to simulate palette effects normally used on ART-file tiles. '''''<red>''''', '''''<green>''''', and '''''<blue>''''' are numbers in the range 0 to 255 which specify the color the tint should look like. '''''<flags>''''' specifies any processing effects to use. Valid values are:
* 0 = no effects
* 1 = convert to greyscale
* 2 = invert colours
These values can be added together to produce a combination of effects.

=== defineskybox ===

'''defineskybox''' '''''<tile-number> <palette-number> <reserved> <front-face-filename> <right-face-filename> <back-face-filename> <left-face-filename> <top-face-filename> <bottom-face-filename>'''''

Defines a sky-box composed of six images mapped onto the faces
of a cube to be used when '''''<tile-number>''''' is set as parallaxing in GL Polymost mode. '''''<reserved>''''' should be 0 for now until its meaning is fully conceived.

=== definemodel ===

'''definemodel''' '''''<filename> <scale> <shade-offset>'''''

Defines an MD2/3-format model file to replace certain sprites in the game. See '''definemodelframe''' and '''definemodelanim''' for details on how to specify the ART-file tiles to replace. '''''<filename>''''' is the name of the MD2/3 model. '''''<scale>''''' is a (possibly fractional) value specifying a scaling factor for the model when it is rendered, eg. 1.5 for one-and-a-half times as big. '''''<shade-offset>''''' is an integer value specifying how much to bias the sprite's shade value by. A negative value for this makes the model brighter. Conversely, a positive value makes it darker.

==== definemodelskin ====

'''definemodelskin''' '''''<palette-number> <filename>'''''

Defines a skin to be used on the model for all frames declared after this command, when the sprite palette is equal to '''''<palette-number>'''''. (This makes more sense when given a demonstration.) '''IMPORTANT:''' If your model exists in a subdirectory (ie. '''definemodel''' includes a path to the .md2/3) you will need to give the same path to filename if the skin is in the same directory.

==== selectmodelskin ====

'''selectmodelskin''' '''''<skin ID>'''''

Selects a model skin.

==== definemodelanim ====

'''definemodelanim''' '''''<start-frame> <end-frame> <frame-rate> <flags>'''''

Defines an animation from a group of frames in the model given by the last preceding '''definemodel''' instruction. '''''<start-frame>''''' and '''''<end-frame>''''' specify the names of the starting and ending frames of the animation. '''''<frame-rate>''''' is the frame rate at which the animation should play. This value can be fractional. '''''<flags>''''' specifies any special properties the animation should have. Valid options are:

* 0 = none (looping animation)
* 1 = one-shot (plays beginning to end once and stops on the last frame)

==== definemodelframe ====

'''definemodelframe''' '''''<frame-name> <first-tile> <last-tile>'''''

Defines a range of ART-file tiles to correspond with the given frame of the model specified in the last preceding '''definemodel''' instruction. '''''<frame-name>''''' is the name of the frame, which if identical to the starting frame of a '''definemodelanim''' animation will play that animation. If '''''<frame-name>''''' is not corresponding with an animation, the replacement will be static. '''''<first-tile>''''' and '''''<last-tile>''''' specify a range of ART-file tiles which this model frame should replace.

=== definevoxel ===

'''definevoxel''' '''''<filename>'''''

Defines a voxel to replace sprites in the game. See '''definevoxeltiles''' for details on how to specify the ART-file tiles to replace. '''''<filename>''''' is the name of the .KVX file containing the voxel.

==== definevoxeltiles ====

'''definevoxeltiles''' '''''<first-tile> <last-tile>'''''

Defines the range of ART-file tiles to replace with the voxel given in the last preceding '''definevoxel''' instruction.

[[Category:All commands]]

DEF Language

2009-05-05T16:34:27Z

One:

New to JFDuke3D\EDuke32 are DEF files. These parsed scripts allow redefinition of flat, Hightile textures, 3D models, miscellaneous settings, and, possibly, in the future, higher-quality sounds and music, and enhanced cutscenes.

Comments can be used by prefixing the text with a double forward-slash (C++ style), <code>//</code>, or surrounding the text with <code>/* (comment here) */</code> (C style).

<div class="floatleft">__TOC__</div>

== Definitions ==

=== texture ===

'''texture''' '''''<tilenum> { ... }'''''

Defines a Hightile texture to replace an ART-file tile. '''''<tilenum>''''' may be a number, or a defined label.

The brace-enclosed block may contain these instructions:

==== pal ====

'''pal''' '''''<palnum> { ... }'''''

Replaces the palette '''''<palnum>'''''. If a palette has no pal definition palette 0 definition will be used. Tint will not be used on palettes defined with this instruction.

The brace-enclosed block may contain these instructions:

===== file =====

'''file''' '''''<filename>'''''

'''name''' '''''<filename>'''''

Defines which texture file to use. File may be any PNG, JPG, TGA, BMP, GIF or PCX file. This instruction must be supplied.

===== alphacut =====

'''alphacut''' '''''<cutoff-value>'''''

Sets the level of transparency at which a pixel in the texture is considered opaque. Pixels with more transparency than the cut-off are not drawn to the screen when rendered. The default setting is 0.32, which is just below the 33% transparency level of Build. If your texture has areas that are more transparent than the default, you can lower the cut-off level to preserve that detail.

===== nocompress =====

'''nocompress'''

Prevents the texture from being compressed using S3TC if texture compression is enabled.

===== nodownsize =====

'''nodownsize'''

Prevents the texture from being downsized.

===== scale =====

'''xscale''' '''''<value>'''''

'''yscale''' '''''<value>'''''

Sets the scale of the hightile texture in relation to the original texture. A '''''<value>''''' of 1.0 makes it the same size, higher makes it cover more then the original tile and smaller makes it cover a smaller area. '''xscale'''(aka '''scale''', '''detailscale''', '''intensity''') sets the horizontal scale and '''yscale''' sets the vertical scale.

==== detail ====

'''detail''' '''''{ ... }'''''

Defines a [[Detail_mapping|detail texture]] for the texture. The brace-enclosed block may contain these instructions:

===== file =====

'''file''' '''''<filename>'''''

Specifies which detail texture file to use. File may be any PNG, JPG, TGA, BMP, GIF or PCX file. This instruction must be supplied.

===== scale =====

'''scale''' '''''<value>'''''

'''''<value>''''' is a positive floating-point value that'll determine how much your detail map should repeat on your diffuse map (if you want your detail map to repeat five times, use a 1/5 scale : 0.2).

==== glow ====

'''glow''' '''''{ ... }'''''

Defines a [[Glow_mapping|glow map]] for the texture. The brace-enclosed block may contain these instructions:

===== file =====

'''file''' '''''<filename>'''''

Specifies which glow map file to use. This instruction must be supplied.

=== tint ===

'''tint''' '''''{ ... }'''''

Defines a Hightile texture tint to simulate palette effects normally used on ART-file tiles. The brace-enclosed block may contain these instructions:

==== pal ====

'''pal''' '''''<palnum>'''''

The palette number the tint applies to.

==== color ====

'''red''' '''''<value>''''' 
'''green''' '''''<value>''''' 
'''blue''' '''''<value>''''' 
'''r''' '''''<value>''''' 
'''g''' '''''<value>''''' 
'''b''' '''''<value>'''''

Specifies a color component value, in the range of 0 to 255. Unspecified components are assumed to be 255 and any out of range values are clamped to the maximum or minimum as appropriate.

==== flags ====

'''flags''' '''''<flags>'''''

Specifies any special processing effects to use for the tint. The value of flags may be the sum of any of these values:

* 0 = no effects
* 1 = convert to greyscale
* 2 = invert colors

=== skybox ===

'''skybox''' '''''{ ... }'''''

Defines a skybox that overrides a parallaxing floor or ceiling in OpenGL Polymost rendering mode. The brace-enclosed block may contain these instructions:

==== tile ====

'''tile''' '''''<tilenum>'''''

Specifies the ART file tile to override.

==== pal ====

'''pal''' '''''<palnum>'''''

Specifies the palette number the skybox should happen for.

==== facename ====

'''facename''' '''''<filename>'''''

Defines a single face of the skybox where facename may be any of these keywords appropriate for the face in question:

Front Right Back Left Top Bottom
ft rt bk lf up dn
front right back left top bottom
forward lt ceiling floor
ceil down

'''NOTE:''' All six faces are required to be specified.

=== model ===

'''model''' '''''<filename> { ... }'''''

Defines a model to replace certain sprites in the game when running in OpenGL Polymost mode. '''''<filename>''''' is the model file in md2 or md3 format.

'''Note:''' md2 is considered deprecated.

The brace-enclosed block may contain these instructions:

==== scale ====

'''scale''' '''''<value>'''''

'''''<value>''''' is a (possibly fractional) value specifying a scaling factor for the model when it is rendered, eg. 1.5 for one-and-a-half times as big.

==== shade ====

'''shade''' '''''<shade-offset>'''''

'''''<shade-offset>''''' is an integer value specifying how much to bias the sprite's shade value by. A negative value for this makes the model brighter. Conversely, a positive value makes it darker.

==== zadd ====

'''zadd''' '''''<offset>'''''

'''''<offset>''''' is a (possibly fractional) value specifying a height offset for the model. Quake models are aligned in the center while Build models are aligned at the floor. Using this command will allow Build to use Quake models without modification to the MD2/3 file itself.

==== flags ====

'''flags''' '''''<flags>'''''

Specifies any special properties the model should have, the values of which should be added together to combine multiple options.
*0: default value
*1: Prevents the the model from being affected by the tints.

==== skin ====

'''skin''' '''''{ ... }'''''
Defines a skin to be used on the model for all frames declared after this command. The brace-enclosed block may contain these instructions:

===== pal =====

'''pal''' '''''<palnum>'''''

Specifies which palette this skin maps to.

===== surface =====

'''surface''' '''''<surfnum>'''''

Specifies which MD3 surface this skin should be applied to. This has no significance for MD2 models.

===== file =====

'''file''' '''''<filename>'''''

Specifies the texture file to use for the skin. File may be any PNG, JPG, TGA, BMP, GIF or PCX file

'''IMPORTANT:''' If your model exists in a subdirectory (ie. the model filename includes a path to the .md2/3) you will need to give the same path to filename if the skin is in the same directory.

==== anim ====

'''anim''' '''''{ ... }'''''

Defines an animation from a group of frames in the model. The brace-enclosed block may contain these instructions:

===== frame =====

'''frame0''' '''''<framename>''''' 
'''frame1''' '''''<framename>'''''

Specifies the names of the start ('''frame0''') and end ('''frame1''') frames of the animation.

===== fps =====

'''fps''' '''''<fps>'''''

Specifies the frame rate at which the animation should play. This value may be fractional.

===== flags =====

'''flags''' '''''<flags>'''''

Specifies any special properties the animation should have, the values of which should be added together to combine multiple options.

Valid options are:
* 0 = none (looping animation)
* 1 = one-shot (plays beginning to end once and stops on the last frame).

==== frame ====

'''frame''' '''''{ ... }'''''

Defines a range of ART-file tiles to correspond with the given frame/animation of the model. The brace-enclosed block may contain these instructions:

===== name =====

'''name''' '''''<framename>''''' 
'''frame''' '''''<framename>'''''

If '''''<framename>''''' is identical to the starting frame of an animation, the engine will play that animation, otherwise the replacement will be static. You can choose to use the '''frame''' or '''name''' versions of this instruction as both are identical.

===== tile =====

'''tile''' '''''<tilenum>''''' 
'''tile0''' '''''<tilenum>''''' 
'''tile1''' '''''<tilenum>'''''

Use the tile instruction to specify an ART-file tile which this model should replace. Use the '''tile0''' and '''tile1''' instructions together to specify a range of ART-file tiles. If you use '''tile0''', you must also have a '''tile1'''. You may not use the same instruction twice to specify multiple ranges.

===== smoothduration =====

'''smoothduration''' '''''<value>'''''

If smoothduration is non-zero switching from another animation to the one defined by that frame block will trigger an intermediary animation smoothing state of duration '''''<value>''''' seconds.

===== pal =====

'''pal''' '''''<value>'''''

Makes the model definition exclusive for the this pal. This allow to assign different models for different pal.

==== hud ====

'''hud''' '''''{ ... }'''''

Defines a range of ART-file tiles to use with a heads-up-display. The brace-enclosed block may contain these instructions:

===== tile =====

'''tile''' '''''<tilenum>''''' 
'''tile0''' '''''<tilenum>''''' 
'''tile1''' '''''<tilenum>'''''

'''tile0''' and '''tile1''' together specify a range of ART-file tiles which this model frame should replace when rendered as part of the HUD. You can specify individual tiles using a single tile command.

===== offset =====

'''xadd''' '''''<offset>''''' 
'''yadd''' '''''<offset>''''' 
'''zadd''' '''''<offset>''''' 
'''angadd''' '''''<offset>'''''

Use these offsets to fine-tune the location of the model placement. '''xadd''', '''yadd''', and '''zadd''' are position offsets relative to the viewer's orienation. You can use floating point values with them. '''angadd''' is a Build angle offset. (512 = 90 degrees, 1024 = 180 degrees, etc...).

===== hide =====

'''hide'''

Some weapons use multiple ART tiles for constructing the gun or animation. Use this option to hide parts that you don't need in your replacement.

===== nobob =====

'''nobob'''

By default, the HUD model offset is affected by the player bobbing offset when the player is walking. Use this option to disable that.

===== flipped =====

'''flipped'''

Use this option to apply the settings inside the hud block only if the object is normally rendered x-flipped (mirror image). Some weapons, such as the devastator, are rendered in 2 pieces, the left devastator is actually a mirror image of the right.

===== nodepth =====

'''nodepth'''

Use this to render a HUD model without the use of the depth buffer. Normally, you should avoid this. The one exception where this is useful is for the spinning nuke menu pointer because it should always be in front - and it just happens to be convex ... which is the one case that is safe with the depth buffer disabled … a rather fortunate coincidence. [[Image:Smile.gif]]

==== detail ====

'''detail''' '''''{ ... }'''''

Defines a [[Detail_mapping|detail texture]] for the model. The brace-enclosed block may contain these instructions:

===== file =====

'''file''' '''''<filename>'''''

Specifies which detail texture file to use. File may be any PNG, JPG, TGA, BMP, GIF or PCX file. This instruction must be supplied.

===== scale =====

'''scale''' '''''<value>'''''

'''''<value>''''' is a positive floating-point value that'll determine how much your detail map should repeat on your diffuse map (if you want your detail map to repeat five times, use a 1/5 scale : 0.2).

===== surface =====

'''surface''' '''''<surfnum>'''''

Specifies which MD3 surface this detail texture should be applied to. This has no significance for MD2 models.

==== glow ====

'''glow''' '''''{ ... }'''''

Defines a [[Glow_mapping|glow map]] for the model. The brace-enclosed block may contain these instructions:

===== file =====

'''file''' '''''<filename>'''''

Specifies which glow map file to use. This instruction must be supplied.

===== surface =====

'''surface''' '''''<surfnum>'''''

Specifies which MD3 surface this glow map should be applied to. This has no significance for MD2 models.

=== voxel ===

'''voxel''' '''''<filename> { ... }'''''

Defines a voxel to replace sprites. filename is the name of the .KVX file containing the voxel. The brace-enclosed block may contain these instructions:

==== tile ====

'''tile''' '''''<tilenum>''''' 
'''tile0''' '''''<tilenum>''''' 
'''tile1''' '''''<tilenum>'''''

Use these instructions to map tiles that should be rendered as a voxels. Use '''tile''' to map a single tile to be rendered as voxels and '''tile0''', '''tile1''' together define a range of tiles to be rendered as voxels. The '''tile0''' instruction should appear before the '''tile1''' instruction to define a correct range.

==== scale ====

'''scale''' '''''<value>'''''

'''''<value>''''' is a (possibly fractional) value specifying a scaling factor for the voxelmodel when it is rendered, eg. 1.5 for one-and-a-half times as big.

=== music ===

==== id ====

'''id''' '''''<value>'''''

'''''<value>''''' is "Intro", "Briefing", "Loading" or "ExLy"(where x-episode, y-level). 

==== file ====

'''file''' '''''<filename>'''''

Specifies which music file to use. File may be any MID or OGG(OpenAL is required) file.

=== sound ===

==== id ====

'''id''' '''''<value>'''''

Specifies the ID of sound. The ID can be found in DEFS.CON.

==== file ====

'''file''' '''''<filename>'''''

Specifies which music file to use. File may be any WAV,VOC,OGG(OpenAL is not required) file.

== Un-Definitions ==

The main use for these is for cases in which the .ART files are somewhat different, and you want to ensure compatibility for the new art without new textures or models. A good example of this is the [http://www.freewebtown.com/hendricks266/nwhrp.html Duke: Nuclear Winter HRP] by [[User:Hendricks 266|Hendricks266]]. (see undef.def)

=== undeftexture ===

'''undeftexture''' '''''<tile>'''''

This is for undefining Hightile textures.

==== undeftexturerange ====

'''undeftexturerange''' '''''<tile0> <tile1>'''''

Same as '''undeftexture''', but with a range of tiles.

=== undefmodel ===

'''undefmodel''' '''''<tile>'''''

This is for undefining 3D models.

==== undefmodelrange ====

'''undefmodelrange''' '''''<tile0> <tile1>'''''

Same as '''undefmodel''', but with a range of tiles.

==== undefmodelof ====

'''undefmodelof''' '''''<tile>'''''

Same as '''undefmodel''', but all the tiles grouped together within the same .DEF code block are un-defined.

Support of '''undefmodelof''' seems to be broken at this time. Using it in your .DEF files will result in crashing upon compiling.

== Misc ==

=== alphahack ===

'''alphahack''' '''''<tilenum> <value>'''''

'''alphahack''' is a deprecated command to improve alpha filtering of highres art of '''''<tilenum>'''''. '''''<value>''''' is always -1.

==== alphahackrange ====

'''alphahackrange''' '''''<tilenum1> <tilenum2> <value>'''''

Same as '''alphahack''', but with a range of tiles.

=== animtilerange ===

'''animtilerange''' '''''<tilenum1> <tilenum2> <speed value> <animation value>'''''

Animates hightile textures the same way as 8 bit art does. Hightile art needs to be defined first.

=== dummytile ===

'''dummytile''' '''''<tilenum> <x-dimension> <y-dimension>'''''

Used in DEF files to create a blank tile at location '''<''tilenum''>''' of the dimensions '''<''x-dimension''>''' and '''<''y-dimension''>'''. This allows the creation of placeholder tiles for use with definetexture\texture without having to edit .ART files.

==== dummytilerange ====

'''dummytilerange''' '''''<tilenum1> <tilenum2> <x-dimension> <y-dimension>'''''

Same as '''dummytile''', but with a range of tiles.

=== setuptile ===

'''setuptile''' '''''<tilenum> <x-dimension> <y-dimension> <x-offset> <y-offset>'''''

Used in DEF files to setup the properties which are applied to the highres replacement of the tile. This allows the creation of placeholder tiles for use with definetexture\texture without having to edit .ART files.
Unlike '''dummytile''' this command won't draw black squares and accepts the offsets.

==== setuptilerange ====

'''setuptilerange''' '''''<tilenum1> <tilenum2> <x-dimension> <y-dimension> <x-offset> <y-offset>'''''

Same as '''setuptile''', but with a range of tiles.

=== dummytilefrompic ===

'''dummytilefrompic''' '''''<tileID> <file>'''''

=== tilefromtexture ===

'''tilefromtexture''' '''''{ ... }'''''

==== file ====

'''file''' '''''<filename>''''' 
'''name''' '''''<filename>'''''

==== alphacut ====

'''alphacut''' '''''<value>'''''

==== xoffset ====

'''xoffset''' '''''<value>''''' 
'''xoff''' '''''<value>'''''

==== yoffset ====

'''yoffset''' '''''<value>''''' 
'''yoff''' '''''<value>'''''

=== include ===

'''include''' '''''<filename>''''' 
'''#include''' '''''<filename>'''''

Processes the script commands in '''''<filename>''''' at the point of the '''include''' call.

=== define ===

'''define''' '''''<label> <integer-value>''''' 
'''#define''' '''''<label> <integer-value>'''''

Declares '''''<label>''''' to represent the numeric value '''''<integer-value>'''''. '''''<integer-value>''''' can be a label, in which case the value of the label given is used.

'''NOTE:''' You may find it convenient to include DEFS.CON (for JFDuke3D) or NAMES.H to predefine many of the tile names in the art file.

=== loadgrp ===

'''loadgrp''' '''''<.GRP\.ZIP file>'''''

The DEF equivalent of the '''/g''' command line switch. '''loadgrp''' can only be used in the originating .DEF file; it is usually '''duke3d.def''' or the .DEF file specified by the '''/h''' command line switch.

=== noautload ===

'''noautload'''

Disables the autoload dir feature.

=== cachesize ===

'''cachesize''' '''''<size>'''''

Specifies the size of the cache in Kb.

=== fogpal ===

'''fogpal''' '''''<palette number> <red intensity> <green intensity> <blue intensity>'''''

'''fogpal''' defines a palette a sector-based fog effect. To use it, change the pal of your sector to the pal defined with '''fogpal'''.

Intensities range from 0-63. Palettes 26, 27, 28 and 29 are pre-defined for you as white, red, green and blue respectively. Sector visibility controls fog density.

== Mapster32 ==

=== 2dcol ===

'''2dcol''' '''''<colornum> <red> <green> <blue>'''''

'''2dcol''' is a definition of a color to be used in the 2D mode of [[Mapster32]], in conjunction with '''spritecol''' that works similarly to '''tint''' and '''definetint'''. '''''<colornum>''''' is a unique identifier, similar to [[define|defines]] and [[gamevar|gamevars]]. '''''<red>''''', '''''<green>''''', and '''''<blue>''''' are the RGB color values that are mixed together to get your custom color.

Certain low values are already hard-coded, and redefining them will change colors of the default layout. If you know the correct value, you can replace the default colors used for '''all''' the sprites. You truly have the power to customize Mapster32. Lime green 2D mode background, anyone?

=== spritecol ===

'''spritecol''' '''''<tilenum> <normalcolornum> <blockingcolornum>'''''

'''spritecol''' is a definition of the color a sprite will appear in 2D mode, instead of the standard sky blue and hot pink, or another special color (like yellow for hard-coded enemies or white for the [[Special_Sprite_Reference_Guide|special sprites]]). '''<''normalcolornum''>''' is the '''<''colornum''>''' of the '''2dcol''' definition of your color for the standard sprite color as defined by '''<''tilenum''>'''. The same goes for '''<''blockingcolornum''>''', except that this value is for when the sprite has the first bit of [[cstat]] set (1) (<code>[']+[B]</code> keys in [[Mapster32]]), which is the blocking flag.

=== spritehotkey ===

'''spritehotkey''' '''''<key> <spriteID>'''''

Pressing a key from 1 to 0 on the upper row before pressing S will make the inserted sprite's picnum change according to this definition.

=== tilegroup ===

'''tilegroup''' '''''<groupname> { ... }'''''

Defines group for tile tile selector(Press T in the tile seletor). Mapster32 loads TILES.CFG on startup.

==== tile ====

'''tile''' '''''<tilenum>''''' 
'''tilerange''' '''''<tilenum1> <tilenum2>''''' 
'''tiles''' '''''{ <tile1> <tile2> ... <tileN> }'''''

Adds tiles to the group. Names can be found in DEFS.CON.

==== hotkey ====

'''hotkey''' '''''<value>'''''

Specifies the hotkey for the group.

==== colors ====

'''colors''' '''''<value1> <value2>'''''

Colors are the colors for Blocking OFF and Blocking ON.

=== alphabet ===

'''alphabet''' '''''{ ... }'''''

Defines alphabet for the input text feature(Ctrl+T). Mapster32 loads TILES.CFG on startup.

==== map ====

'''map''' '''''<value> <tile>'''''

==== mapa ====

'''mapa''' '''''<string> <tile>'''''

==== maprange ====

'''maprange''' '''''<value1> <value2> <tile>'''''

==== maprangea ====

'''maprangea''' '''''<char1> <char2> <tile>'''''

==== offset ====

'''offset''' '''''<value> <offset>'''''

==== offseta ====

'''offseta''' '''''<string> <offset>'''''

== Deprecated Commands ==

=== definetexture ===

'''definetexture''' '''''<tile-number> <palette-number> <x-center> <y-center> <x-size> <y-size> <filename>'''''

Defines a Hightile texture to replace an ART-file picture. '''''<tile-number>''''' may be an number, or a defined label. Use a value of 0 for '''''<x-center>''''' and '''''<y-center>''''' and a value of -1 for '''''<x-size>''''' and '''''<y-size>''''' for now until these values are actually used. '''''<filename>''''' may be any PNG, JPG, TGA, BMP, GIF or PCX file.

=== definetint ===

'''definetint''' '''''<palette-number> <red> <green> <blue> <flags'''''

Defines a Hightile texture tint to simulate palette effects normally used on ART-file tiles. '''''<red>''''', '''''<green>''''', and '''''<blue>''''' are numbers in the range 0 to 255 which specify the color the tint should look like. '''''<flags>''''' specifies any processing effects to use. Valid values are:
* 0 = no effects
* 1 = convert to greyscale
* 2 = invert colours
These values can be added together to produce a combination of effects.

=== defineskybox ===

'''defineskybox''' '''''<tile-number> <palette-number> <reserved> <front-face-filename> <right-face-filename> <back-face-filename> <left-face-filename> <top-face-filename> <bottom-face-filename>'''''

Defines a sky-box composed of six images mapped onto the faces
of a cube to be used when '''''<tile-number>''''' is set as parallaxing in GL Polymost mode. '''''<reserved>''''' should be 0 for now until its meaning is fully conceived.

=== definemodel ===

'''definemodel''' '''''<filename> <scale> <shade-offset>'''''

Defines an MD2/3-format model file to replace certain sprites in the game. See '''definemodelframe''' and '''definemodelanim''' for details on how to specify the ART-file tiles to replace. '''''<filename>''''' is the name of the MD2/3 model. '''''<scale>''''' is a (possibly fractional) value specifying a scaling factor for the model when it is rendered, eg. 1.5 for one-and-a-half times as big. '''''<shade-offset>''''' is an integer value specifying how much to bias the sprite's shade value by. A negative value for this makes the model brighter. Conversely, a positive value makes it darker.

==== definemodelskin ====

'''definemodelskin''' '''''<palette-number> <filename>'''''

Defines a skin to be used on the model for all frames declared after this command, when the sprite palette is equal to '''''<palette-number>'''''. (This makes more sense when given a demonstration.) '''IMPORTANT:''' If your model exists in a subdirectory (ie. '''definemodel''' includes a path to the .md2/3) you will need to give the same path to filename if the skin is in the same directory.

==== selectmodelskin ====

'''selectmodelskin''' '''''<skin ID>'''''

Selects a model skin.

==== definemodelanim ====

'''definemodelanim''' '''''<start-frame> <end-frame> <frame-rate> <flags>'''''

Defines an animation from a group of frames in the model given by the last preceding '''definemodel''' instruction. '''''<start-frame>''''' and '''''<end-frame>''''' specify the names of the starting and ending frames of the animation. '''''<frame-rate>''''' is the frame rate at which the animation should play. This value can be fractional. '''''<flags>''''' specifies any special properties the animation should have. Valid options are:

* 0 = none (looping animation)
* 1 = one-shot (plays beginning to end once and stops on the last frame)

==== definemodelframe ====

'''definemodelframe''' '''''<frame-name> <first-tile> <last-tile>'''''

Defines a range of ART-file tiles to correspond with the given frame of the model specified in the last preceding '''definemodel''' instruction. '''''<frame-name>''''' is the name of the frame, which if identical to the starting frame of a '''definemodelanim''' animation will play that animation. If '''''<frame-name>''''' is not corresponding with an animation, the replacement will be static. '''''<first-tile>''''' and '''''<last-tile>''''' specify a range of ART-file tiles which this model frame should replace.

=== definevoxel ===

'''definevoxel''' '''''<filename>'''''

Defines a voxel to replace sprites in the game. See '''definevoxeltiles''' for details on how to specify the ART-file tiles to replace. '''''<filename>''''' is the name of the .KVX file containing the voxel.

==== definevoxeltiles ====

'''definevoxeltiles''' '''''<first-tile> <last-tile>'''''

Defines the range of ART-file tiles to replace with the voxel given in the last preceding '''definevoxel''' instruction.

[[Category:All commands]]

DEF Language

2009-05-05T16:27:37Z

One: dummytilefrompic, tilefromtexture, alphabet are stubs

New to JFDuke3D\EDuke32 are DEF files. These parsed scripts allow redefinition of flat, Hightile textures, 3D models, miscellaneous settings, and, possibly, in the future, higher-quality sounds and music, and enhanced cutscenes.

Comments can be used by prefixing the text with a double forward-slash (C++ style), <code>//</code>, or surrounding the text with <code>/* (comment here) */</code> (C style).

<div class="floatleft">__TOC__</div>

== Definitions ==

=== texture ===

'''texture''' '''''<tilenum> { ... }'''''

Defines a Hightile texture to replace an ART-file tile. '''''<tilenum>''''' may be a number, or a defined label.

The brace-enclosed block may contain these instructions:

==== pal ====

'''pal''' '''''<palnum> { ... }'''''

Replaces the palette '''''<palnum>'''''. If a palette has no pal definition palette 0 definition will be used. Tint will not be used on palettes defined with this instruction.

The brace-enclosed block may contain these instructions:

===== file =====

'''file''' '''''<filename>'''''

'''name''' '''''<filename>'''''

Defines which texture file to use. File may be any PNG, JPG, TGA, BMP, GIF or PCX file. This instruction must be supplied.

===== alphacut =====

'''alphacut''' '''''<cutoff-value>'''''

Sets the level of transparency at which a pixel in the texture is considered opaque. Pixels with more transparency than the cut-off are not drawn to the screen when rendered. The default setting is 0.32, which is just below the 33% transparency level of Build. If your texture has areas that are more transparent than the default, you can lower the cut-off level to preserve that detail.

===== nocompress =====

'''nocompress'''

Prevents the texture from being compressed using S3TC if texture compression is enabled.

===== nodownsize =====

'''nodownsize'''

Prevents the texture from being downsized.

===== scale =====

'''xscale''' '''''<value>'''''

'''yscale''' '''''<value>'''''

Sets the scale of the hightile texture in relation to the original texture. A '''''<value>''''' of 1.0 makes it the same size, higher makes it cover more then the original tile and smaller makes it cover a smaller area. '''xscale'''(aka '''scale''', '''detailscale''', '''intensity''') sets the horizontal scale and '''yscale''' sets the vertical scale.

==== detail ====

'''detail''' '''''{ ... }'''''

Defines a [[Detail_mapping|detail texture]] for the texture. The brace-enclosed block may contain these instructions:

===== file =====

'''file''' '''''<filename>'''''

Specifies which detail texture file to use. File may be any PNG, JPG, TGA, BMP, GIF or PCX file. This instruction must be supplied.

===== scale =====

'''scale''' '''''<value>'''''

'''''<value>''''' is a positive floating-point value that'll determine how much your detail map should repeat on your diffuse map (if you want your detail map to repeat five times, use a 1/5 scale : 0.2).

==== glow ====

'''glow''' '''''{ ... }'''''

Defines a [[Glow_mapping|glow map]] for the texture. The brace-enclosed block may contain these instructions:

===== file =====

'''file''' '''''<filename>'''''

Specifies which glow map file to use. This instruction must be supplied.

=== tint ===

'''tint''' '''''{ ... }'''''

Defines a Hightile texture tint to simulate palette effects normally used on ART-file tiles. The brace-enclosed block may contain these instructions:

==== pal ====

'''pal''' '''''<palnum>'''''

The palette number the tint applies to.

==== color ====

'''red''' '''''<value>'''''

'''green''' '''''<value>'''''

'''blue''' '''''<value>'''''

'''r''' '''''<value>'''''

'''g''' '''''<value>'''''

'''b''' '''''<value>'''''

Specifies a color component value, in the range of 0 to 255. Unspecified components are assumed to be 255 and any out of range values are clamped to the maximum or minimum as appropriate.

==== flags ====

'''flags''' '''''<flags>'''''

Specifies any special processing effects to use for the tint. The value of flags may be the sum of any of these values:

* 0 = no effects
* 1 = convert to greyscale
* 2 = invert colors

=== skybox ===

'''skybox''' '''''{ ... }'''''

Defines a skybox that overrides a parallaxing floor or ceiling in OpenGL Polymost rendering mode. The brace-enclosed block may contain these instructions:

==== tile ====

'''tile''' '''''<tilenum>'''''

Specifies the ART file tile to override.

==== pal ====

'''pal''' '''''<palnum>'''''

Specifies the palette number the skybox should happen for.

==== facename ====

'''facename''' '''''<filename>'''''

Defines a single face of the skybox where facename may be any of these keywords appropriate for the face in question:

Front Right Back Left Top Bottom
ft rt bk lf up dn
front right back left top bottom
forward lt ceiling floor
ceil down

'''NOTE:''' All six faces are required to be specified.

=== model ===

'''model''' '''''<filename> { ... }'''''

Defines a model to replace certain sprites in the game when running in OpenGL Polymost mode. '''''<filename>''''' is the model file in md2 or md3 format.

'''Note:''' md2 is considered deprecated.

The brace-enclosed block may contain these instructions:

==== scale ====

'''scale''' '''''<value>'''''

'''''<value>''''' is a (possibly fractional) value specifying a scaling factor for the model when it is rendered, eg. 1.5 for one-and-a-half times as big.

==== shade ====

'''shade''' '''''<shade-offset>'''''

'''''<shade-offset>''''' is an integer value specifying how much to bias the sprite's shade value by. A negative value for this makes the model brighter. Conversely, a positive value makes it darker.

==== zadd ====

'''zadd''' '''''<offset>'''''

'''''<offset>''''' is a (possibly fractional) value specifying a height offset for the model. Quake models are aligned in the center while Build models are aligned at the floor. Using this command will allow Build to use Quake models without modification to the MD2/3 file itself.

==== flags ====

'''flags''' '''''<flags>'''''

Specifies any special properties the model should have, the values of which should be added together to combine multiple options.
*0: default value
*1: Prevents the the model from being affected by the tints.

==== skin ====

'''skin''' '''''{ ... }'''''
Defines a skin to be used on the model for all frames declared after this command. The brace-enclosed block may contain these instructions:

===== pal =====

'''pal''' '''''<palnum>'''''

Specifies which palette this skin maps to.

===== surface =====

'''surface''' '''''<surfnum>'''''

Specifies which MD3 surface this skin should be applied to. This has no significance for MD2 models.

===== file =====

'''file''' '''''<filename>'''''

Specifies the texture file to use for the skin. File may be any PNG, JPG, TGA, BMP, GIF or PCX file

'''IMPORTANT:''' If your model exists in a subdirectory (ie. the model filename includes a path to the .md2/3) you will need to give the same path to filename if the skin is in the same directory.

==== anim ====

'''anim''' '''''{ ... }'''''

Defines an animation from a group of frames in the model. The brace-enclosed block may contain these instructions:

===== frame =====

'''frame0''' '''''<framename>'''''

'''frame1''' '''''<framename>'''''

Specifies the names of the start ('''frame0''') and end ('''frame1''') frames of the animation.

===== fps =====

'''fps''' '''''<fps>'''''

Specifies the frame rate at which the animation should play. This value may be fractional.

===== flags =====

'''flags''' '''''<flags>'''''

Specifies any special properties the animation should have, the values of which should be added together to combine multiple options.

Valid options are:
* 0 = none (looping animation)
* 1 = one-shot (plays beginning to end once and stops on the last frame).

==== frame ====

'''frame''' '''''{ ... }'''''

Defines a range of ART-file tiles to correspond with the given frame/animation of the model. The brace-enclosed block may contain these instructions:

===== name =====

'''name''' '''''<framename>'''''

'''frame''' '''''<framename>'''''

If '''''<framename>''''' is identical to the starting frame of an animation, the engine will play that animation, otherwise the replacement will be static. You can choose to use the '''frame''' or '''name''' versions of this instruction as both are identical.

===== tile =====

'''tile''' '''''<tilenum>'''''

'''tile0''' '''''<tilenum>'''''

'''tile1''' '''''<tilenum>'''''

Use the tile instruction to specify an ART-file tile which this model should replace. Use the '''tile0''' and '''tile1''' instructions together to specify a range of ART-file tiles. If you use '''tile0''', you must also have a '''tile1'''. You may not use the same instruction twice to specify multiple ranges.

===== smoothduration =====

'''smoothduration''' '''''<value>'''''

If smoothduration is non-zero switching from another animation to the one defined by that frame block will trigger an intermediary animation smoothing state of duration '''''<value>''''' seconds.

===== pal =====

'''pal''' '''''<value>'''''

Makes the model definition exclusive for the this pal. This allow to assign different models for different pal.

==== hud ====

'''hud''' '''''{ ... }'''''

Defines a range of ART-file tiles to use with a heads-up-display. The brace-enclosed block may contain these instructions:

===== tile =====

'''tile''' '''''<tilenum>'''''

'''tile0''' '''''<tilenum>'''''

'''tile1''' '''''<tilenum>'''''

'''tile0''' and '''tile1''' together specify a range of ART-file tiles which this model frame should replace when rendered as part of the HUD. You can specify individual tiles using a single tile command.

===== offset =====

'''xadd''' '''''<offset>'''''

'''yadd''' '''''<offset>'''''

'''zadd''' '''''<offset>'''''

'''angadd''' '''''<offset>'''''

Use these offsets to fine-tune the location of the model placement. '''xadd''', '''yadd''', and '''zadd''' are position offsets relative to the viewer's orienation. You can use floating point values with them. '''angadd''' is a Build angle offset. (512 = 90 degrees, 1024 = 180 degrees, etc...).

===== hide =====

'''hide'''

Some weapons use multiple ART tiles for constructing the gun or animation. Use this option to hide parts that you don't need in your replacement.

===== nobob =====

'''nobob'''

By default, the HUD model offset is affected by the player bobbing offset when the player is walking. Use this option to disable that.

===== flipped =====

'''flipped'''

Use this option to apply the settings inside the hud block only if the object is normally rendered x-flipped (mirror image). Some weapons, such as the devastator, are rendered in 2 pieces, the left devastator is actually a mirror image of the right.

===== nodepth =====

'''nodepth'''

Use this to render a HUD model without the use of the depth buffer. Normally, you should avoid this. The one exception where this is useful is for the spinning nuke menu pointer because it should always be in front - and it just happens to be convex ... which is the one case that is safe with the depth buffer disabled … a rather fortunate coincidence. [[Image:Smile.gif]]

==== detail ====

'''detail''' '''''{ ... }'''''

Defines a [[Detail_mapping|detail texture]] for the model. The brace-enclosed block may contain these instructions:

===== file =====

'''file''' '''''<filename>'''''

Specifies which detail texture file to use. File may be any PNG, JPG, TGA, BMP, GIF or PCX file. This instruction must be supplied.

===== scale =====

'''scale''' '''''<value>'''''

'''''<value>''''' is a positive floating-point value that'll determine how much your detail map should repeat on your diffuse map (if you want your detail map to repeat five times, use a 1/5 scale : 0.2).

===== surface =====

'''surface''' '''''<surfnum>'''''

Specifies which MD3 surface this detail texture should be applied to. This has no significance for MD2 models.

==== glow ====

'''glow''' '''''{ ... }'''''

Defines a [[Glow_mapping|glow map]] for the model. The brace-enclosed block may contain these instructions:

===== file =====

'''file''' '''''<filename>'''''

Specifies which glow map file to use. This instruction must be supplied.

===== surface =====

'''surface''' '''''<surfnum>'''''

Specifies which MD3 surface this glow map should be applied to. This has no significance for MD2 models.

=== voxel ===

'''voxel''' '''''<filename> { ... }'''''

Defines a voxel to replace sprites. filename is the name of the .KVX file containing the voxel. The brace-enclosed block may contain these instructions:

==== tile ====

'''tile''' '''''<tilenum>'''''

'''tile0''' '''''<tilenum>'''''

'''tile1''' '''''<tilenum>'''''

Use these instructions to map tiles that should be rendered as a voxels. Use '''tile''' to map a single tile to be rendered as voxels and '''tile0''', '''tile1''' together define a range of tiles to be rendered as voxels. The '''tile0''' instruction should appear before the '''tile1''' instruction to define a correct range.

==== scale ====

'''scale''' '''''<value>'''''

'''''<value>''''' is a (possibly fractional) value specifying a scaling factor for the voxelmodel when it is rendered, eg. 1.5 for one-and-a-half times as big.

=== music ===

==== id ====

'''id''' '''''<value>'''''

'''''<value>''''' is "Intro", "Briefing", "Loading" or "ExLy"(where x-episode, y-level). 

==== file ====

'''file''' '''''<filename>'''''

Specifies which music file to use. File may be any MID or OGG(OpenAL is required) file.

=== sound ===

==== id ====

'''id''' '''''<value>'''''

Specifies the ID of sound. The ID can be found in DEFS.CON.

==== file ====

'''file''' '''''<filename>'''''

Specifies which music file to use. File may be any WAV,VOC,OGG(OpenAL is not required) file.

== Un-Definitions ==

The main use for these is for cases in which the .ART files are somewhat different, and you want to ensure compatibility for the new art without new textures or models. A good example of this is the [http://www.freewebtown.com/hendricks266/nwhrp.html Duke: Nuclear Winter HRP] by [[User:Hendricks 266|Hendricks266]]. (see undef.def)

=== undeftexture ===

'''undeftexture''' '''''<tile>'''''

This is for undefining Hightile textures.

==== undeftexturerange ====

'''undeftexturerange''' '''''<tile0> <tile1>'''''

Same as '''undeftexture''', but with a range of tiles.

=== undefmodel ===

'''undefmodel''' '''''<tile>'''''

This is for undefining 3D models.

==== undefmodelrange ====

'''undefmodelrange''' '''''<tile0> <tile1>'''''

Same as '''undefmodel''', but with a range of tiles.

==== undefmodelof ====

'''undefmodelof''' '''''<tile>'''''

Same as '''undefmodel''', but all the tiles grouped together within the same .DEF code block are un-defined.

Support of '''undefmodelof''' seems to be broken at this time. Using it in your .DEF files will result in crashing upon compiling.

== Misc ==

=== alphahack ===

'''alphahack''' '''''<tilenum> <value>'''''

'''alphahack''' is a deprecated command to improve alpha filtering of highres art of '''''<tilenum>'''''. '''''<value>''''' is always -1.

==== alphahackrange ====

'''alphahackrange''' '''''<tilenum1> <tilenum2> <value>'''''

Same as '''alphahack''', but with a range of tiles.

=== animtilerange ===

'''animtilerange''' '''''<tilenum1> <tilenum2> <speed value> <animation value>'''''

Animates hightile textures the same way as 8 bit art does. Hightile art needs to be defined first.

=== dummytile ===

'''dummytile''' '''''<tilenum> <x-dimension> <y-dimension>'''''

Used in DEF files to create a blank tile at location '''<''tilenum''>''' of the dimensions '''<''x-dimension''>''' and '''<''y-dimension''>'''. This allows the creation of placeholder tiles for use with definetexture\texture without having to edit .ART files.

==== dummytilerange ====

'''dummytilerange''' '''''<tilenum1> <tilenum2> <x-dimension> <y-dimension>'''''

Same as '''dummytile''', but with a range of tiles.

=== setuptile ===

'''setuptile''' '''''<tilenum> <x-dimension> <y-dimension> <x-offset> <y-offset>'''''

Used in DEF files to setup the properties which are applied to the highres replacement of the tile. This allows the creation of placeholder tiles for use with definetexture\texture without having to edit .ART files.
Unlike '''dummytile''' this command won't draw black squares and accepts the offsets.

==== setuptilerange ====

'''setuptilerange''' '''''<tilenum1> <tilenum2> <x-dimension> <y-dimension> <x-offset> <y-offset>'''''

Same as '''setuptile''', but with a range of tiles.

=== dummytilefrompic ===

'''dummytilefrompic''' '''''<tileID> <file>'''''

=== tilefromtexture ===

'''tilefromtexture''' '''''{ ... }'''''

==== file ====

'''file''' '''''<filename>''''' 
'''name''' '''''<filename>'''''

==== alphacut ====

'''alphacut''' '''''<value>'''''

==== xoffset ====

'''xoffset''' '''''<value>''''' 
'''xoff''' '''''<value>'''''

==== yoffset ====

'''yoffset''' '''''<value>''''' 
'''yoff''' '''''<value>'''''

=== include ===

'''include''' '''''<filename>'''''

'''#include''' '''''<filename>'''''

Processes the script commands in '''''<filename>''''' at the point of the '''include''' call.

=== define ===

'''define''' '''''<label> <integer-value>'''''

'''#define''' '''''<label> <integer-value>'''''

Declares '''''<label>''''' to represent the numeric value '''''<integer-value>'''''. '''''<integer-value>''''' can be a label, in which case the value of the label given is used.

'''NOTE:''' You may find it convenient to include DEFS.CON (for JFDuke3D) or NAMES.H to predefine many of the tile names in the art file.

=== loadgrp ===

'''loadgrp''' '''''<.GRP\.ZIP file>'''''

The DEF equivalent of the '''/g''' command line switch. '''loadgrp''' can only be used in the originating .DEF file; it is usually '''duke3d.def''' or the .DEF file specified by the '''/h''' command line switch.

=== noautload ===

'''noautload'''

Disables the autoload dir feature.

=== cachesize ===

'''cachesize''' '''''<size>'''''

Specifies the size of the cache in Kb.

=== fogpal ===

'''fogpal''' '''''<palette number> <red intensity> <green intensity> <blue intensity>'''''

'''fogpal''' defines a palette a sector-based fog effect. To use it, change the pal of your sector to the pal defined with '''fogpal'''.

Intensities range from 0-63. Palettes 26, 27, 28 and 29 are pre-defined for you as white, red, green and blue respectively. Sector visibility controls fog density.

== Mapster32 ==

=== 2dcol ===

'''2dcol''' '''''<colornum> <red> <green> <blue>'''''

'''2dcol''' is a definition of a color to be used in the 2D mode of [[Mapster32]], in conjunction with '''spritecol''' that works similarly to '''tint''' and '''definetint'''. '''''<colornum>''''' is a unique identifier, similar to [[define|defines]] and [[gamevar|gamevars]]. '''''<red>''''', '''''<green>''''', and '''''<blue>''''' are the RGB color values that are mixed together to get your custom color.

Certain low values are already hard-coded, and redefining them will change colors of the default layout. If you know the correct value, you can replace the default colors used for '''all''' the sprites. You truly have the power to customize Mapster32. Lime green 2D mode background, anyone?

=== spritecol ===

'''spritecol''' '''''<tilenum> <normalcolornum> <blockingcolornum>'''''

'''spritecol''' is a definition of the color a sprite will appear in 2D mode, instead of the standard sky blue and hot pink, or another special color (like yellow for hard-coded enemies or white for the [[Special_Sprite_Reference_Guide|special sprites]]). '''<''normalcolornum''>''' is the '''<''colornum''>''' of the '''2dcol''' definition of your color for the standard sprite color as defined by '''<''tilenum''>'''. The same goes for '''<''blockingcolornum''>''', except that this value is for when the sprite has the first bit of [[cstat]] set (1) (<code>[']+[B]</code> keys in [[Mapster32]]), which is the blocking flag.

=== spritehotkey ===

'''spritehotkey''' '''''<key> <spriteID>'''''

Pressing a key from 1 to 0 on the upper row before pressing S will make the inserted sprite's picnum change according to this definition.

=== tilegroup ===

'''tilegroup''' '''''<groupname> { ... }'''''

Defines group for tile tile selector(Press T in the tile seletor). Mapster32 loads TILES.CFG on startup.

==== tile ====

'''tile''' '''''<tilenum>''''' 
'''tilerange''' '''''<tilenum1> <tilenum2>''''' 
'''tiles''' '''''{ <tile1> <tile2> ... <tileN> }'''''

Adds tiles to the group. Names can be found in DEFS.CON.

==== hotkey ====

'''hotkey''' '''''<value>'''''

Specifies the hotkey for the group.

==== colors ====

'''colors''' '''''<value1> <value2>'''''

Colors are the colors for Blocking OFF and Blocking ON.

=== alphabet ===

'''alphabet''' '''''{ ... }'''''

Defines alphabet for the input text feature(Ctrl+T). Mapster32 loads TILES.CFG on startup.

==== map ====

'''map''' '''''<value> <tile>'''''

==== mapa ====

'''mapa''' '''''<string> <tile>'''''

==== maprange ====

'''maprange''' '''''<value1> <value2> <tile>'''''

==== maprangea ====

'''maprangea''' '''''<char1> <char2> <tile>'''''

==== offset ====

'''offset''' '''''<value> <offset>'''''

==== offseta ====

'''offseta''' '''''<string> <offset>'''''

== Deprecated Commands ==

=== definetexture ===

'''definetexture''' '''''<tile-number> <palette-number> <x-center> <y-center> <x-size> <y-size> <filename>'''''

Defines a Hightile texture to replace an ART-file picture. '''''<tile-number>''''' may be an number, or a defined label. Use a value of 0 for '''''<x-center>''''' and '''''<y-center>''''' and a value of -1 for '''''<x-size>''''' and '''''<y-size>''''' for now until these values are actually used. '''''<filename>''''' may be any PNG, JPG, TGA, BMP, GIF or PCX file.

=== definetint ===

'''definetint''' '''''<palette-number> <red> <green> <blue> <flags'''''

Defines a Hightile texture tint to simulate palette effects normally used on ART-file tiles. '''''<red>''''', '''''<green>''''', and '''''<blue>''''' are numbers in the range 0 to 255 which specify the color the tint should look like. '''''<flags>''''' specifies any processing effects to use. Valid values are:
* 0 = no effects
* 1 = convert to greyscale
* 2 = invert colours
These values can be added together to produce a combination of effects.

=== defineskybox ===
'''defineskybox''' '''''<tile-number> <palette-number> <reserved> <front-face-filename> <right-face-filename> <back-face-filename> <left-face-filename> <top-face-filename> <bottom-face-filename>'''''

Defines a sky-box composed of six images mapped onto the faces
of a cube to be used when '''''<tile-number>''''' is set as parallaxing in GL Polymost mode. '''''<reserved>''''' should be 0 for now until its meaning is fully conceived.

=== definemodel ===

'''definemodel''' '''''<filename> <scale> <shade-offset>'''''

Defines an MD2/3-format model file to replace certain sprites in the game. See '''definemodelframe''' and '''definemodelanim''' for details on how to specify the ART-file tiles to replace. '''''<filename>''''' is the name of the MD2/3 model. '''''<scale>''''' is a (possibly fractional) value specifying a scaling factor for the model when it is rendered, eg. 1.5 for one-and-a-half times as big. '''''<shade-offset>''''' is an integer value specifying how much to bias the sprite's shade value by. A negative value for this makes the model brighter. Conversely, a positive value makes it darker.

==== definemodelskin ====

'''definemodelskin''' '''''<palette-number> <filename>'''''

Defines a skin to be used on the model for all frames declared after this command, when the sprite palette is equal to '''''<palette-number>'''''. (This makes more sense when given a demonstration.) '''IMPORTANT:''' If your model exists in a subdirectory (ie. '''definemodel''' includes a path to the .md2/3) you will need to give the same path to filename if the skin is in the same directory.

==== selectmodelskin ====

'''selectmodelskin''' '''''<skin ID>'''''

Selects a model skin.

==== definemodelanim ====

'''definemodelanim''' '''''<start-frame> <end-frame> <frame-rate> <flags>'''''

Defines an animation from a group of frames in the model given by the last preceding '''definemodel''' instruction. '''''<start-frame>''''' and '''''<end-frame>''''' specify the names of the starting and ending frames of the animation. '''''<frame-rate>''''' is the frame rate at which the animation should play. This value can be fractional. '''''<flags>''''' specifies any special properties the animation should have. Valid options are:

* 0 = none (looping animation)
* 1 = one-shot (plays beginning to end once and stops on the last frame)

==== definemodelframe ====

'''definemodelframe''' '''''<frame-name> <first-tile> <last-tile>'''''

Defines a range of ART-file tiles to correspond with the given frame of the model specified in the last preceding '''definemodel''' instruction. '''''<frame-name>''''' is the name of the frame, which if identical to the starting frame of a '''definemodelanim''' animation will play that animation. If '''''<frame-name>''''' is not corresponding with an animation, the replacement will be static. '''''<first-tile>''''' and '''''<last-tile>''''' specify a range of ART-file tiles which this model frame should replace.

=== definevoxel ===

'''definevoxel''' '''''<filename>'''''

Defines a voxel to replace sprites in the game. See '''definevoxeltiles''' for details on how to specify the ART-file tiles to replace. '''''<filename>''''' is the name of the .KVX file containing the voxel.

==== definevoxeltiles ====

'''definevoxeltiles''' '''''<first-tile> <last-tile>'''''

Defines the range of ART-file tiles to replace with the voxel given in the last preceding '''definevoxel''' instruction.

[[Category:All commands]]

DEF Language

2009-05-05T15:09:21Z

One:

New to JFDuke3D\EDuke32 are DEF files. These parsed scripts allow redefinition of flat, Hightile textures, 3D models, miscellaneous settings, and, possibly, in the future, higher-quality sounds and music, and enhanced cutscenes.

Comments can be used by prefixing the text with a double forward-slash (C++ style), <code>//</code>, or surrounding the text with <code>/* (comment here) */</code> (C style).

<div class="floatleft">__TOC__</div>

== Definitions ==

=== texture ===

'''texture''' '''''<tilenum> { ... }'''''

Defines a Hightile texture to replace an ART-file tile. '''''<tilenum>''''' may be a number, or a defined label.

The brace-enclosed block may contain these instructions:

==== pal ====

'''pal''' '''''<palnum> { ... }'''''

Replaces the palette '''''<palnum>'''''. If a palette has no pal definition palette 0 definition will be used. Tint will not be used on palettes defined with this instruction.

The brace-enclosed block may contain these instructions:

===== file =====

'''file''' '''''<filename>'''''

'''name''' '''''<filename>'''''

Defines which texture file to use. File may be any PNG, JPG, TGA, BMP, GIF or PCX file. This instruction must be supplied.

===== alphacut =====

'''alphacut''' '''''<cutoff-value>'''''

Sets the level of transparency at which a pixel in the texture is considered opaque. Pixels with more transparency than the cut-off are not drawn to the screen when rendered. The default setting is 0.32, which is just below the 33% transparency level of Build. If your texture has areas that are more transparent than the default, you can lower the cut-off level to preserve that detail.

===== nocompress =====

'''nocompress'''

Prevents the texture from being compressed using S3TC if texture compression is enabled.

===== scale =====

'''xscale''' '''''<value>'''''

'''yscale''' '''''<value>'''''

Sets the scale of the hightile texture in relation to the original texture. A '''''<value>''''' of 1.0 makes it the same size, higher makes it cover more then the original tile and smaller makes it cover a smaller area. '''xscale''' sets the horizontal scale and '''yscale''' sets the vertical scale.

==== detail ====

'''detail''' '''''{ ... }'''''

Defines a [[Detail_mapping|detail texture]] for the texture. The brace-enclosed block may contain these instructions:

===== file =====

'''file''' '''''<filename>'''''

Specifies which detail texture file to use. File may be any PNG, JPG, TGA, BMP, GIF or PCX file. This instruction must be supplied.

===== scale =====

'''scale''' '''''<value>'''''

'''''<value>''''' is a positive floating-point value that'll determine how much your detail map should repeat on your diffuse map (if you want your detail map to repeat five times, use a 1/5 scale : 0.2).

==== glow ====

'''glow''' '''''{ ... }'''''

Defines a [[Glow_mapping|glow map]] for the texture. The brace-enclosed block may contain these instructions:

===== file =====

'''file''' '''''<filename>'''''

Specifies which glow map file to use. This instruction must be supplied.

=== tint ===

'''tint''' '''''{ ... }'''''

Defines a Hightile texture tint to simulate palette effects normally used on ART-file tiles. The brace-enclosed block may contain these instructions:

==== pal ====

'''pal''' '''''<palnum>'''''

The palette number the tint applies to.

==== color ====

'''red''' '''''<value>'''''

'''green''' '''''<value>'''''

'''blue''' '''''<value>'''''

'''r''' '''''<value>'''''

'''g''' '''''<value>'''''

'''b''' '''''<value>'''''

Specifies a color component value, in the range of 0 to 255. Unspecified components are assumed to be 255 and any out of range values are clamped to the maximum or minimum as appropriate.

==== flags ====

'''flags''' '''''<flags>'''''

Specifies any special processing effects to use for the tint. The value of flags may be the sum of any of these values:

* 0 = no effects
* 1 = convert to greyscale
* 2 = invert colors

=== skybox ===

'''skybox''' '''''{ ... }'''''

Defines a skybox that overrides a parallaxing floor or ceiling in OpenGL Polymost rendering mode. The brace-enclosed block may contain these instructions:

==== tile ====

'''tile''' '''''<tilenum>'''''

Specifies the ART file tile to override.

==== pal ====

'''pal''' '''''<palnum>'''''

Specifies the palette number the skybox should happen for.

==== facename ====

'''facename''' '''''<filename>'''''

Defines a single face of the skybox where facename may be any of these keywords appropriate for the face in question:

Front Right Back Left Top Bottom
ft rt bk lf up dn
front right back left top bottom
forward lt ceiling floor
ceil down

'''NOTE:''' All six faces are required to be specified.

=== model ===

'''model''' '''''<filename> { ... }'''''

Defines a model to replace certain sprites in the game when running in OpenGL Polymost mode. '''''<filename>''''' is the model file in md2 or md3 format.

'''Note:''' md2 is considered deprecated.

The brace-enclosed block may contain these instructions:

==== scale ====

'''scale''' '''''<value>'''''

'''''<value>''''' is a (possibly fractional) value specifying a scaling factor for the model when it is rendered, eg. 1.5 for one-and-a-half times as big.

==== shade ====

'''shade''' '''''<shade-offset>'''''

'''''<shade-offset>''''' is an integer value specifying how much to bias the sprite's shade value by. A negative value for this makes the model brighter. Conversely, a positive value makes it darker.

==== zadd ====

'''zadd''' '''''<offset>'''''

'''''<offset>''''' is a (possibly fractional) value specifying a height offset for the model. Quake models are aligned in the center while Build models are aligned at the floor. Using this command will allow Build to use Quake models without modification to the MD2/3 file itself.

==== flags ====

'''flags''' '''''<flags>'''''

Specifies any special properties the model should have, the values of which should be added together to combine multiple options.
*0: default value
*1: Prevents the the model from being affected by the tints.

==== skin ====

'''skin''' '''''{ ... }'''''
Defines a skin to be used on the model for all frames declared after this command. The brace-enclosed block may contain these instructions:

===== pal =====

'''pal''' '''''<palnum>'''''

Specifies which palette this skin maps to.

===== surface =====

'''surface''' '''''<surfnum>'''''

Specifies which MD3 surface this skin should be applied to. This has no significance for MD2 models.

===== file =====

'''file''' '''''<filename>'''''

Specifies the texture file to use for the skin. File may be any PNG, JPG, TGA, BMP, GIF or PCX file

'''IMPORTANT:''' If your model exists in a subdirectory (ie. the model filename includes a path to the .md2/3) you will need to give the same path to filename if the skin is in the same directory.

==== anim ====

'''anim''' '''''{ ... }'''''

Defines an animation from a group of frames in the model. The brace-enclosed block may contain these instructions:

===== frame =====

'''frame0''' '''''<framename>'''''

'''frame1''' '''''<framename>'''''

Specifies the names of the start ('''frame0''') and end ('''frame1''') frames of the animation.

===== fps =====

'''fps''' '''''<fps>'''''

Specifies the frame rate at which the animation should play. This value may be fractional.

===== flags =====

'''flags''' '''''<flags>'''''

Specifies any special properties the animation should have, the values of which should be added together to combine multiple options.

Valid options are:
* 0 = none (looping animation)
* 1 = one-shot (plays beginning to end once and stops on the last frame).

==== frame ====

'''frame''' '''''{ ... }'''''

Defines a range of ART-file tiles to correspond with the given frame/animation of the model. The brace-enclosed block may contain these instructions:

===== name =====

'''name''' '''''<framename>'''''

'''frame''' '''''<framename>'''''

If '''''<framename>''''' is identical to the starting frame of an animation, the engine will play that animation, otherwise the replacement will be static. You can choose to use the '''frame''' or '''name''' versions of this instruction as both are identical.

===== tile =====

'''tile''' '''''<tilenum>'''''

'''tile0''' '''''<tilenum>'''''

'''tile1''' '''''<tilenum>'''''

Use the tile instruction to specify an ART-file tile which this model should replace. Use the '''tile0''' and '''tile1''' instructions together to specify a range of ART-file tiles. If you use '''tile0''', you must also have a '''tile1'''. You may not use the same instruction twice to specify multiple ranges.

===== smoothduration =====

'''smoothduration''' '''''<value>'''''

If smoothduration is non-zero switching from another animation to the one defined by that frame block will trigger an intermediary animation smoothing state of duration '''''<value>''''' seconds.

===== pal =====

'''pal''' '''''<value>'''''

Makes the model definition exclusive for the this pal. This allow to assign different models for different pal.

==== hud ====

'''hud''' '''''{ ... }'''''

Defines a range of ART-file tiles to use with a heads-up-display. The brace-enclosed block may contain these instructions:

===== tile =====

'''tile''' '''''<tilenum>'''''

'''tile0''' '''''<tilenum>'''''

'''tile1''' '''''<tilenum>'''''

'''tile0''' and '''tile1''' together specify a range of ART-file tiles which this model frame should replace when rendered as part of the HUD. You can specify individual tiles using a single tile command.

===== offset =====

'''xadd''' '''''<offset>'''''

'''yadd''' '''''<offset>'''''

'''zadd''' '''''<offset>'''''

'''angadd''' '''''<offset>'''''

Use these offsets to fine-tune the location of the model placement. '''xadd''', '''yadd''', and '''zadd''' are position offsets relative to the viewer's orienation. You can use floating point values with them. '''angadd''' is a Build angle offset. (512 = 90 degrees, 1024 = 180 degrees, etc...).

===== hide =====

'''hide'''

Some weapons use multiple ART tiles for constructing the gun or animation. Use this option to hide parts that you don't need in your replacement.

===== nobob =====

'''nobob'''

By default, the HUD model offset is affected by the player bobbing offset when the player is walking. Use this option to disable that.

===== flipped =====

'''flipped'''

Use this option to apply the settings inside the hud block only if the object is normally rendered x-flipped (mirror image). Some weapons, such as the devastator, are rendered in 2 pieces, the left devastator is actually a mirror image of the right.

===== nodepth =====

'''nodepth'''

Use this to render a HUD model without the use of the depth buffer. Normally, you should avoid this. The one exception where this is useful is for the spinning nuke menu pointer because it should always be in front - and it just happens to be convex ... which is the one case that is safe with the depth buffer disabled … a rather fortunate coincidence. [[Image:Smile.gif]]

==== detail ====

'''detail''' '''''{ ... }'''''

Defines a [[Detail_mapping|detail texture]] for the model. The brace-enclosed block may contain these instructions:

===== file =====

'''file''' '''''<filename>'''''

Specifies which detail texture file to use. File may be any PNG, JPG, TGA, BMP, GIF or PCX file. This instruction must be supplied.

===== scale =====

'''scale''' '''''<value>'''''

'''''<value>''''' is a positive floating-point value that'll determine how much your detail map should repeat on your diffuse map (if you want your detail map to repeat five times, use a 1/5 scale : 0.2).

===== surface =====

'''surface''' '''''<surfnum>'''''

Specifies which MD3 surface this detail texture should be applied to. This has no significance for MD2 models.

==== glow ====

'''glow''' '''''{ ... }'''''

Defines a [[Glow_mapping|glow map]] for the model. The brace-enclosed block may contain these instructions:

===== file =====

'''file''' '''''<filename>'''''

Specifies which glow map file to use. This instruction must be supplied.

===== surface =====

'''surface''' '''''<surfnum>'''''

Specifies which MD3 surface this glow map should be applied to. This has no significance for MD2 models.

=== voxel ===

'''voxel''' '''''<filename> { ... }'''''

Defines a voxel to replace sprites. filename is the name of the .KVX file containing the voxel. The brace-enclosed block may contain these instructions:

==== tile ====

'''tile''' '''''<tilenum>'''''

'''tile0''' '''''<tilenum>'''''

'''tile1''' '''''<tilenum>'''''

Use these instructions to map tiles that should be rendered as a voxels. Use '''tile''' to map a single tile to be rendered as voxels and '''tile0''', '''tile1''' together define a range of tiles to be rendered as voxels. The '''tile0''' instruction should appear before the '''tile1''' instruction to define a correct range.

==== scale ====

'''scale''' '''''<value>'''''

'''''<value>''''' is a (possibly fractional) value specifying a scaling factor for the voxelmodel when it is rendered, eg. 1.5 for one-and-a-half times as big.

== Un-Definitions ==

The main use for these is for cases in which the .ART files are somewhat different, and you want to ensure compatibility for the new art without new textures or models. A good example of this is the [http://www.freewebtown.com/hendricks266/nwhrp.html Duke: Nuclear Winter HRP] by [[User:Hendricks 266|Hendricks266]]. (see undef.def)

=== undeftexture ===

'''undeftexture''' '''''<tile>'''''

This is for undefining Hightile textures.

==== undeftexturerange ====

'''undeftexturerange''' '''''<tile0> <tile1>'''''

Same as '''undeftexture''', but with a range of tiles.

=== undefmodel ===

'''undefmodel''' '''''<tile>'''''

This is for undefining 3D models.

==== undefmodelrange ====

'''undefmodelrange''' '''''<tile0> <tile1>'''''

Same as '''undefmodel''', but with a range of tiles.

==== undefmodelof ====

'''undefmodelof''' '''''<tile>'''''

Same as '''undefmodel''', but all the tiles grouped together within the same .DEF code block are un-defined.

Support of '''undefmodelof''' seems to be broken at this time. Using it in your .DEF files will result in crashing upon compiling.

== Misc ==

=== alphahack ===

'''alphahack''' '''''<tilenum> <value>'''''

'''alphahack''' is a deprecated command to improve alpha filtering of highres art of '''''<tilenum>'''''. '''''<value>''''' is always -1.

==== alphahackrange ====

'''alphahackrange''' '''''<tilenum1> <tilenum2> <value>'''''

Same as '''alphahack''', but with a range of tiles.

=== animtilerange ===

'''animtilerange''' '''''<tilenum1> <tilenum2> <speed value> <animation value>'''''

Animates hightile textures the same way as 8 bit art does. Hightile art needs to be defined first.

=== dummytile ===

'''dummytile''' '''''<tilenum> <x-dimension> <y-dimension>'''''

Used in DEF files to create a blank tile at location '''<''tilenum''>''' of the dimensions '''<''x-dimension''>''' and '''<''y-dimension''>'''. This allows the creation of placeholder tiles for use with definetexture\texture without having to edit .ART files.

==== dummytilerange ====

'''dummytilerange''' '''''<tilenum1> <tilenum2> <x-dimension> <y-dimension>'''''

Same as '''dummytile''', but with a range of tiles.

=== setuptile ===

'''setuptile''' '''''<tilenum> <x-dimension> <y-dimension> <x-offset> <y-offset>'''''

Used in DEF files to setup the properties which are applied to the highres replacement of the tile. This allows the creation of placeholder tiles for use with definetexture\texture without having to edit .ART files.
Unlike '''dummytile''' this command won't draw black squares and accepts the offsets.

==== setuptilerange ====

'''setuptilerange''' '''''<tilenum1> <tilenum2> <x-dimension> <y-dimension> <x-offset> <y-offset>'''''

Same as '''setuptile''', but with a range of tiles.

=== include ===

'''include''' '''''<filename>'''''

'''#include''' '''''<filename>'''''

Processes the script commands in '''''<filename>''''' at the point of the '''include''' call.

=== define ===

'''define''' '''''<label> <integer-value>'''''

'''#define''' '''''<label> <integer-value>'''''

Declares '''''<label>''''' to represent the numeric value '''''<integer-value>'''''. '''''<integer-value>''''' can be a label, in which case the value of the label given is used.

'''NOTE:''' You may find it convenient to include DEFS.CON (for JFDuke3D) or NAMES.H to predefine many of the tile names in the art file.

=== loadgrp ===

'''loadgrp''' '''''<.GRP\.ZIP file>'''''

The DEF equivalent of the '''/g''' command line switch. '''loadgrp''' can only be used in the originating .DEF file; it is usually '''duke3d.def''' or the .DEF file specified by the '''/h''' command line switch.

=== cachesize ===

'''cachesize''' '''''<size>'''''

Specifies the size of the cache in Kb.

=== fogpal ===

'''fogpal''' '''''<palette number> <red intensity> <green intensity> <blue intensity>'''''

'''fogpal''' defines a palette a sector-based fog effect. To use it, change the pal of your sector to the pal defined with '''fogpal'''.

Intensities range from 0-63. Palettes 26, 27, 28 and 29 are pre-defined for you as white, red, green and blue respectively. Sector visibility controls fog density.

== Mapster32 ==

=== 2dcol ===

'''2dcol''' '''''<colornum> <red> <green> <blue>'''''

'''2dcol''' is a definition of a color to be used in the 2D mode of [[Mapster32]], in conjunction with '''spritecol''' that works similarly to '''tint''' and '''definetint'''. '''''<colornum>''''' is a unique identifier, similar to [[define|defines]] and [[gamevar|gamevars]]. '''''<red>''''', '''''<green>''''', and '''''<blue>''''' are the RGB color values that are mixed together to get your custom color.

Certain low values are already hard-coded, and redefining them will change colors of the default layout. If you know the correct value, you can replace the default colors used for '''all''' the sprites. You truly have the power to customize Mapster32. Lime green 2D mode background, anyone?

=== spritecol ===

'''spritecol''' '''''<tilenum> <normalcolornum> <blockingcolornum>'''''

'''spritecol''' is a definition of the color a sprite will appear in 2D mode, instead of the standard sky blue and hot pink, or another special color (like yellow for hard-coded enemies or white for the [[Special_Sprite_Reference_Guide|special sprites]]). '''<''normalcolornum''>''' is the '''<''colornum''>''' of the '''2dcol''' definition of your color for the standard sprite color as defined by '''<''tilenum''>'''. The same goes for '''<''blockingcolornum''>''', except that this value is for when the sprite has the first bit of [[cstat]] set (1) (<code>[']+[B]</code> keys in [[Mapster32]]), which is the blocking flag.

== Deprecated Commands ==

=== definetexture ===

'''definetexture''' '''''<tile-number> <palette-number> <x-center> <y-center> <x-size> <y-size> <filename>'''''

Defines a Hightile texture to replace an ART-file picture. '''''<tile-number>''''' may be an number, or a defined label. Use a value of 0 for '''''<x-center>''''' and '''''<y-center>''''' and a value of -1 for '''''<x-size>''''' and '''''<y-size>''''' for now until these values are actually used. '''''<filename>''''' may be any PNG, JPG, TGA, BMP, GIF or PCX file.

=== definetint ===

'''definetint''' '''''<palette-number> <red> <green> <blue> <flags'''''

Defines a Hightile texture tint to simulate palette effects normally used on ART-file tiles. '''''<red>''''', '''''<green>''''', and '''''<blue>''''' are numbers in the range 0 to 255 which specify the color the tint should look like. '''''<flags>''''' specifies any processing effects to use. Valid values are:
* 0 = no effects
* 1 = convert to greyscale
* 2 = invert colours
These values can be added together to produce a combination of effects.

=== defineskybox ===
'''defineskybox''' '''''<tile-number> <palette-number> <reserved> <front-face-filename> <right-face-filename> <back-face-filename> <left-face-filename> <top-face-filename> <bottom-face-filename>'''''

Defines a sky-box composed of six images mapped onto the faces
of a cube to be used when '''''<tile-number>''''' is set as parallaxing in GL Polymost mode. '''''<reserved>''''' should be 0 for now until its meaning is fully conceived.

=== definemodel ===

'''definemodel''' '''''<filename> <scale> <shade-offset>'''''

Defines an MD2/3-format model file to replace certain sprites in the game. See '''definemodelframe''' and '''definemodelanim''' for details on how to specify the ART-file tiles to replace. '''''<filename>''''' is the name of the MD2/3 model. '''''<scale>''''' is a (possibly fractional) value specifying a scaling factor for the model when it is rendered, eg. 1.5 for one-and-a-half times as big. '''''<shade-offset>''''' is an integer value specifying how much to bias the sprite's shade value by. A negative value for this makes the model brighter. Conversely, a positive value makes it darker.

==== definemodelskin ====

'''definemodelskin''' '''''<palette-number> <filename>'''''

Defines a skin to be used on the model for all frames declared after this command, when the sprite palette is equal to '''''<palette-number>'''''. (This makes more sense when given a demonstration.) '''IMPORTANT:''' If your model exists in a subdirectory (ie. '''definemodel''' includes a path to the .md2/3) you will need to give the same path to filename if the skin is in the same directory.

==== selectmodelskin ====

'''selectmodelskin''' '''''<skin ID>'''''

Selects a model skin.

==== definemodelanim ====

'''definemodelanim''' '''''<start-frame> <end-frame> <frame-rate> <flags>'''''

Defines an animation from a group of frames in the model given by the last preceding '''definemodel''' instruction. '''''<start-frame>''''' and '''''<end-frame>''''' specify the names of the starting and ending frames of the animation. '''''<frame-rate>''''' is the frame rate at which the animation should play. This value can be fractional. '''''<flags>''''' specifies any special properties the animation should have. Valid options are:

* 0 = none (looping animation)
* 1 = one-shot (plays beginning to end once and stops on the last frame)

==== definemodelframe ====

'''definemodelframe''' '''''<frame-name> <first-tile> <last-tile>'''''

Defines a range of ART-file tiles to correspond with the given frame of the model specified in the last preceding '''definemodel''' instruction. '''''<frame-name>''''' is the name of the frame, which if identical to the starting frame of a '''definemodelanim''' animation will play that animation. If '''''<frame-name>''''' is not corresponding with an animation, the replacement will be static. '''''<first-tile>''''' and '''''<last-tile>''''' specify a range of ART-file tiles which this model frame should replace.

=== definevoxel ===

'''definevoxel''' '''''<filename>'''''

Defines a voxel to replace sprites in the game. See '''definevoxeltiles''' for details on how to specify the ART-file tiles to replace. '''''<filename>''''' is the name of the .KVX file containing the voxel.

==== definevoxeltiles ====

'''definevoxeltiles''' '''''<first-tile> <last-tile>'''''

Defines the range of ART-file tiles to replace with the voxel given in the last preceding '''definevoxel''' instruction.

[[Category:All commands]]

DEF Language

2009-05-05T08:24:50Z

One:

New to JFDuke3D\EDuke32 are DEF files. These parsed scripts allow redefinition of flat, Hightile textures, 3D models, miscellaneous settings, and, possibly, in the future, higher-quality sounds and music, and enhanced cutscenes.

Comments can be used by prefixing the text with a double forward-slash (C++ style), <code>//</code>, or surrounding the text with <code>/* (comment here) */</code> (C style).

<div class="floatleft">__TOC__</div>

== Preferred Commands ==

=== include ===

'''include''' '''''<filename>'''''

'''#include''' '''''<filename>'''''

Processes the script commands in '''''<filename>''''' at the point of the '''include''' call.

=== define ===

'''define''' '''''<label> <integer-value>'''''

'''#define''' '''''<label> <integer-value>'''''

Declares '''''<label>''''' to represent the numeric value '''''<integer-value>'''''. '''''<integer-value>''''' can be a label, in which case the value of the label given is used.

'''NOTE:''' You may find it convenient to include DEFS.CON (for JFDuke3D) or NAMES.H to predefine many of the tile names in the art file.

=== texture ===

'''texture''' '''''<tilenum> { ... }''''''

Defines a Hightile texture to replace an ART-file tile. '''''<tilenum>''''' may be a number, or a defined label.

The brace-enclosed block may contain these instructions:

==== pal ====

'''pal''' '''''<palnum> { ... }'''''

Replaces the palette '''''<palnum>'''''. If a palette has no pal definition palette 0 definition will be used. Tint will not be used on palettes defined with this instruction.

The brace-enclosed block may contain these instructions:

===== file =====

'''file''' '''''<filename>'''''

'''name''' '''''<filename>'''''

Defines which texture file to use. File may be any PNG, JPG, TGA, BMP, GIF or PCX file. This instruction must be supplied.

===== alphacut =====

'''alphacut''' '''''<cutoff-value>'''''

Sets the level of transparency at which a pixel in the texture is considered opaque. Pixels with more transparency than the cut-off are not drawn to the screen when rendered. The default setting is 0.32, which is just below the 33% transparency level of Build. If your texture has areas that are more transparent than the default, you can lower the cut-off level to preserve that detail.

===== nocompress =====

'''nocompress'''

Prevents the texture from being compressed using S3TC if texture compression is enabled.

===== scale =====

'''xscale''' '''''<value>'''''

'''yscale''' '''''<value>'''''

Sets the scale of the hightile texture in relation to the original texture. A '''''<value>''''' of 1.0 makes it the same size, higher makes it cover more then the original tile and smaller makes it cover a smaller area. '''xscale''' sets the horizontal scale and '''yscale''' sets the vertical scale.

==== detail (EDuke32-Native)====

'''detail''' '''''{...}'''''

Defines a [[Detail_mapping|detail texture]] for the texture. The brace-enclosed block may contain these instructions:

===== file =====

'''file''' '''''<filename>'''''

Specifies which detail texture file to use. File may be any PNG, JPG, TGA, BMP, GIF or PCX file. This instruction must be supplied.

===== scale =====

'''scale''' '''''<value>'''''

'''''<value>''''' is a positive floating-point value that'll determine how much your detail map should repeat on your diffuse map (if you want your detail map to repeat five times, use a 1/5 scale : 0.2).

==== glow (EDuke32-Native) ====

'''glow''' '''''{...}'''''

Defines a [[Glow_mapping|glow map]] for the texture. The brace-enclosed block may contain these instructions:

===== file =====

'''file''' '''''<filename>'''''

Specifies which glow map file to use. This instruction must be supplied.

=== tint ===

'''tint''' '''''{ ... }'''''

Defines a Hightile texture tint to simulate palette effects normally used on ART-file tiles. The brace-enclosed block may contain these instructions:

==== pal ====

'''pal''' '''''<palnum>'''''

The palette number the tint applies to.

==== color ====

'''red''' '''''<value>'''''

'''green''' '''''<value>'''''

'''blue''' '''''<value>'''''

'''r''' '''''<value>'''''

'''g''' '''''<value>'''''

'''b''' '''''<value>'''''

Specifies a color component value, in the range of 0 to 255. Unspecified components are assumed to be 255 and any out of range values are clamped to the maximum or minimum as appropriate.

==== flags ====

'''flags''' '''''<flags>'''''

Specifies any special processing effects to use for the tint. The value of flags may be the sum of any of these values:

* 0 = no effects
* 1 = convert to greyscale
* 2 = invert colors

=== skybox ===

'''skybox''' '''''{ ... }'''''

Defines a skybox that overrides a parallaxing floor or ceiling in OpenGL Polymost rendering mode. The brace-enclosed block may contain these instructions:

==== tile ====

'''tile''' '''''<tilenum>'''''

Specifies the ART file tile to override.

==== pal ====

'''pal''' '''''<palnum>'''''

Specifies the palette number the skybox should happen for.

==== facename ====

'''facename''' '''''<filename>'''''

Defines a single face of the skybox where facename may be any of these keywords appropriate for the face in question:

Front Right Back Left Top Bottom
ft rt bk lf up dn
front right back left top bottom
forward lt ceiling floor
ceil down

'''NOTE:''' All six faces are required to be specified.

=== model ===

'''model''' '''''<filename> { ... }'''''

Defines a model to replace certain sprites in the game when running in OpenGL Polymost mode. '''''<filename>''''' is the model file in md2 or md3 format.

'''Note:''' md2 is considered deprecated.

The brace-enclosed block may contain these instructions:

==== scale ====

'''scale''' '''''<value>'''''

'''''<value>''''' is a (possibly fractional) value specifying a scaling factor for the model when it is rendered, eg. 1.5 for one-and-a-half times as big.

==== shade ====

'''shade''' '''''<shade-offset>'''''

'''''<shade-offset>''''' is an integer value specifying how much to bias the sprite's shade value by. A negative value for this makes the model brighter. Conversely, a positive value makes it darker.

==== zadd ====

'''zadd''' '''''<offset>'''''

'''''<offset>''''' is a (possibly fractional) value specifying a height offset for the model. Quake models are aligned in the center while Build models are aligned at the floor. Using this command will allow Build to use Quake models without modification to the MD2/3 file itself.

==== flags (EDuke32-Native)====

'''flags''' '''''<flags>'''''

Specifies any special properties the model should have, the values of which should be added together to combine multiple options.
*0: default value
*1: Prevents the the model from being affected by the tints.

==== skin ====

'''skin''' '''''{ ... }'''''
Defines a skin to be used on the model for all frames declared after this command. The brace-enclosed block may contain these instructions:

===== pal =====

'''pal''' '''''<palnum>'''''

Specifies which palette this skin maps to.

===== surface =====

'''surface''' '''''<surfnum>'''''

Specifies which MD3 surface this skin should be applied to. This has no significance for MD2 models.

===== file =====

'''file''' '''''<filename>'''''

Specifies the texture file to use for the skin. File may be any PNG, JPG, TGA, BMP, GIF or PCX file

'''IMPORTANT:''' If your model exists in a subdirectory (ie. the model filename includes a path to the .md2/3) you will need to give the same path to filename if the skin is in the same directory.

==== anim ====

'''anim''' '''''{ ... }'''''

Defines an animation from a group of frames in the model. The brace-enclosed block may contain these instructions:

===== frame =====

'''frame0''' '''''<framename>'''''

'''frame1''' '''''<framename>'''''

Specifies the names of the start ('''frame0''') and end ('''frame1''') frames of the animation.

===== fps =====

'''fps''' '''''<fps>'''''

Specifies the frame rate at which the animation should play. This value may be fractional.

===== flags =====

'''flags''' '''''<flags>'''''

Specifies any special properties the animation should have, the values of which should be added together to combine multiple options.

Valid options are:
* 0 = none (looping animation)
* 1 = one-shot (plays beginning to end once and stops on the last frame).

==== frame ====

'''frame''' '''''{ ... }'''''

Defines a range of ART-file tiles to correspond with the given frame/animation of the model. The brace-enclosed block may contain these instructions:

===== name =====

'''name''' '''''<framename>'''''

'''frame''' '''''<framename>'''''

If '''''<framename>''''' is identical to the starting frame of an animation, the engine will play that animation, otherwise the replacement will be static. You can choose to use the '''frame''' or '''name''' versions of this instruction as both are identical.

===== tile =====

'''tile''' '''''<tilenum>'''''

'''tile0''' '''''<tilenum>'''''

'''tile1''' '''''<tilenum>'''''

Use the tile instruction to specify an ART-file tile which this model should replace. Use the '''tile0''' and '''tile1''' instructions together to specify a range of ART-file tiles. If you use '''tile0''', you must also have a '''tile1'''. You may not use the same instruction twice to specify multiple ranges.

===== smoothduration (EDuke32-Native)=====

'''smoothduration''' '''''<value>'''''

If smoothduration is non-zero switching from another animation to the one defined by that frame block will trigger an intermediary animation smoothing state of duration '''''<value>''''' seconds.

===== pal (EDuke32-Native)=====

'''pal''' '''''<value>'''''

Makes the model definition exclusive for the this pal. This allow to assign different models for different pal.

==== hud ====

'''hud''' '''''{ ... }'''''

Defines a range of ART-file tiles to use with a heads-up-display. The brace-enclosed block may contain these instructions:

===== tile =====

'''tile''' '''''<tilenum>'''''

'''tile0''' '''''<tilenum>'''''

'''tile1''' '''''<tilenum>'''''

'''tile0''' and '''tile1''' together specify a range of ART-file tiles which this model frame should replace when rendered as part of the HUD. You can specify individual tiles using a single tile command.

===== offset =====

'''xadd''' '''''<offset>'''''

'''yadd''' '''''<offset>'''''

'''zadd''' '''''offset>'''''

'''angadd''' '''''offset>'''''

Use these offsets to fine-tune the location of the model placement. '''xadd''', '''yadd''', and '''zadd''' are position offsets relative to the viewer's orienation. You can use floating point values with them. '''angadd''' is a Build angle offset. (512 = 90 degrees, 1024 = 180 degrees, etc...).

===== hide =====

'''hide'''

Some weapons use multiple ART tiles for constructing the gun or animation. Use this option to hide parts that you don't need in your replacement.

===== nobob =====

'''nobob'''

By default, the HUD model offset is affected by the player bobbing offset when the player is walking. Use this option to disable that.

===== flipped =====

'''flipped'''

Use this option to apply the settings inside the hud block only if the object is normally rendered x-flipped (mirror image). Some weapons, such as the devastator, are rendered in 2 pieces, the left devastator is actually a mirror image of the right.

===== nodepth =====

'''nodepth'''

Use this to render a HUD model without the use of the depth buffer. Normally, you should avoid this. The one exception where this is useful is for the spinning nuke menu pointer because it should always be in front - and it just happens to be convex ... which is the one case that is safe with the depth buffer disabled … a rather fortunate coincidence. [[Image:Smile.gif]]

==== detail (EDuke32-Native)====

'''detail''' '''''{...}'''''

Defines a [[Detail_mapping|detail texture]] for the model. The brace-enclosed block may contain these instructions:

===== file =====

'''file''' '''''<filename>'''''

Specifies which detail texture file to use. File may be any PNG, JPG, TGA, BMP, GIF or PCX file. This instruction must be supplied.

===== scale =====

'''scale''' '''''<value>'''''

'''''<value>''''' is a positive floating-point value that'll determine how much your detail map should repeat on your diffuse map (if you want your detail map to repeat five times, use a 1/5 scale : 0.2).

===== surface =====

'''surface''' '''''<surfnum>'''''

Specifies which MD3 surface this detail texture should be applied to. This has no significance for MD2 models.

==== glow (EDuke32-Native) ====

'''glow''' '''''{...}'''''

Defines a [[Glow_mapping|glow map]] for the model. The brace-enclosed block may contain these instructions:

===== file =====

'''file''' '''''<filename>'''''

Specifies which glow map file to use. This instruction must be supplied.

===== surface =====

'''surface''' '''''<surfnum>'''''

Specifies which MD3 surface this glow map should be applied to. This has no significance for MD2 models.

=== voxel ===

'''voxel''' '''''<filename> { ... }'''''

Defines a voxel to replace sprites. filename is the name of the .KVX file containing the voxel. The brace-enclosed block may contain these instructions:

==== tile ====

'''tile''' '''''<tilenum>'''''

'''tile0''' '''''<tilenum>'''''

'''tile1''' '''''<tilenum>'''''

Use these instructions to map tiles that should be rendered as a voxels. Use '''tile''' to map a single tile to be rendered as voxels and '''tile0''', '''tile1''' together define a range of tiles to be rendered as voxels. The '''tile0''' instruction should appear before the '''tile1''' instruction to define a correct range.

==== scale ====

'''scale''' '''''<value>'''''

'''''<value>''''' is a (possibly fractional) value specifying a scaling factor for the voxelmodel when it is rendered, eg. 1.5 for one-and-a-half times as big.

== Un-Definitions ==

The main use for these is for cases in which the .ART files are somewhat different, and you want to ensure compatibility for the new art without new textures or models. A good example of this is the [http://www.freewebtown.com/hendricks266/nwhrp.html Duke: Nuclear Winter HRP] by [[User:Hendricks 266|Hendricks266]]. (see undef.def)

=== undeftexture ===

'''undeftexture''' '''''<tile>'''''

This is for undefining Hightile textures.

==== undeftexturerange ====

'''undeftexturerange''' '''''<tile0> <tile1>'''''

Same as '''undeftexture''', but with a range of tiles.

=== undefmodel ===

'''undefmodel''' '''''<tile>'''''

This is for undefining 3D models.

==== undefmodelrange ====

'''undefmodelrange''' '''''<tile0> <tile1>'''''

Same as '''undefmodel''', but with a range of tiles.

==== undefmodelof ====

'''undefmodelof''' '''''<tile>'''''

Same as '''undefmodel''', but all the tiles grouped together within the same .DEF code block are un-defined.

Support of '''undefmodelof''' seems to be broken at this time. Using it in your .DEF files will result in crashing upon compiling.

== EDuke32-Native Commands ==

=== alphahack ===

'''alphahack''' '''''<tilenum> <value>'''''

'''alphahack''' is a deprecated command to improve alpha filtering of highres art of '''''<tilenum>'''''. '''''<value>''''' is always -1.

==== alphahackrange ====

'''alphahackrange''' '''''<tilenum1> <tilenum2> <value>'''''

Same as '''alphahack''', but with a range of tiles.

=== animtilerange ===

'''animtilerange''' '''''<tilenum1> <tilenum2> <speed value> <animation value>'''''

Animates hightile textures the same way as 8 bit art does. Hightile art needs to be defined first.

=== dummytile ===

'''dummytile''' '''''<tilenum> <x-dimension> <y-dimension>'''''

Used in DEF files to create a blank tile at location '''<''tilenum''>''' of the dimensions '''<''x-dimension''>''' and '''<''y-dimension''>'''. This allows the creation of placeholder tiles for use with definetexture\texture without having to edit .ART files.

==== dummytilerange ====

'''dummytilerange''' '''''<tilenum1> <tilenum2> <x-dimension> <y-dimension>'''''

Same as '''dummytile''', but with a range of tiles.

=== setuptile ===

'''setuptile''' '''''<tilenum> <x-dimension> <y-dimension> <x-offset> <y-offset>'''''

Used in DEF files to setup the properties which are applied to the highres replacement of the tile. This allows the creation of placeholder tiles for use with definetexture\texture without having to edit .ART files.
Unlike '''dummytile''' this command won't draw black squares and accepts the offsets.

==== setuptilerange ====

'''setuptilerange''' '''''<tilenum1> <tilenum2> <x-dimension> <y-dimension> <x-offset> <y-offset>'''''

Same as '''setuptile''', but with a range of tiles.

=== loadgrp ===

'''loadgrp''' '''''<.GRP\.ZIP file>'''''

The DEF equivalent of the '''/g''' command line switch. '''loadgrp''' can only be used in the originating .DEF file; it is usually '''duke3d.def''' or the .DEF file specified by the '''/h''' command line switch.

=== cachesize ===

'''cachesize''' '''''<size>'''''

Specifies the size of the cache in Kb.

=== fogpal ===

'''fogpal''' '''''<palette number> <red intensity> <green intensity> <blue intensity>'''''

'''fogpal''' defines a palette a sector-based fog effect. To use it, change the pal of your sector to the pal defined with '''fogpal'''.

Intensities range from 0-63. Palettes 26, 27, 28 and 29 are pre-defined for you as white, red, green and blue respectively. Sector visibility controls fog density.

=== 2dcol ===

'''2dcol''' '''''<colornum> <red> <green> <blue>'''''

'''2dcol''' is a definition of a color to be used in the 2D mode of [[Mapster32]], in conjunction with '''spritecol''' that works similarly to '''tint''' and '''definetint'''. '''''<colornum>''''' is a unique identifier, similar to [[define|defines]] and [[gamevar|gamevars]]. '''''<red>''''', '''''<green>''''', and '''''<blue>''''' are the RGB color values that are mixed together to get your custom color.

Certain low values are already hard-coded, and redefining them will change colors of the default layout. If you know the correct value, you can replace the default colors used for '''all''' the sprites. You truly have the power to customize Mapster32. Lime green 2D mode background, anyone?

=== spritecol ===

'''spritecol''' '''''<tilenum> <normalcolornum> <blockingcolornum>'''''

'''spritecol''' is a definition of the color a sprite will appear in 2D mode, instead of the standard sky blue and hot pink, or another special color (like yellow for hard-coded enemies or white for the [[Special_Sprite_Reference_Guide|special sprites]]). '''<''normalcolornum''>''' is the '''<''colornum''>''' of the '''2dcol''' definition of your color for the standard sprite color as defined by '''<''tilenum''>'''. The same goes for '''<''blockingcolornum''>''', except that this value is for when the sprite has the first bit of [[cstat]] set (1) (<code>[']+[B]</code> keys in [[Mapster32]]), which is the blocking flag.

== Deprecated Commands ==

=== definetexture ===

'''definetexture''' '''''<tile-number> <palette-number> <x-center> <y-center> <x-size> <y-size> <filename>'''''

Defines a Hightile texture to replace an ART-file picture. '''''<tile-number>''''' may be an number, or a defined label. Use a value of 0 for '''''<x-center>''''' and '''''<y-center>''''' and a value of -1 for '''''<x-size>''''' and '''''<y-size>''''' for now until these values are actually used. '''''<filename>''''' may be any PNG, JPG, TGA, BMP, GIF or PCX file.

=== definetint ===

'''definetint''' '''''<palette-number> <red> <green> <blue> <flags'''''

Defines a Hightile texture tint to simulate palette effects normally used on ART-file tiles. '''''<red>''''', '''''<green>''''', and '''''<blue>''''' are numbers in the range 0 to 255 which specify the color the tint should look like. '''''<flags>''''' specifies any processing effects to use. Valid values are:
* 0 = no effects
* 1 = convert to greyscale
* 2 = invert colours
These values can be added together to produce a combination of effects.

=== defineskybox ===
'''defineskybox''' '''''<tile-number> <palette-number> <reserved> <front-face-filename> <right-face-filename> <back-face-filename> <left-face-filename> <top-face-filename> <bottom-face-filename>'''''

Defines a sky-box composed of six images mapped onto the faces
of a cube to be used when '''''<tile-number>''''' is set as parallaxing in GL Polymost mode. '''''<reserved>''''' should be 0 for now until its meaning is fully conceived.

=== definemodel ===

'''definemodel''' '''''<filename> <scale> <shade-offset>'''''

Defines an MD2/3-format model file to replace certain sprites in the game. See '''definemodelframe''' and '''definemodelanim''' for details on how to specify the ART-file tiles to replace. '''''<filename>''''' is the name of the MD2/3 model. '''''<scale>''''' is a (possibly fractional) value specifying a scaling factor for the model when it is rendered, eg. 1.5 for one-and-a-half times as big. '''''<shade-offset>''''' is an integer value specifying how much to bias the sprite's shade value by. A negative value for this makes the model brighter. Conversely, a positive value makes it darker.

==== definemodelskin ====

'''definemodelskin''' '''''<palette-number> <filename>'''''

Defines a skin to be used on the model for all frames declared after this command, when the sprite palette is equal to '''''<palette-number>'''''. (This makes more sense when given a demonstration.) '''IMPORTANT:''' If your model exists in a subdirectory (ie. '''definemodel''' includes a path to the .md2/3) you will need to give the same path to filename if the skin is in the same directory.

==== selectmodelskin ====

'''selectmodelskin''' '''''<skin ID>'''''

Selects a model skin.

==== definemodelanim ====

'''definemodelanim''' '''''<start-frame> <end-frame> <frame-rate> <flags>'''''

Defines an animation from a group of frames in the model given by the last preceding '''definemodel''' instruction. '''''<start-frame>''''' and '''''<end-frame>''''' specify the names of the starting and ending frames of the animation. '''''<frame-rate>''''' is the frame rate at which the animation should play. This value can be fractional. '''''<flags>''''' specifies any special properties the animation should have. Valid options are:

* 0 = none (looping animation)
* 1 = one-shot (plays beginning to end once and stops on the last frame)

==== definemodelframe ====

'''definemodelframe''' '''''<frame-name> <first-tile> <last-tile>'''''

Defines a range of ART-file tiles to correspond with the given frame of the model specified in the last preceding '''definemodel''' instruction. '''''<frame-name>''''' is the name of the frame, which if identical to the starting frame of a '''definemodelanim''' animation will play that animation. If '''''<frame-name>''''' is not corresponding with an animation, the replacement will be static. '''''<first-tile>''''' and '''''<last-tile>''''' specify a range of ART-file tiles which this model frame should replace.

=== definevoxel ===

'''definevoxel''' '''''<filename>'''''

Defines a voxel to replace sprites in the game. See '''definevoxeltiles''' for details on how to specify the ART-file tiles to replace. '''''<filename>''''' is the name of the .KVX file containing the voxel.

==== definevoxeltiles ====

'''definevoxeltiles''' '''''<first-tile> <last-tile>'''''

Defines the range of ART-file tiles to replace with the voxel given in the last preceding '''definevoxel''' instruction.

[[Category:All commands]]

Zshoot

2009-05-04T20:42:54Z

One:

'''zshoot''' <[[gamevar|zvel]]> <projectile>

[[Shoot]]s <projectile> with the [[zvel]] <[[gamevar|zvel]]>. Values for <[[gamevar|zvel]]> can be calculated using the [[ldist]] command. These functions are useful for causing an [[actor]] to aim vertically at objects other than the player.

[[Category:EDuke32 specific commands]]
[[Category:Projectile manipulation]]

Xorvarvar

2009-05-04T20:42:41Z

One:

'''xorvarvar''' <gamevar1> <gamevar2>

This function gives the result of a XOR function of the [[gamevar]] <gamevar1> with the [[gamevar]] <gamevar2>. The function checks the bits of the two values being compared, and the bits in the result are set if one, and only one, of the values being operated on has those bits set. See [[xorvar]].

[[Category:EDuke32 specific commands]]
[[Category:Gamevar manipulation]]

Xorvar

2009-05-04T20:42:27Z

One:

'''xorvar''' <[[gamevar]]> <number>

This function gives the result of a XOR function of the [[gamevar]] <gamevar> with <value>. The function checks the bits of the two values being compared, and the bits in the result are set if one, and only one, of the values being operated on has those bits set. See [[xorvarvar]].

Here is an example using xorvar to raise 5 to a power of 2
<pre>
setvar a_number 5
xorvar a_number 2
</pre>

[[Category:EDuke32 specific commands]]
[[Category:Gamevar manipulation]]

Whilevarvarn

2009-05-04T20:42:16Z

One:

'''whilevarvarn''' <gamevar1> <gamevar2> { code to execute }

Executes the code in the curly braces as long as <gamevar1> does not equal <gamevar2>. This is a slightly more advanced while loop than [[whilevarn]].

Caution: Poor execution or endless loops will cause your game to close without error or simply stall and crash!

See [[whilevarn]] for examples.

[[Category:EDuke32 specific commands]]

Whilevarn

2009-05-04T20:42:01Z

One:

'''whilevarn''' <gamevar> <value> { code to execute }

Executes the code in the curly braces as long as <gamevar> does not equal <value>. This is a simple while loop.

Caution: Poor execution or endless loops will cause your game to close without error or simply stall and crash!

An example:
<pre>
gamevar TEMP 0 2
gamevar RANDX 0 2
gamevar RANDY 0 2
gamevar RANDZ 0 2

state troopspawnstate
setvar TEMP 0
whilevarn TEMP 10
{
randvar RANDX 2048
mulvarvar RANDX TEMP
randvar RANDY 2048
mulvarvar RANDY TEMP
randvar RANDZ 2048
mulvarvar RANDZ TEMP

espawn EXPLOSION2 // Spawn an explosion at a random location
setactor[RETURN].x RANDX // that gets progressively further away the
setactor[RETURN].y RANDY // longer that the code executes.
setactor[RETURN].z RANDZ

addvar TEMP 1
}
ends

. . .

state troopcode
. . .

ifaction ATROOPHIDE // Execute the code while the Liztroop
state troopspawnstate // Captain is teleporting in/out.
ifaction ATROOPREAPPEAR
state troopspawnstate

. . .
ends
</pre>

[[Category:EDuke32 specific commands]]

Wackplayer

2009-05-04T20:41:45Z

One:

'''wackplayer'''

Tilts the screen to the side as if the player were struck hard.

[[Category:Duke3D 1.3/1.5 commands]]
[[Category:Player manipulation]]

Userquote

2009-05-04T20:41:24Z

One:

'''userquote''' <quote number>

Causes the quote <quote number> as defined by [[definequote]] to be added to the four line long text buffer that multiplayer kill/death messages and player talk is displayed in. The quotes scroll off of the screen at a rate of one every six seconds. See [[quote]].

[[Category:EDuke32 specific commands]]
[[Category:Screen drawing commands]]

Useractor

2009-05-04T20:40:56Z

One:

'''useractor''' <actortype> <name> <strength> <action> <move> <ai> { actor code } [[enda]]

Similar to [[actor]]. This defines a new [[actor]] in a slightly more specific manner, and it does so without restraining the amount of [[define]]d [[actor]]s. Version 1.3D only allowed so many [[actor]]s so to add a new one required replacing another. Version 1.5 remedied this with useractor.

<actortype> can either be "enemy", "enemystayput", or "notenemy". These terms are defined in DEFS.CON as:

:[[define]] notenemy 0
:[[define]] enemy 1
:[[define]] enemystayput 2

*The "enemy" type makes an [[actor]] that is intended to be used as a character who commences actions on player sight.
*The "enemystayput" works the same as "enemy," except that the [[actor]] will not leave the [[sector]] it is placed in.
*The "notenemy" type was primarily intended to make an [[actor]] that is a decoration or otherwise not a threat to the player. This type of [[actor]] will have no shadow by default, and it will not be targeted if autoaim is enabled. [[Actor]]s using the "notenemy" flag have their code executed at startup. This is extremely useful for coding enemies, as this allows for extended function, and has less quirks than using "enemy" or "enemystayput". A shadow may be applied in Eduke32 using the [[spriteshadow]] command. This is typically used for all new [[actor]]s you may code.

<name> is the name/tile of the [[actor]]. You can either input a defined name, or the tile number directly.

<strength> is the health of the [[actor]]. Also see [[strength]].

<action> is the intial [[action]] an [[actor]] uses (optional).

<move> is the initial [[move]] of the actor (optional).

<ai> is the actor's initial [[ai]] routine (optional).

{ actor code } is obviously the code for the [[actor]].

[[enda]] ends an [[actor]].

Also see [[actor]].

[[Category:Duke3D 1.3/1.5 commands]]
[[Category:Sprite manipulation]]

Updatesectorz

2009-05-04T20:40:31Z

One:

'''updatesectorz''' <x> <y> <z> <gamevar>

Returns [[sector number]] of [[sector]] at (<x>,<y>,<z>) into [[gamevar]] <gamevar>. If the position z is lower than the floor or higher than the ceiling it will return as an invalid sector. See [[updatesector]].

[[Category:EDuke32 specific commands]]
[[Category:Sector manipulation]]

Updatesector

2009-05-04T20:40:18Z

One:

'''updatesector''' <x> <y> <gamevar>

Returns [[sector number]] of [[sector]] at (<x>,<y>) into [[gamevar]] <gamevar>. See [[updatesectorz]]. If it is not a valid sector (like outside the map or inside a column) it is set to -1. You may verify if the actual sector doens't equal to -1 before using [[getsector]] or you can get an warning in the log file.

[[Category:EDuke32 specific commands]]
[[Category:Sector manipulation]]

Tossweapon

2009-05-04T20:40:05Z

One:

'''tossweapon'''

Causes the player to [[spawn]] the currently selected weapon when killed.

[[Category:Duke3D 1.3/1.5 commands]]
[[Category:Player manipulation]]

Tip

2009-05-04T20:39:41Z

One:

'''tip'''

Disables the current or closest player's weapon and displays the "tip" graphic onscreen.

[[Category:Duke3D 1.3/1.5 commands]]
[[Category:Player manipulation]]

Time

2009-05-04T20:38:44Z

One:

'''time''' <gamevar>

This command is being compiled but doing nothing like [[nullop]].

Subvarvar

2009-05-04T20:37:41Z

One:

'''subvarvar''' <gamevar1> <gamevar2>

Subtracts the [[gamevar]] <gamevar2>'s value from <gamevar1>.

[[Category:EDuke commands]]
[[Category:Gamevar manipulation]]

Subvar

2009-05-04T20:37:30Z

One:

'''subvar''' <gamevar> <number>

Subtracts <number> from the [[gamevar]] <gamevar>.

[[Category:EDuke commands]]
[[Category:Gamevar manipulation]]

Strength

2009-05-04T20:37:17Z

One:

'''strength''' <number>

Strength is the amount of health of an [[actor]] has. strength <number> will set an [[actor]]'s health to <number>.

[[Category:Duke3D 1.3/1.5 commands]]
[[Category:Sprite manipulation]]

Stopsoundvar

2009-05-04T20:36:47Z

One:

'''stopsoundvar''' <gamevar>

Stops the playing of the sound number in the variable <gamevar>. See also, [[stopsound]].

[[Category:EDuke32 specific commands]]
[[Category:Sound manipulation]]

Stopsound

2009-05-04T20:36:35Z

One:

'''stopsound''' <sound number>

Stops the playing of the sound in <sound number>. See also, [[stopallsounds]].

[[Category:Duke3D 1.3/1.5 commands]]
[[Category:Sound manipulation]]

Stopallsounds

2009-05-04T20:36:19Z

One:

'''stopallsounds'''

This command allows the stop of every sound playing, much like how escaping to the menu does.

[[Category:EDuke32 specific commands]]
[[Category:Sound manipulation]]

State

2009-05-04T20:35:53Z

One:

A state is a block of code written outside of any [[actor]]s or [[event]]s, that can be called from within them. This is useful because it allows you to use the same code in multiple places without rewriting it.

Syntax for state creation:

'''state''' <name> { state code } [[ends]]

<name> is the name of the state.

{ state code } is the code executed within that state.

[[ends]] denotes the end of a state.

Calling a state within an [[actor]] is simply:

'''state''' <name>

Example code:

<pre>
define MYACTOR1 3585
define MYACTOR2 3586
define MYACTOR3 3587

state spawnblood
ifhitweapon
{
guts JIBS6 12
spawn BLOODPOOL
killit
}
ends

useractor notenemy MYACTOR1 2
state spawnblood
enda

useractor notenemy MYACTOR2 2
state spawnblood
enda

useractor notenemy MYACTOR3 2
state spawnblood
enda
</pre>

Use [[break]] to exit a state before all of it's code is finished executing.

[[Category:Duke3D 1.3/1.5 commands]]

Starttrackvar

2009-05-04T20:35:24Z

One:

'''starttrackvar''' <track#>

starttrackvar is used to change the current background music that is playing. This command works like the [[starttrack]] command but the former can accept gamevars whereas the later accepts only constants.

<track#> is literally the track number of the current episode (which can be detected with the [[gamevar]] [[VOLUME]]) as defined by the [[music]] command.

Example: this will start the music track from episode 3, level 2.

gamevar episode 2 0
gamevar level 1 0
getuserdef[THISACTOR].volume_number TEMP
setuserdef[THISACTOR].volume_number episode
'''starttrackvar''' level
setuserdef[THISACTOR].volume_number TEMP

[[Category:EDuke32 specific commands]]
[[Category:Sound manipulation]]

Starttrack

2009-05-04T20:35:03Z

One:

'''starttrack''' <track#>

This command is used to change the current background music that is playing.

<track#> is literally the track number of the current episode (which can be detected with the [[gamevar]] [[VOLUME]]) as defined by the [[music]] command.

To be able to use another episode's music, change [[volume_number]] as in the example below. Remember that you must change it back to its last value:
getuserdef[THISACTOR].volume_number TEMP
setuserdef[THISACTOR].volume_number 1
starttrack 0
setuserdef[THISACTOR].volume_number TEMP
This will start the music track from episode 2, level 1.

[[Category:EDuke commands]]
[[Category:Sound manipulation]]

Startlevel

2009-05-04T20:34:32Z

One:

'''startlevel''' <gamevar1/parameter1> <gamevar2/parameter2>

Loads the map number <gamevar2/parameter2> of volume number <gamevar1/parameter1>. This simply loads the specified map, bypassing the End of Level screen.

[[Category:EDuke commands]]
[[Category:Game manipulation]]

Sqrt

2009-05-04T20:34:19Z

One:

'''sqrt''' <input [[gamevar|variable]]> <output [[gamevar|variable]]>

Gets the square root of <input variable> and returns the value to <output variable>.

[[Category:EDuke commands]]
[[Category:Gamevar manipulation]]

Spriteshadow

2009-05-04T20:34:06Z

One:

'''spriteshadow''' <tilenum>

Causes [[sprite]] <tilenum> to cast a shadow like an enemy.

[[Category:EDuke commands]]
[[Category:Sprite manipulation]]

Spritepal

2009-05-04T20:33:53Z

One:

'''spritepal''' <number>

Changes the current [[actor]]'s palette reference number to <number>.

The following is a listing of all the legal values for the spritepal primitive. Palettes can effect 3 different 'layers' of a tile. The easiest way to understand these 3 different 'layers' is by using the stripper sprite. The 3 'layers' are: Background (her skin), Foreground (her clothes), and Minor Foreground (money, accessories, etc).

'''A color transformation table''':
1 = all -> blue
2 = all -> red
3 = normal(=0).
4 = all -> black
5 = red -> brown
6 = all -> green with inverted brightness (Night Vision green)
7 = all -> yellow
8 = all -> green
9 = normal(=0)
10 = blue -> dark red
11 = blue -> green(=22)
12 = blue -> gray(=18)
13 = blue -> dark gray red -> grey
14 = blue -> dark green red -> green
15 = blue -> brown
16 = blue -> dark blue
17 = blue -> green green -> blue brown -> blue
18 = blue -> gray(=12)
19 = blue -> gray green -> red brown -> red
20 = blue -> gray green -> blue brown -> blue
21 = blue -> red
22 = blue -> green(=11)
23 = blue -> yellow
24 = red -> gray gray -> red
25 = green -> red

Note that palette 9 is used for player default color. The palette used for Assault Trooper is palette 22.

[[Category:Duke3D 1.3/1.5 commands]]
[[Category:Sprite manipulation]]

Spritenvg

2009-05-04T20:33:40Z

One:

'''spritenvg''' <tilenum>

Causes [[sprite]] <tilenum> to appear as palette 6 to players with nightvision enabled, like an enemy.

[[Category:EDuke32 specific commands]]
[[Category:Sprite manipulation]]

Spritenoshade

2009-05-04T20:33:26Z

One:

'''spritenoshade''' <tilenum>

Causes [[sprite]] <tilenum> to be unaffected by the [[shade]] of the [[sector]] it is in.

If you want an [[actor]] to glow like some projectiles in the game, use this together with [[setactor]]<nowiki>[</nowiki>[[THISACTOR]]<nowiki>]</nowiki>.[[shade]] -127 and/or the [[flash]] parameter.

[[Category:EDuke32 specific commands]]
[[Category:Sprite manipulation]]

Spritenopal

2009-05-04T20:33:15Z

One:

'''spritenopal''' <tilenum>

Causes sprite <tilenum> to keep its initial [[palette|spritepal]] ignoring the palette of the sector it is in.

[[Category:EDuke32 specific commands]]
[[Category:Sprite manipulation]]

Spriteflags

2009-05-04T20:33:02Z

One:

'''spriteflags''' <value>

Sets special flags for sprites. The values are:

'''1''' - Generates a shadow. See [[spriteshadow]]. 
'''2''' - Turns [[spritepal|palette]] 6 whenever night vision goggles are used. See [[spritenvg]]. 
'''4''' - The sprite's shade is unaffected by the shade of its sector. See [[spritenoshade]]. 
'''8''' - Is a [[defineprojectile|projectile]]. 
'''16''' - Prevents teleporting. The sprite is not entered into the [[decal deletion queue]]. 
'''32''' - Is an enemy. See [[useractor]]. 
'''64''' - Sprite will be insusceptible to floor palette of sector containing this sprite. See [[spritenopal]]. 

It is a bitfield, so add together the values you want and then use spriteflags with the sum.

[[Category:EDuke32 specific commands]]
[[Category:Sprite manipulation]]

Spgetlotag

2009-05-04T20:32:46Z

One:

'''spgetlotag'''

Deprecated command. Gets the current [[actor]]'s lotag into the per-actor [[gamevar]] LOTAG.

[[Category:EDuke commands]]
[[Category:Gamevar manipulation]]

Spgethitag

2009-05-04T20:32:17Z

One:

'''spgethitag'''

Deprecated command. Gets the current [[actor]]'s hitag into the per-actor [[gamevar]] HITAG.

[[Category:EDuke commands]]
[[Category:Gamevar manipulation]]

Spawn

2009-05-04T20:31:47Z

One:

'''spawn''' <tilenum>

Adds [[actor]] <tilenum> to the current map, at the position of the [[actor]] that spawned it. <tilenum> can also be a [[define|defined]] value. See [[espawn]], [[qspawn]], [[eqspawn]], [[espawnvar]], [[qspawnvar]], and [[eqspawnvar]]. 

When not used in the specific command sense, spawning is the act of placing a new [[sprite]] into the running game.

[[Category:Duke3D 1.3/1.5 commands]]
[[Category:Sprite manipulation]]

Soundvar

2009-05-04T20:31:33Z

One:

'''soundvar''' <gamevar>

Plays the sound number as determined by <gamevar>. See [[sound]].

[[Category:EDuke commands]]
[[Category:Sound manipulation]]

Soundoncevar

2009-05-04T20:31:19Z

One:

'''soundoncevar''' <[[gamevar]]>

Plays the sound number determined by <[[gamevar]]> as [[soundvar]] command does, but will not start playing again until current instance of sound in <[[gamevar]]> is completed. See [[soundonce]].

[[Category:EDuke32 specific commands]]
[[Category:Sound manipulation]]

Soundonce

2009-05-04T20:31:07Z

One:

'''soundonce''' <sound number>

Plays the sound <sound number> as defined by [[definesound]] the same way that the [[sound]] command does, except that the same sound may not begin playing again until the current instance of it has finished.

[[Category:Duke3D 1.3/1.5 commands]]
[[Category:Sound manipulation]]

Sound

2009-05-04T20:30:55Z

One:

'''sound''' <sound number>

Plays the sound <sound number> as defined by [[definesound]].

[[Category:Duke3D 1.3/1.5 commands]]
[[Category:Sound manipulation]]

Smaxammo

2009-05-04T20:30:38Z

One:

'''smaxammo''' <WeaponID>

Sets the global maximum amount of ammo for <WeaponID>. This change will be displayed in the player's HUD.

[[Category:EDuke32 specific commands]]

Sleeptime

2009-05-04T20:29:59Z

One:

'''sleeptime''' <count>

Changes [[actor]] "sleep" counter to <count>. The actor's "sleep" counter is incremented once per tic if the player is less than 30000 units away. The actor is put back to "sleep" once the counter reaches 32767 and the player is a certain distance away.

[[Category:Duke3D 1.3/1.5 commands]]
[[Category:Sprite manipulation]]

Sizeto

2009-05-04T20:29:47Z

One:

'''sizeto''' <xrepeat> <yrepeat>

Gradually sizes the current [[actor]]'s x and y sizes to the given values. 64 64 is the default sprite size. See [[sizeat]].

[[Category:Duke3D 1.3/1.5 commands]]
[[Category:Sprite manipulation]]

Sizeat

2009-05-04T20:29:35Z

One:

'''sizeat''' <xrepeat> <yrepeat>

Like [[sizeto]], but instantaneous. The default sprite size is 64 64.

Actors with [[xrepeat]] or [[yrepeat]] of zero are deleted. A sizeat 0 0 is the same as killit.

== Notes ==

The default size of most enemy actors is 40 40. Exceptions are SHARK, TANK (60 60) and bosses (80 80).

Changing these values in actor APLAYER (default size: 42 36) will modify the player's view.
This happens because the game is hard-coded to assume that a smaller APLAYER has been shrunk while a larger APLAYER has been "microwaved" by the Expander weapon. In this case:

* Setting a lower xrepeat will replace the player's weapon with two fists.
* Setting a lower yrepeat will set the view at a low angle and prevent the player from jumping.
* Setting a higher xrepeat or yrepeat results in increasing the field of view.

[[Category:Duke3D 1.3/1.5 commands]]
[[Category:Sprite manipulation]]

Sin

2009-05-04T20:29:22Z

One:

'''sin''' <[[gamevar]]> <[[gamevar|gamevar2]]>

Sets <[[gamevar]]> to the sine of the angle defined by <[[gamevar|gamevar2]]>. While in mathematics the hypotenuse has length 1, here it has 16384 (obviously because the engine doesn't support decimal values). Also see [[cos]].

[[Category:EDuke commands]]
[[Category:Gamevar manipulation]]

Shootvar

2009-05-04T20:29:00Z

One:

'''shootvar''' <gamevar>

Causes the current [[actor]] to fire the projectile referenced by <gamevar>. See [[shoot]].

[[Category:EDuke32 specific commands]]
[[Category:Projectile manipulation]]

Shoot

2009-05-04T20:28:49Z

One:

'''shoot''' <tilenum>

Causes the current [[actor]] to fire the projectile <tilenum>.

[[Category:Duke3D 1.3/1.5 commands]]
[[Category:Projectile manipulation]]