Build tools: Difference between revisions

From EDukeWiki
Jump to navigation Jump to search
build tools update to r2597
No edit summary
Line 1: Line 1:
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 eduke32/build/src/util/ directory of the repository or packages.
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 eduke32/build/src/util/ directory of the repository or packages.
==Command-Line Executables==


Windows binaries of the executables can be found here: http://hendricks266.duke4.net/stuff/buildtools_r2597.7z
Windows binaries of the executables can be found here: http://hendricks266.duke4.net/stuff/buildtools_r2597.7z


To build them yourself, see [[Template:Distribution intro|the relevant information]].
To build them yourself, see [[Template:Distribution intro|the relevant information]] to set up the compiler. At the build/ subdirectory of the EDuke32 source code, type <code>make</code> followed by the name of the ''group'' of tool you want to build.
 
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.


==Command-Line Executables==
{| {{prettytable}}
{| {{prettytable}}
!Tool Name!!Main Author!!Description!!
!Tool Name!!Main Author!!Group!!Description!!
|-
|-
|kextract
|kextract
|[[Ken Silverman]]
|[[Ken Silverman]]
|utils
|extracts data from GRP "group files"
|extracts data from GRP "group files"
|-
|-
|kgroup
|kgroup
|[[Ken Silverman]]
|[[Ken Silverman]]
|utils
|creates GRP "group files" out of specified files
|creates GRP "group files" out of specified files
|-
|-
|transpal
|transpal
|[[Ken Silverman]]
|[[Ken Silverman]]
|utils
|generates shading/translucence tables from a palette
|generates shading/translucence tables from a palette
|-
|-
|wad2art
|wad2art
|[[Ken Silverman]]
|[[Ken Silverman]]
|utils
|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]]
|utils
|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
|-
|-
|kmd2tool
|kmd2tool
|[[Ken Silverman]]
|[[Ken Silverman]]
|utils
|translates MD2 models along the z axis (zoffset)
|translates MD2 models along the z axis (zoffset)
|-
|-
|md2tool
|md2tool
|[[Helixhorned]]
|[[Helixhorned]]
|utils
|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]]
|utils
|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]]
|utils
|engine cache information tool; scans all files in current directory
|engine cache information tool; scans all files in current directory
|-
|-
|arttool
|arttool
|[[JonoF]]
|[[JonoF]]
|utils
|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]]
|utils
|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]]
|utils
|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]]
|utils
|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]] (porting by [[Hendricks266]])
|[[JonoF]] (porting by [[Hendricks266]])
|utils
|"Build Customization Suite", imports and extracts game palettes
|"Build Customization Suite", imports and extracts game palettes
|-
|-
|enumdisplay
|enumdisplay
|[[JonoF]]
|[[JonoF]]
|dxutils
|Windows-only; enumerates all available display modes to '''enumdisplay.txt''' by default
|Windows-only; enumerates all available display modes to '''enumdisplay.txt''' by default
|-
|-
|getdxdidf
|getdxdidf
|[[JonoF]]
|[[JonoF]]
|dxutils
|Windows-only; enumerates available inputs, from keyboard, mouse, and joystick to '''didf.txt'''
|Windows-only; enumerates available inputs, from keyboard, mouse, and joystick to '''didf.txt'''
|-
|-
|makesdlkeytrans
|makesdlkeytrans
|[[JonoF]]
|[[JonoF]]
|sdlutils
|SDL-only; builds a key translation table for compatibility purposes
|SDL-only; builds a key translation table for compatibility purposes
|-
|-
Line 89: Line 109:
|-
|-
|}
|}


==Python Scripts==
==Python Scripts==

Revision as of 00:39, 8 April 2012

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 eduke32/build/src/util/ directory of the repository or packages.

Command-Line Executables

Windows binaries of the executables can be found here: http://hendricks266.duke4.net/stuff/buildtools_r2597.7z

To build them yourself, see the relevant information to set up the compiler. At the build/ subdirectory of the EDuke32 source code, type make followed by the name of the group of tool you want to build.

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.

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