|
|
| (19 intermediate revisions by 4 users not shown) |
| Line 1: |
Line 1: |
| DEF files are parsed scripts which allow definition of textures, 3D models, miscellaneous settings, higher-quality sounds and music, and more.
| | <div style="column-count:3;-moz-column-count:3;"> |
| | === Setup === |
|
| |
|
| Comments can be used by prefixing the text with a double forward-slash <code>//</code>, or surrounding the text with <code>/* (comment here) */</code>.
| | * [[cachesize (DEF)|cachesize]] |
| | * [[define (DEF)|define]] |
| | * [[grpinfo|grpinfo]] |
| | * [[include (DEF)|include]] |
| | * [[includedefault (DEF)|includedefault]] |
| | * [[loadgrp (DEF)|loadgrp]] |
| | * [[noautoload (DEF)|noautoload]] |
|
| |
|
| __TOC__
| | === Global === |
|
| |
|
| ==Setup==
| | * [[globalgameflags (DEF)|globalgameflags]] |
| | * [[numalphatables (DEF)|numalphatables]] |
| | * [[shadefactor (DEF)|shadefactor]] |
| | * [[globalflags (DEF)|globalflags]] |
|
| |
|
| =====include===== | | === Palettes === |
| {{Def table1}}
| |
|
| |
|
| <span {{Def element}}>include <i><filename></i></span><br />
| | * [[basepalette (DEF)|basepalette]] |
| <span {{Def element}}>#include <i><filename></i></span>
| | * [[blendtable (DEF)|blendtable]] |
| | * [[highpalookup (DEF)|highpalookup]] |
| | * [[nofloorpalrange (DEF)|nofloorpalrange]] |
| | * [[nofullbrightrange (DEF)|nofullbrightrange]] |
| | * [[palookup (DEF)|palookup]] |
| | * [[fogpal (DEF)|fogpal]] |
| | * [[makepalookup (DEF)|makepalookup]] |
| | * [[tint (DEF)|tint]] |
|
| |
|
| Processes the script commands in <i><filename></i> at the point of the <b>include</b> call.
| | === Definitions === |
|
| |
|
| {{Def table2}}
| | * [[artfile (DEF)|artfile]] |
| | * [[animsounds (DEF)|animsounds]] |
| | * [[animtilerange (DEF)|animtilerange]] |
| | * [[model (DEF)|model]] |
| | * [[music (DEF)|music]] |
| | * [[newgamechoices (DEF)|newgamechoices]] |
| | * [[skybox (DEF)|skybox]] |
| | * [[sound (DEF)|sound]] |
| | * [[texture (DEF)|texture]] |
| | * [[tile (DEF)|tile]] |
| | * [[tilefont (DEF)|tilefont]] |
| | * [[tilefromtexture (DEF)|tilefromtexture]] |
| | * [[voxel (DEF)|voxel]] |
|
| |
|
| =====includedefault===== | | === Un-definitions === |
| {{Def table1}}
| |
|
| |
|
| <span {{Def element}}>includedefault</span><br />
| | * [[undefbasepaletterange (DEF)|undefbasepaletterange]] |
| <span {{Def element}}>#includedefault</span>
| | * [[undefblendtablerange (DEF)|undefblendtablerange]] |
| | * [[undefinetile (DEF)|undefinetile]] |
| | * [[undefinetilerange (DEF)|undefinetilerange]] |
| | * [[undefmodel (DEF)|undefmodel]] |
| | * [[undefmodelof (DEF)|undefmodelof]] |
| | * [[undefmodelrange (DEF)|undefmodelrange]] |
| | * [[undefpalookuprange (DEF)|undefpalookuprange]] |
| | * [[undeftexture (DEF)|undeftexture]] |
| | * [[undeftexturerange (DEF)|undeftexturerange]] |
|
| |
|
| Processes the script commands in the default .def file at the point of the <b>include</b> call. Only useful for command-line overrides.
| | === Misc === |
|
| |
|
| For Duke Nukem 3D, the file is duke3d.def. For NAM, it is nam.def. For WWII GI, it is ww2gi.def.
| | * [[copytile (DEF)|copytile]] |
| | * [[cutscene (DEF)|cutscene]] |
| | * [[dummytile (DEF)|dummytile]] |
| | * [[dummytilefrompic (DEF)|dummytilefrompic]] |
| | * [[dummytilerange (DEF)|dummytilerange]] |
| | * [[echo (DEF)|echo]] |
| | * [[mapinfo (DEF)|mapinfo]] |
| | * [[multipsky (DEF)|multipsky]] |
| | * [[setuptile (DEF)|setuptile]] |
| | * [[setuptilerange (DEF)|setuptilerange]] |
| | * [[texhitscanrange (DEF)|texhitscanrange]] |
|
| |
|
| {{Def table2}}
| | === Mapster32 === |
|
| |
|
| =====define=====
| | * [[2dcol (DEF)|2dcol]] |
| {{Def table1}}
| | * [[2dcolidxrange (DEF)|2dcolidxrange]] |
| | * [[alphabet (DEF)|alphabet]] |
| | * [[spritecol (DEF)|spritecol]] |
| | * [[spritehotkey (DEF)|spritehotkey]] |
| | * [[tilegroup (DEF)|tilegroup]] |
|
| |
|
| <span {{Def element}}>define <i><label> <integer-value></i></span><br />
| | === Deprecated commands === |
| <span {{Def element}}>#define <i><label> <integer-value></i></span>
| |
|
| |
|
| Declares <i><label></i> to represent the numeric value <i><integer-value></i>. <i><integer-value></i> can be a label, in which case the value of the label given is used.
| | * [[alphahack (DEF)|alphahack]] |
| | * [[alphahackrange (DEF)|alphahackrange]] |
| | * [[definemodel (DEF)|definemodel]] |
| | * [[definemodelanim (DEF)|definemodelanim]] |
| | * [[definemodelframe (DEF)|definemodelframe]] |
| | * [[definemodelskin (DEF)|definemodelskin]] |
| | * [[defineskybox (DEF)|defineskybox]] |
| | * [[definetexture (DEF)|definetexture]] |
| | * [[definetint (DEF)|definetint]] |
| | * [[definevoxel (DEF)|definevoxel]] |
| | * [[definevoxeltiles (DEF)|definevoxeltiles]] |
| | * [[selectmodelskin (DEF)|selectmodelskin]] |
|
| |
|
| NOTE: You may find it convenient to include DEFS.CON or NAMES.H to predefine many of the tile (and sound) names in the art file.
| | </div> |
|
| |
|
| {{Def table2}}
| | __NOTOC__ |
| | |
| =====loadgrp=====
| |
| {{Def table1}}
| |
| | |
| <span {{Def element}}>loadgrp <i><.grp\.zip file></i></span>
| |
| | |
| The DEF equivalent of the <b>/g</b> command line switch.
| |
| | |
| {{Def table2}}
| |
| | |
| =====noautoload=====
| |
| {{Def table1}}
| |
| | |
| <span {{Def element}}>noautoload</span>
| |
| | |
| Disables the autoload dir feature.
| |
| | |
| {{Def table2}}
| |
| | |
| =====cachesize=====
| |
| {{Def table1}}
| |
| | |
| <span {{Def element}}>cachesize <i><size></i></span>
| |
| | |
| Specifies the size of the cache in Kb. Don't use this unless you know what you are doing.
| |
| | |
| {{Def table2}}
| |
| | |
| ==Color Palettes==
| |
| | |
| | |
| =====tint=====
| |
| {{Def table1}}
| |
| <span {{Def element}}>tint <i>{ ... }</i></span>
| |
| | |
| Defines a Hightile texture tint to simulate palette effects normally used on ART-file tiles.
| |
| | |
| Example:
| |
| | |
| tint { pal 1 red 127 green 127 blue 255 flags 0 }
| |
| tint { pal 2 green 127 blue 127 }
| |
| | |
| The brace-enclosed block may contain these instructions:
| |
| | |
| : <span {{Def subelement}}>pal <i><palnum></i></span>
| |
| | |
| : The palette number the tint applies to.
| |
| | |
| : <span {{Def subelement}}>red <i><value></i></span> (or <span {{Def subelement}}>r <i><value></i></span>)<br />
| |
| : <span {{Def subelement}}>green <i><value></i></span> (or <span {{Def subelement}}>g <i><value></i></span>)<br />
| |
| : <span {{Def subelement}}>blue <i><value></i></span> (or <span {{Def subelement}}>b <i><value></i></span>)
| |
| | |
| : 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.
| |
| | |
| : <span {{Def subelement}}>flags <i><flags></i></span>
| |
| | |
| : 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<br />
| |
| : 1 = convert to greyscale<br />
| |
| : 2 = invert colors
| |
| | |
| {{Def table2}}
| |
| | |
| =====fogpal=====
| |
| {{Def table1}}
| |
| | |
| <span {{Def element}}>fogpal <i><palette number> <red intensity> <green intensity> <blue intensity></i></span>
| |
| | |
| <b>fogpal</b> defines a palette a sector-based fog effect. To use it, change the pal of your sector to the pal defined with <b>fogpal</b>.
| |
| | |
| 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.
| |
| | |
| {{Def table2}}
| |
| | |
| =====makepalookup=====
| |
| | |
| {{Def table1}}
| |
| <span {{Def element}}>makepalookup <i>{ ... }</i></span>
| |
| | |
| Interface to creating palette lookups containing both color index remapping (only in effect for non-hightile textures) and fog. This is in contrast to '''fogpal''', which always resets the remapping to the identity mapping ("pal 0").
| |
| | |
| | |
| The brace-enclosed block may contain these instructions:
| |
| | |
| : <span {{Def subelement}}>pal <i><palnum></i></span>
| |
| | |
| : The palette number, must be from 1 to 250.
| |
| | |
| : <span {{Def subelement}}>red <i><value></i></span> (or <span {{Def subelement}}>r <i><value></i></span>)<br />
| |
| : <span {{Def subelement}}>green <i><value></i></span> (or <span {{Def subelement}}>g <i><value></i></span>)<br />
| |
| : <span {{Def subelement}}>blue <i><value></i></span> (or <span {{Def subelement}}>b <i><value></i></span>)
| |
| | |
| : Specifies a color component value, in the range of 0 to 63. Unspecified components are assumed to be 0 and any out of range values are clamped to the maximum or minimum as appropriate.
| |
| | |
| : <span {{Def subelement}}>remappal <i><palnum></i></span>
| |
| | |
| : The palette number to take the index remapping from, i.e. 21 for blue -> red. When absent, defaults to 0.
| |
| | |
| : <span {{Def subelement}}>remapself</span>
| |
| | |
| : The same as '''remappal''' ''<palnum>'', where ''<palnum>'' is the number provided for the '''pal''' token.
| |
| | |
| | |
| '''Examples'''<br/>
| |
| | |
| This creates palookup 200 with a fog of (30,0,0) and a blue-to-yellow remapping (assuming it has not been changed before):
| |
| makepalookup { pal 200 red 30 remappal 23 }
| |
| | |
| This 'fogifies' palookup 21 with a red fog:
| |
| makepalookup { pal 21 red 30 remapself }
| |
| | |
| This overwrites palookup 21 with a red fog, but clears the blue-to-red remapping:
| |
| makepalookup { pal 21 red 30 }
| |
| | |
| {{Def table2}}
| |
| | |
| == Definitions ==
| |
| | |
| ===8-Bit .ART File Replacements===
| |
| | |
| | |
| =====tilefromtexture=====
| |
| {{Def table1}}
| |
| | |
| <span {{Def element}}>tilefromtexture <tilenum> <i>{ ... }</i></span>
| |
| | |
| Used to generate an 8-bit tile from an image file. Use the alpha channel for transparency instead of the pink color.
| |
| | |
| : <span {{Def subelement}}>file <i><filename></i></span><br />
| |
| : <span {{Def subelement}}>name <i><filename></i></span>
| |
| | |
| : <span {{Def subelement}}>alphacut <i><value></i></span>
| |
| | |
| In addition to working when you are adding an image file as an art tile, the following parameters can also be used without specifying a file to ''modify'' the attributes of an existing ART tile.
| |
| | |
| : <span {{Def subelement}}>xoffset <i><value></i></span><br />
| |
| : <span {{Def subelement}}>xoff <i><value></i></span>
| |
| | |
| : <span {{Def subelement}}>yoffset <i><value></i></span><br />
| |
| : <span {{Def subelement}}>yoff <i><value></i></span>
| |
| | |
| : <span {{Def subelement}}>texhitscan</span><br />
| |
| : <span {{Def subelement}}>nofullbright</span>
| |
| | |
| {{Def table2}}
| |
| | |
| =====animtilerange=====
| |
| {{Def table1}}
| |
| | |
| <span {{Def element}}>animtilerange <i><tilenum1> <tilenum2> <speed value> <animation value></i></span>
| |
| | |
| Sets an animation range identical to the ones embedded in the .ART files.
| |
| | |
| Speed value ranges from 0 to 15, 0 being the fastest.
| |
| | |
| Values are:
| |
| | |
| 0 = none<br />
| |
| 1 = oscillating<br />
| |
| 2 = forward<br />
| |
| 3 = backward
| |
| | |
| {{Def table2}}
| |
| | |
| =====voxel=====
| |
| {{Def table1}}
| |
| | |
| <span {{Def element}}>voxel <i><filename> { ... }</i></span>
| |
| | |
| 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:
| |
| | |
| : <span {{Def subelement}}>tile <i><tilenum></i></span><br />
| |
| : <span {{Def subelement}}>tile0 <i><tilenum></i></span><br />
| |
| : <span {{Def subelement}}>tile1 <i><tilenum></i></span>
| |
| | |
| : Use these instructions to map tiles that should be rendered as a voxels. Use <b>tile</b> to map a single tile to be rendered as voxels and <b>tile0</b>, <b>tile1</b> together define a range of tiles to be rendered as voxels. The <b>tile0</b> instruction should appear before the <b>tile1</b> instruction to define a correct range.
| |
| | |
| : <span {{Def subelement}}>scale <i><value></i></span>
| |
| | |
| : <i><value></i> 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.
| |
| | |
| {{Def table2}}
| |
| | |
| ===High Resolution Art===
| |
| | |
| | |
| =====texture=====
| |
| {{Def table1}}
| |
| <span {{Def element}}>texture <i><tilenum> { ... }</i></span>
| |
| | |
| Defines a Hightile texture to replace an ART-file tile. <i><tilenum></i> may be a number, or a defined label.
| |
| | |
| Example:
| |
| | |
| texture 3586 {
| |
| pal 0 { file "mymod/tree.png" }
| |
| pal 21 { file "mymod/tree_red.png" xscale 2.0 yscale 2.0 alphacut 0 nodownsize nocompress }
| |
| glow { file "mymod/tree_light.png" }
| |
| detail { file "mymod/plant_texture.png" scale 0.5 }
| |
| }
| |
| | |
| The brace-enclosed block may contain these instructions:
| |
| | |
| : <span {{Def subelement}}>pal <i><palnum> { ... }</i></span>
| |
| | |
| : Replaces the palette <i><palnum></i>. 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:
| |
| | |
| :: <span {{Def subelement}}>file <i><filename></i></span> (or <span {{Def subelement}}>name <i><filename></i></span>)
| |
| | |
| :: Defines which texture file to use. File may be any PNG, JPG, DDS, TGA, BMP, GIF or PCX file. This instruction must be supplied.
| |
| | |
| :: <span {{Def subelement}}>alphacut <i><cutoff-value></i></span>
| |
| | |
| :: 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.
| |
| | |
| :: <span {{Def subelement}}>nocompress</span>
| |
| | |
| :: Prevents the texture from being compressed using S3TC if texture compression is enabled.
| |
| | |
| :: <span {{Def subelement}}>nodownsize</span>
| |
| | |
| :: Prevents the texture from being downsized.
| |
| | |
| :: <span {{Def subelement}}>xscale <i><value></i></span><br />
| |
| :: <span {{Def subelement}}>yscale <i><value></i></span>
| |
| | |
| :: Sets the scale of the hightile texture in relation to the original texture. A <i><value></i> 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. <b>xscale</b> (aka <b>scale</b>, <b>detailscale</b>, <b>intensity</b>) sets the horizontal scale and <b>yscale</b> sets the vertical scale.
| |
| | |
| : <span {{Def subelement}}>detail <i>{ ... }</i></span>
| |
| | |
| : Defines a [[Detail_mapping|detail texture]] for the texture. The brace-enclosed block may contain these instructions:
| |
| | |
| :: <span {{Def subelement}}>file <i><filename></i></span>
| |
| | |
| :: Specifies which detail texture file to use. File may be any PNG, JPG, DDS, TGA, BMP, GIF or PCX file. This instruction must be supplied.
| |
| | |
| :: <span {{Def subelement}}>scale <i><value></i></span>
| |
| | |
| :: <i><value></i> 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).
| |
| | |
| : <span {{Def subelement}}>glow <i>{ ... }</i></span>
| |
| | |
| : Defines a [[Glow_mapping|glow map]] for the texture. The brace-enclosed block may contain these instructions:
| |
| | |
| :: <span {{Def subelement}}>file <i><filename></i></span>
| |
| | |
| :: Specifies which glow map file to use. This instruction must be supplied.
| |
| | |
| {{Def table2}}
| |
| | |
| =====skybox=====
| |
| {{Def table1}}
| |
| | |
| <span {{Def element}}>skybox <i>{ ... }</i></span>
| |
| | |
| Defines a skybox that overrides a parallaxing floor or ceiling in OpenGL rendering modes.
| |
| | |
| Example:
| |
| skybox {
| |
| tile 3586 pal 0
| |
| front "mymod/sky_1.png" nocompress
| |
| right "mymod/sky_2.png" nocompress
| |
| back "mymod/sky_3.png" nocompress
| |
| left "mymod/sky_4.png" nocompress
| |
| top "mymod/sky_5.png" nocompress
| |
| down "mymod/sky_6.png" nocompress
| |
| }
| |
| | |
| The brace-enclosed block may contain these instructions:
| |
| | |
| : <span {{Def subelement}}>tile <i><tilenum></i></span>
| |
| | |
| : Specifies the ART file tile to override.
| |
| | |
| : <span {{Def subelement}}>pal <i><palnum></i></span>
| |
| | |
| : Specifies the palette number the skybox should happen for.
| |
| | |
| : <span {{Def subelement}}>front <i><filename></i></span> (or <span {{Def subelement}}>Front</span> / <span {{Def subelement}}>ft</span> / <span {{Def subelement}}>forward</span>)<br />
| |
| : <span {{Def subelement}}>right <i><filename></i></span> (or <span {{Def subelement}}>rt</span> / <span {{Def subelement}}>right</span>)<br />
| |
| : <span {{Def subelement}}>back <i><filename></i></span> (or <span {{Def subelement}}>bk</span> / <span {{Def subelement}}>back</span>)<br />
| |
| : <span {{Def subelement}}>left <i><filename></i></span> (or <span {{Def subelement}}>lf</span> / <span {{Def subelement}}>left</span>) / <span {{Def subelement}}>lt</span>)<br />
| |
| : <span {{Def subelement}}>top <i><filename></i></span> (or <span {{Def subelement}}>up</span> / <span {{Def subelement}}>top</span> / <span {{Def subelement}}>ceiling</span> / <span {{Def subelement}}>ceil</span>)<br />
| |
| : <span {{Def subelement}}>down <i><filename></i></span> (or <span {{Def subelement}}>dn</span> / <span {{Def subelement}}>bottom</span> / <span {{Def subelement}}>floor</span> / <span {{Def subelement}}>down</span>)
| |
| | |
| : Defines a single face of the skybox where facename may be any of these keywords appropriate for the face in question:
| |
| | |
| : NOTE: All six faces are required to be specified.
| |
| | |
| {{Def table2}}
| |
| | |
| =====model=====
| |
| {{Def table1}}
| |
| | |
| <span {{Def element}}>model <i><filename> { ... }</i></span>
| |
| | |
| Defines a model to replace certain sprites in the game when running in 32-bit OpenGL mode. <i><filename></i> is the model file in md2 or md3 format.
| |
| | |
| Note: md2 is considered deprecated.
| |
| | |
| The brace-enclosed block may contain these instructions:
| |
| | |
| : <span {{Def subelement}}>scale <i><value></i></span>
| |
| | |
| : <i><value></i> 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.
| |
| | |
| : <span {{Def subelement}}>shade <i><shade-offset></i></span>
| |
| | |
| : <i><shade-offset></i> 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.
| |
| | |
| : <span {{Def subelement}}>zadd <i><offset></i></span>
| |
| | |
| : <i><offset></i> 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.
| |
| | |
| : <span {{Def subelement}}>flags <i><flags></i></span>
| |
| | |
| : Specifies any special properties the model should have, the values of which should be added together to combine multiple options.
| |
| : 0: default value<br />
| |
| : 1: Prevents the the model from being affected by the tints.<br />
| |
| | |
| : <span {{Def subelement}}>skin <i>{ ... }</i></span>
| |
| | |
| : Defines a skin to be used on the model for all frames declared after this command. The brace-enclosed block may contain these instructions:
| |
| | |
| :: <span {{Def subelement}}>pal <i><palnum></i></span>
| |
| | |
| :: Specifies which palette this skin maps to.
| |
| | |
| :: <span {{Def subelement}}>surface <i><surfnum></i></span>
| |
| | |
| :: Specifies which MD3 surface this skin should be applied to. This has no significance for MD2 models.
| |
| | |
| :: <span {{Def subelement}}>file <i><filename></i></span>
| |
| | |
| :: Specifies the texture file to use for the skin. File may be any PNG, JPG, DDS, 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.
| |
| | |
| : <span {{Def subelement}}>anim <i>{ ... }</i></span>
| |
| | |
| : Defines an animation from a group of frames in the model. The brace-enclosed block may contain these instructions:
| |
| | |
| :: <span {{Def subelement}}>frame0 <i><framename></i></span><br />
| |
| :: <span {{Def subelement}}>frame1 <i><framename></i></span>
| |
|
| |
| :: Specifies the names of the start (<b>frame0</b>) and end (<b>frame1</b>) frames of the animation.
| |
| | |
| :: <span {{Def subelement}}>fps <i><fps></i></span>
| |
| | |
| :: Specifies the frame rate at which the animation should play. This value may be fractional.
| |
| | |
| :: <span {{Def subelement}}>flags <i><flags></i></span>
| |
| | |
| :: 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)<br />
| |
| :: 1 one-shot (plays beginning to end once and stops on the last frame).
| |
| | |
| : <span {{Def subelement}}>frame <i>{ ... }</i></span>
| |
| | |
| : 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:
| |
| | |
| :: <span {{Def subelement}}>name <i><framename></i></span><br />
| |
| :: <span {{Def subelement}}>frame <i><framename></i></span>
| |
| | |
| :: If <i><framename></i> 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 <b>frame</b> or <b>name</b> versions of this instruction as both are identical.
| |
| | |
| :: <span {{Def subelement}}>tile <i><tilenum></i></span><br />
| |
| :: <span {{Def subelement}}>tile0 <i><tilenum></i></span><br />
| |
| :: <span {{Def subelement}}>tile1 <i><tilenum></i></span>
| |
| | |
| :: Use the tile instruction to specify an ART-file tile which this model should replace. Use the <b>tile0</b> and <b>tile1</b> instructions together to specify a range of ART-file tiles. If you use <b>tile0</b>, you must also have a <b>tile1</b>. You may not use the same instruction twice to specify multiple ranges.
| |
| | |
| :: <span {{Def subelement}}>smoothduration <i><value></i></span>
| |
| | |
| :: 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 <i><value></i> seconds.
| |
| | |
| :: <span {{Def subelement}}>pal <i><value></i></span>
| |
| | |
| :: Makes the model definition exclusive for the this pal. This allow to assign different models for different pal.
| |
| | |
| : <span {{Def subelement}}>hud <i>{ ... }</i></span>
| |
| | |
| : Defines a range of ART-file tiles to use with a heads-up-display. The brace-enclosed block may contain these instructions:
| |
| | |
| :: <span {{Def subelement}}>tile <i><tilenum></i></span><br />
| |
| :: <span {{Def subelement}}>tile0 <i><tilenum></i></span><br />
| |
| :: <span {{Def subelement}}>tile1 <i><tilenum></i></span>
| |
| | |
| :: <b>tile0</b> and <b>tile1</b> 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.
| |
|
| |
| :: <span {{Def subelement}}>xadd <i><offset></i></span><br />
| |
| :: <span {{Def subelement}}>yadd <i><offset></i></span><br />
| |
| :: <span {{Def subelement}}>zadd <i><offset></i></span><br />
| |
| :: <span {{Def subelement}}>angadd <i><offset></i></span>
| |
| | |
| :: Use these offsets to fine-tune the location of the model placement. <b>xadd</b>, <b>yadd</b>, and <b>zadd</b> are position offsets relative to the viewer's orienation. You can use floating point values with them. <b>angadd</b> is a Build angle offset. (512 90 degrees, 1024 180 degrees, etc...).
| |
| | |
| :: <span {{Def subelement}}>hide</span>
| |
| | |
| :: 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.
| |
| | |
| :: <span {{Def subelement}}>nobob</span>
| |
| | |
| :: By default, the HUD model offset is affected by the player bobbing offset when the player is walking. Use this option to disable that.
| |
| | |
| :: <span {{Def subelement}}>flipped</span>
| |
| | |
| :: 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.
| |
| | |
| :: <span {{Def subelement}}>nodepth</span>
| |
| | |
| :: 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 icon 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.
| |
| | |
| : <span {{Def subelement}}>detail <i>{ ... }</i></span>
| |
| | |
| : Defines a [[Detail_mapping|detail texture]] for the model. The brace-enclosed block may contain these instructions:
| |
| | |
| :: <span {{Def subelement}}>file <i><filename></i></span>
| |
| | |
| :: Specifies which detail texture file to use. File may be any PNG, JPG, DDS, TGA, BMP, GIF or PCX file. This instruction must be supplied.
| |
| | |
| :: <span {{Def subelement}}>scale <i><value></i></span>
| |
| | |
| :: <i><value></i> 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).
| |
| | |
| :: <span {{Def subelement}}>surface <i><surfnum></i></span>
| |
| | |
| :: Specifies which MD3 surface this detail texture should be applied to. This has no significance for MD2 models.
| |
| | |
| : <span {{Def subelement}}>glow <i>{ ... }</i></span>
| |
| | |
| : Defines a [[Glow_mapping|glow map]] for the model. The brace-enclosed block may contain these instructions:
| |
| | |
| :: <span {{Def subelement}}>file <i><filename></i></span>
| |
| | |
| :: Specifies which glow map file to use. This instruction must be supplied.
| |
| | |
| :: <span {{Def subelement}}>surface <i><surfnum></i></span>
| |
| | |
| :: Specifies which MD3 surface this glow map should be applied to. This has no significance for MD2 models.
| |
| | |
| {{Def table2}}
| |
| | |
| ===Audio===
| |
| | |
| | |
| =====music=====
| |
| {{Def table1}}
| |
| <span {{Def element}}>music <i>{ ... }</i></span>
| |
| | |
| Example:
| |
| music { id "E1L1" file "stalker1.ogg" }
| |
| music { id "intro" file "grabbag.ogg" }
| |
| music { id "briefing" file "briefing.ogg" }
| |
| music { id "loading" file "menusng2.flac" }
| |
| | |
| : <span {{Def subelement}}>id <i><value></i></span>
| |
| | |
| : <i><value></i> is "intro", "briefing", "loading" or "E'''x'''L'''y'''" (where x is the episode and y is the level).<br />
| |
| | |
| : <span {{Def subelement}}>file <i><filename></i></span>
| |
| | |
| : Specifies which audio file to use. File types: MIDI, Ogg Vorbis, FLAC
| |
| | |
| {{Def table2}}
| |
| | |
| =====sound=====
| |
| {{Def table1}}
| |
| <span {{Def element}}>sound <i>{ ... }</i></span>
| |
| | |
| Example:
| |
| sound { id "249" file "bonus.ogg" }
| |
| | |
| : <span {{Def subelement}}>id <i><value></i></span>
| |
| | |
| : Specifies the ID of sound. The ID can be found in DEFS.CON. '''NOTE:''' This should only be used for HRP-like replacement of existing sounds. New sounds should use [[definesound]].
| |
| | |
| : <span {{Def subelement}}>file <i><filename></i></span>
| |
| | |
| : Specifies which audio file to use. File types: WAV, VOC, Ogg Vorbis, FLAC
| |
| | |
| {{Def table2}}
| |
| | |
| =====animsounds=====
| |
| {{Def table1}}
| |
| <span {{Def element}}>animsounds <anim> <i>{ frame1 sound1 frame2 sound2 ... }</i></span>
| |
|
| |
| '''<anim>''' has to be one of the following tokens corresponding to hard-coded Duke3D anims:
| |
| * cineov2: Episode 2 ending
| |
| * cineov3: Episode 3 ending
| |
| * RADLOGO: "Come back to bed, Duke..."
| |
| * DUKETEAM: Duke3D team still
| |
| * logo: Intro nuke logo
| |
| * vol41a: Episode 4 intro 1
| |
| * vol42a: Episode 4 intro 2
| |
| * vol43a: Episode 4 intro 3
| |
| * vol4e1: Episode 4 ending 1
| |
| * vol4e2: Episode 4 ending 2
| |
| * vol4e3: Episode 4 ending 3
| |
| | |
| The '''frame'''''N'''s (1-based frame numbers) have to be in ascending order. They do not need to be strictly ascending, so that a frame may have more than one sound.
| |
| | |
| Example: for Duke3D's XBLA nuke logo animation (IVF extracted from nuke.webm),
| |
| the following definition overlays the video with a sound sequence similar
| |
| (identical save for timing) to the original nuke animation:
| |
| // frame 1: FLY_BY, frame 64: PIPEBOMB_EXPLODE
| |
| animsounds logo { 1 244 64 14 }
| |
| {{Def table2}}
| |
| | |
| == 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 [http://hendricks266.duke4.net/nw_plus.php Duke: Nuclear Winter Plus] by [[Hendricks266]]. (see [http://svn.eduke32.com/nw_plus/nwinter/undef.def undef.def])
| |
| | |
| | |
| | |
| =====undeftexture=====
| |
| {{Def table1}}
| |
| <span {{Def element}}>undeftexture <i><tile></i></span><br />
| |
| <span {{Def element}}>undeftexturerange <i><tile0> <tile1></i></span>
| |
| | |
| This is for undefining Hightile textures.
| |
| | |
| {{Def table2}}
| |
| | |
| =====undefmodel=====
| |
| {{Def table1}}
| |
| <span {{Def element}}>undefmodel <i><tile></i></span><br />
| |
| <span {{Def element}}>undefmodelrange <i><tile0> <tile1></i></span><br />
| |
| <span {{Def element}}>undefmodelof <i><tile></i></span><sup>1</sup>
| |
| | |
| This is for undefining 3D models.
| |
| | |
| With <b>undefmodelof</b> all the tiles grouped together within the same .def code block are un-defined.
| |
| | |
| <sup>1</sup>Support of <b>undefmodelof</b> is disabled indefinitely due to problems with its implementation.
| |
| | |
| {{Def table2}}
| |
| | |
| == Misc ==
| |
| | |
| | |
| | |
| =====dummytile=====
| |
| {{Def table1}}
| |
| | |
| <span {{Def element}}>dummytile <i><tilenum> <x-dimension> <y-dimension></i></span><br />
| |
| <span {{Def element}}>dummytilerange <i><tilenum1> <tilenum2> <x-dimension> <y-dimension></i></span>
| |
| | |
| Used in DEF files to create a blank tile at location <b><''tilenum''></b> of the dimensions <b><''x-dimension''></b> and <b><''y-dimension''></b>. This allows the creation of placeholder tiles for use with definetexture\texture without having to edit .ART files.
| |
| | |
| '''NOTE:''' In most circumstances '''setuptile''' is a better command to use, unless you specifically want black boxes.
| |
| | |
| {{Def table2}}
| |
| | |
| =====setuptile=====
| |
| {{Def table1}}
| |
| | |
| <span {{Def element}}>setuptile <i><tilenum> <x-dimension> <y-dimension> <x-offset> <y-offset></i></span><br />
| |
| <span {{Def element}}>setuptilerange <i><tilenum1> <tilenum2> <x-dimension> <y-dimension> <x-offset> <y-offset></i></span>
| |
| | |
| 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 <b>dummytile</b> this command won't draw black squares and accepts offsets.
| |
| | |
| It doesn't affect 8-bit tiles or HUD images.
| |
| | |
| {{Def table2}}
| |
| | |
| =====dummytilefrompic=====
| |
| {{Def table1}}
| |
| | |
| <span {{Def element}}>dummytilefrompic <i><tileID> <file></i></span>
| |
| | |
| {{Def table2}}
| |
| | |
| == Mapster32 ==
| |
| | |
| | |
| | |
| =====2dcol=====
| |
| {{Def table1}}
| |
| | |
| <span {{Def element}}>2dcol <i><colornum> <red> <green> <blue></i></span>
| |
| | |
| <b>2dcol</b> is a definition of a color to be used in the 2D mode of [[Mapster32]], in conjunction with <b>spritecol</b> that works similarly to <b>tint</b> and <b>definetint</b>. <i><colornum></i> is a unique identifier, similar to [[define|defines]] and [[gamevar|gamevars]]. <i><red></i>, <i><green></i>, and <i><blue></i> 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 <b>all</b> the sprites. You truly have the power to customize Mapster32. Lime green 2D mode background, anyone?
| |
| | |
| {{Def table2}}
| |
| | |
| =====spritecol=====
| |
| {{Def table1}}
| |
| | |
| <span {{Def element}}>spritecol <i><tilenum> <normalcolornum> <blockingcolornum></i></span>
| |
| | |
| <b>spritecol</b> 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]]). <b><''normalcolornum''></b> is the <b><''colornum''></b> of the <b>2dcol</b> definition of your color for the standard sprite color as defined by <b><''tilenum''></b>. The same goes for <b><''blockingcolornum''></b>, 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.
| |
| | |
| {{Def table2}}
| |
| | |
| =====spritehotkey=====
| |
| {{Def table1}}
| |
| | |
| <span {{Def element}}>spritehotkey <i><key> <spriteID></i></span>
| |
| | |
| 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.
| |
| | |
| {{Def table2}}
| |
| | |
| =====tilegroup=====
| |
| {{Def table1}}
| |
| | |
| <span {{Def element}}>tilegroup <i><groupname> { ... }</i></span>
| |
| | |
| Defines group for the tile selector (press 'T'). Mapster32 loads TILES.CFG on startup.
| |
| | |
| : <span {{Def subelement}}>tile <i><tilenum></i></span><br />
| |
| : <span {{Def subelement}}>tilerange <i><tilenum1> <tilenum2></i></span><br />
| |
| : <span {{Def subelement}}>tiles <i>{ <tile1> <tile2> ... <tileN> }</i></span>
| |
| | |
| : Adds tiles to the group. Names can be found in DEFS.CON.
| |
| | |
| : <span {{Def subelement}}>hotkey <i><value></i></span>
| |
| | |
| : Specifies the hotkey for the group.
| |
| | |
| : <span {{Def subelement}}>colors <i><value1> <value2></i></span>
| |
| | |
| : Colors are the colors for Blocking OFF and Blocking ON.
| |
| | |
| {{Def table2}}
| |
| | |
| =====alphabet=====
| |
| {{Def table1}}
| |
| | |
| <span {{Def element}}>alphabet <i>{ ... }</i></span>
| |
| | |
| Defines alphabet for the input text feature (Ctrl+T). Mapster32 loads TILES.CFG on startup.
| |
| | |
| : <span {{Def subelement}}>map <i><value> <tile></i></span>
| |
| | |
| : <span {{Def subelement}}>mapa <i><string> <tile></i></span>
| |
| | |
| : <span {{Def subelement}}>maprange <i><value1> <value2> <tile></i></span>
| |
| | |
| : <span {{Def subelement}}>maprangea <i><char1> <char2> <tile></i></span>
| |
| | |
| : <span {{Def subelement}}>offset <i><value> <offset></i></span>
| |
| | |
| : <span {{Def subelement}}>offseta <i><string> <offset></i></span>
| |
| | |
| {{Def table2}}
| |
| | |
| == Deprecated Commands ==
| |
| | |
| | |
| | |
| =====definetexture=====
| |
| {{Def table1}}
| |
| | |
| <span {{Def element}}>definetexture <i><tile-number> <palette-number> <x-center> <y-center> <x-size> <y-size> <filename></i></span>
| |
| | |
| Defines a Hightile texture to replace an ART-file picture. <i><tile-number></i> may be an number, or a defined label. Use a value of 0 for <i><x-center></i> and <i><y-center></i> and a value of -1 for <i><x-size></i> and <i><y-size></i> for now until these values are actually used. <i><filename></i> may be any PNG, JPG, DDS, TGA, BMP, GIF, or PCX file.
| |
| | |
| {{Def table2}}
| |
| | |
| =====definetint=====
| |
| {{Def table1}}
| |
| | |
| <span {{Def element}}>definetint <i><palette-number> <red> <green> <blue> <flags></i></span>
| |
| | |
| Defines a Hightile texture tint to simulate palette effects normally used on ART-file tiles. <i><red></i>, <i><green></i>, and <i><blue></i> are numbers in the range 0 to 255 which specify the color the tint should look like. <i><flags></i> specifies any processing effects to use. Valid values are:
| |
| | |
| 0 no effects<br />
| |
| 1 convert to greyscale<br />
| |
| 2 invert colours<br />
| |
| | |
| These values can be added together to produce a combination of effects.
| |
| | |
| {{Def table2}}
| |
| | |
| =====defineskybox=====
| |
| {{Def table1}}
| |
| | |
| <span {{Def element}}>defineskybox <i><tile-number> <palette-number> <reserved> <front-face-filename> <right-face-filename> <back-face-filename> <left-face-filename> <top-face-filename> <bottom-face-filename></i></span>
| |
| | |
| Defines a sky-box composed of six images mapped onto the faces
| |
| of a cube to be used when <i><tile-number></i> is set as parallaxing in 32-bit OpenGL mode. <i><reserved></i> should be 0 for now until its meaning is fully conceived.
| |
| | |
| {{Def table2}}
| |
| | |
| =====definemodel=====
| |
| {{Def table1}}
| |
| | |
| <span {{Def element}}>definemodel <i><filename> <scale> <shade-offset></i></span>
| |
| | |
| Defines an MD2/3-format model file to replace certain sprites in the game. See <b>definemodelframe</b> and <b>definemodelanim</b> for details on how to specify the ART-file tiles to replace. <i><filename></i> is the name of the MD2/3 model. <i><scale></i> 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. <i><shade-offset></i> 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.
| |
| | |
| : <span {{Def subelement}}>definemodelskin <i><palette-number> <filename></i></span>
| |
| | |
| : Defines a skin to be used on the model for all frames declared after this command, when the sprite palette is equal to <i><palette-number></i>. (This makes more sense when given a demonstration.) IMPORTANT: If your model exists in a subdirectory (ie. <b>definemodel</b> 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.
| |
| | |
| : <span {{Def subelement}}>selectmodelskin <i><skin ID></i></span>
| |
| | |
| : Selects a model skin.
| |
| | |
| : <span {{Def subelement}}>definemodelanim <i><start-frame> <end-frame> <frame-rate> <flags></i></span>
| |
| | |
| : Defines an animation from a group of frames in the model given by the last preceding <b>definemodel</b> instruction. <i><start-frame></i> and <i><end-frame></i> specify the names of the starting and ending frames of the animation. <i><frame-rate></i> is the frame rate at which the animation should play. This value can be fractional. <i><flags></i> specifies any special properties the animation should have. Valid options are:
| |
| | |
| : 0 none (looping animation)<br />
| |
| : 1 one-shot (plays beginning to end once and stops on the last frame)
| |
| | |
| : <span {{Def subelement}}>definemodelframe <i><frame-name> <first-tile> <last-tile></i></span>
| |
| | |
| : Defines a range of ART-file tiles to correspond with the given frame of the model specified in the last preceding <b>definemodel</b> instruction. <i><frame-name></i> is the name of the frame, which if identical to the starting frame of a <b>definemodelanim</b> animation will play that animation. If <i><frame-name></i> is not corresponding with an animation, the replacement will be static. <i><first-tile></i> and <i><last-tile></i> specify a range of ART-file tiles which this model frame should replace.
| |
| | |
| {{Def table2}}
| |
| | |
| =====definevoxel=====
| |
| {{Def table1}}
| |
| | |
| <span {{Def element}}>definevoxel <i><filename></i></span><br />
| |
| <span {{Def element}}>definevoxeltiles <i><first-tile> <last-tile></i></span>
| |
| | |
| Defines a voxel to replace sprites in the game. <i><filename></i> is the name of the .KVX file containing the voxel.
| |
| | |
| <b>definevoxeltiles</b> defines the range of ART-file tiles to replace with the voxel.
| |
| | |
| {{Def table2}}
| |
| | |
| =====alphahack=====
| |
| {{Def table1}}
| |
| | |
| <span {{Def element}}>alphahack <i><tilenum> <value></i></span><br />
| |
| <span {{Def element}}>alphahackrange <i><tilenum1> <tilenum2> <value></i></span><br />
| |
| | |
| <b>alphahack</b> is a deprecated command previously used to improve alpha filtering of highres art of <i><tilenum></i>. <i><value></i> is always -1.
| |
| | |
| {{Def table2}}
| |