Build tools: Difference between revisions

From EDukeWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(One intermediate revision by the same user not shown)
Line 6: Line 6:
'''Windows binaries of the executables can be found here:''' http://dukeworld.duke4.net/eduke32/tools/
'''Windows binaries of the executables can be found here:''' http://dukeworld.duke4.net/eduke32/tools/


To build them yourself, see [[Template:Distribution intro|the relevant information]] to set up the compiler. Type <code>make</code> followed by the name of the ''group'' of tool you want to build.
To build them yourself, see [[Template:Distribution intro|the relevant information]] to set up the compiler. Type <code>make tools</code>. For scripting purposes, <code>make printtools</code> will output a list of all tool names that will be built for a corresponding invocation of <code>make tools</code>.


Note that the tools at the bottom of the list are separated due to cross-platform incompatibilities, and they may require specification of certain variables to the Makefile such as DXROOT_OVERRIDE.
Note that the tools at the bottom of the list are separated due to cross-platform incompatibilities, and they may require specification of certain arguments to the Makefile.


{| {{prettytable}}
{| {{prettytable}}
!Tool Name!!Main Author!!Group!!Description!!
!Tool Name!!Main Author!!Domain!!Description
|-
|-
|kextract
|kextract
|[[Ken Silverman]]
|[[Ken Silverman]]
|tools
|
|extracts data from GRP "group files"
|extracts data from GRP "group files"
|-
|-
|kgroup
|kgroup
|[[Ken Silverman]]
|[[Ken Silverman]]
|tools
|
|creates GRP "group files" out of specified files
|creates GRP "group files" out of specified files
|-
|-
|transpal
|transpal
|[[Ken Silverman]]
|[[Ken Silverman]]
|tools
|
|generates shading/translucence tables from a palette
|generates shading/translucence tables from a palette
|-
|-
|wad2art
|wad2art
|[[Ken Silverman]]
|[[Ken Silverman]]
|tools
|
|novelty utility for converting Doom art resources in WAD files to [[BUILD]] ART files, PALETTE.DAT, and NAMES.H
|novelty utility for converting Doom art resources in WAD files to [[BUILD]] ART files, PALETTE.DAT, and NAMES.H
|-
|-
|wad2map
|wad2map
|[[Ken Silverman]]
|[[Ken Silverman]]
|tools
|
|novelty utility for converting Doom level maps in WAD files to [[BUILD]] map files
|novelty utility for converting Doom level maps in WAD files to [[BUILD]] map files
|-
|-
|map2stl
|map2stl
|[[Ken Silverman]]
|[[Ken Silverman]]
|tools
|
|novelty utility for converting map files to Stereolithography (STL) format 3D models
|novelty utility for converting map files to Stereolithography (STL) format 3D models
|-
|-
|kmd2tool
|kmd2tool
|[[Ken Silverman]]
|[[Ken Silverman]]
|tools
|
|translates MD2 models along the z axis (zoffset)
|translates MD2 models along the z axis (zoffset)
|-
|-
|md2tool
|md2tool
|[[Helixhorned]]
|[[Helixhorned]]
|tools
|
|query MD2 model info or change the scale/translate fields so that desired bounds are produced
|query MD2 model info or change the scale/translate fields so that desired bounds are produced
|-
|-
|generateicon
|generateicon
|[[JonoF]]
|[[JonoF]]
|tools
|
|converts images (.ico? .bmp?) to .c files for the purpose of being embedded as icons in SDL executables
|converts images (.ico? .bmp?) to .c files for the purpose of being embedded as icons in SDL executables
|-
|-
|cacheinfo
|cacheinfo
|[[JonoF]]
|[[JonoF]]
|tools
|
|cache information tool; scans all files in current directory
|cache information tool; scans all files in current directory
|-
|-
|arttool
|arttool
|[[JonoF]], [[Hendricks266]]
|[[JonoF]], [[Hendricks266]]
|tools
|
|constructs all attributes of ART files and can import art tiles in PCX and TGA formats
|constructs all attributes of ART files and can import art tiles in PCX and TGA formats
|-
|-
|givedepth
|givedepth
|[[JonoF]]
|[[JonoF]]
|tools
|
|transforms a single image from an ART tile into a voxel with the image layered to a specified depth
|transforms a single image from an ART tile into a voxel with the image layered to a specified depth
|-
|-
|mkpalette
|mkpalette
|[[JonoF]]
|[[JonoF]]
|tools
|
|inputs simple color ranges in HSV format and automatically generates a palette with shade steps
|inputs simple color ranges in HSV format and automatically generates a palette with shade steps
|-
|-
|unpackssi
|unpackssi
|[[JonoF]]
|[[JonoF]]
|tools
|
|unpacks the SSI files employed to hold the data of Sunstorm Interactive expansion packs
|unpacks the SSI files employed to hold the data of Sunstorm Interactive expansion packs
|-
|-
|bsuite
|bsuite
|[[JonoF]], [[Hendricks266]]
|[[JonoF]], [[Hendricks266]]
|tools
|
|"Build Customization Suite", imports and extracts game palettes
|"Build Customization Suite", imports and extracts game palettes
|-
|-
|ivfrate
|ivfrate
|[[Helixhorned]]
|[[Helixhorned]]
|tools
|
|gets and sets the FPS of .ivf (VP8) files
|gets and sets the FPS of .ivf (VP8) files
|-
|-
|enumdisplay
|enumdisplay
|[[JonoF]]
|[[JonoF]]
|dxtools
|Windows-only
|Windows-only; enumerates all available display modes to '''enumdisplay.txt''' by default
|enumerates all available display modes to '''enumdisplay.txt''' by default
|-
|-
|getdxdidf
|getdxdidf
|[[JonoF]]
|[[JonoF]]
|dxtools
|Windows-only
|Windows-only; enumerates available inputs, from keyboard, mouse, and joystick to '''didf.txt'''
|enumerates available inputs, from keyboard, mouse, and joystick to '''didf.txt'''
|-
|-
|makesdlkeytrans
|makesdlkeytrans
|[[JonoF]]
|[[JonoF]]
|sdltools
|SDL-only
|SDL-only; builds a key translation table for compatibility purposes
|builds a key translation table for compatibility purposes
|-
|-
|}
|}

Latest revision as of 15:39, 22 March 2017

The Build tools are sub-components of EDuke32 and the BUILD Engine that assist the user in various editing functions. Their source code can be found in the source/tools/ directory of the repository or packages.

Command-Line Executables

Windows binaries of the executables can be found here: http://dukeworld.duke4.net/eduke32/tools/

To build them yourself, see the relevant information to set up the compiler. Type make tools. For scripting purposes, make printtools will output a list of all tool names that will be built for a corresponding invocation of make tools.

Note that the tools at the bottom of the list are separated due to cross-platform incompatibilities, and they may require specification of certain arguments to the Makefile.

Tool Name Main Author Domain Description
kextract Ken Silverman extracts data from GRP "group files"
kgroup Ken Silverman creates GRP "group files" out of specified files
transpal Ken Silverman generates shading/translucence tables from a palette
wad2art Ken Silverman novelty utility for converting Doom art resources in WAD files to BUILD ART files, PALETTE.DAT, and NAMES.H
wad2map Ken Silverman novelty utility for converting Doom level maps in WAD files to BUILD map files
map2stl Ken Silverman novelty utility for converting map files to Stereolithography (STL) format 3D models
kmd2tool Ken Silverman translates MD2 models along the z axis (zoffset)
md2tool Helixhorned query MD2 model info or change the scale/translate fields so that desired bounds are produced
generateicon JonoF converts images (.ico? .bmp?) to .c files for the purpose of being embedded as icons in SDL executables
cacheinfo JonoF cache information tool; scans all files in current directory
arttool JonoF, Hendricks266 constructs all attributes of ART files and can import art tiles in PCX and TGA formats
givedepth JonoF transforms a single image from an ART tile into a voxel with the image layered to a specified depth
mkpalette JonoF inputs simple color ranges in HSV format and automatically generates a palette with shade steps
unpackssi JonoF unpacks the SSI files employed to hold the data of Sunstorm Interactive expansion packs
bsuite JonoF, Hendricks266 "Build Customization Suite", imports and extracts game palettes
ivfrate Helixhorned gets and sets the FPS of .ivf (VP8) files
enumdisplay JonoF Windows-only enumerates all available display modes to enumdisplay.txt by default
getdxdidf JonoF Windows-only enumerates available inputs, from keyboard, mouse, and joystick to didf.txt
makesdlkeytrans JonoF SDL-only builds a key translation table for compatibility purposes

Bash Scripts

Tool Name Main Author Description
checkdefs.sh Helixhorned find wrongly-cased file names in defs (and cons hackishly) and optionally replace them with the proper names

Python Scripts

Tool Name Main Author Description
ase_import.py Plagman ASE importer for Blender 2.4x
md3_export.py Plagman MD3 exporter for Blender 2.4x
highpalookupmaker.py Plagman simplistic highpallookup generator using only math and the TGA data
prhighpal.py Helixhorned slightly more complex highpallookup generator requiring Python 2.6, NumPy and PIL