DeuTex FAQ
-
1. When I extract the contents of the Heretic iwad, why are
CREDIT,E2END,FINAL1,FINAL2,HELP1,HELP2andTITLEextracted intolumps/and not intographics/? -
They're extracted into
lumps/because that's what they are. Thegraphics/directory is for images that are in the in the so-called "picture" format, described in section [5-1] of the UDS (HTTP link). Those lumps are not in picture format, they're just straight bitmaps (320 × 200 pixels, 64,000 bytes).The distinction may seem academic, but it isn't. If those lumps were extracted into
graphics/, it would be impossible to compose your wad correctly afterwards. In the wad created by DeuTex,CREDITand friends would be in the picture format while the engine expects them to be in the 64000-byte matrix format. -
2. When I extract the contents of the Hexen iwad, why are
CREDIT,FINALE1,FINALE2,FINALE3,HELP1,HELP2,INTERPICandTITLEextracted intolumps/and not intographics/? -
See question 1.
- 3. I've composed a wad. When I play it, the transparent areas in the graphics look opaque and blue or grey, like this :
-
This is what happens when you try to use DeuTex 4 on files extracted by DeuTex 3 or WinTex.
It happens because DeuTex 3 and WinTex use (0, 255, 255) (cyan) for transparent areas while DeuTex 4 uses (0, 47, 47) (dark blue-green). Therefore, what looks like a transparent pixel to DeuTex 3 and WinTex just looks like an opaque, cyan pixel to DeuTex 4. The closest match to cyan in the Doom palette is (115, 115, 255) (blue-mauve) so that's what you get.
Try one of the following :
- convert your files to use (0, 47, 47) instead of (0, 255, 255),
- recreate your files using DeuTex 4,
-
recreate your files using DeuTex 3 with the "
-rgb 0 47 47" option, - recreate your files using WinTex using the appropriate option (if it exists),
-
when composing, give DeuTex 4 the "
-rgb 0 255 255" option.
-
4. The musics are extracted into
lumps/. -
This has been fixed in version 4.4.
- 5. When composing, is there a way to include only the resources actually used by the levels ?
-
No. Though it would certainly be nice to have.
AYM 2005-08-29
deutex-4.4.902/docsrc/hackers_guide.html 0000644 0003245 0003245 00000005062 10304554306 017533 0 ustar aym aym 0000000 0000000Hacker's guide
Endianness
Some files contain numbers that have a fixed endianness, independent from the endianness of the CPU DeuTex happens to run on. These call for some special treatment, as the C language has no provision for reading and writing integers otherwise than in the native endianness.
-
To read an integer from a file with a particular endianness, use
fread_i16_le(),fread_i16_be(),fread_i32_le()andfread_i32_be(). The first argument is the file descriptor, the second argument is a pointer on a variable that will receive the value read from the file. -
To write an integer to a file with a particular endianness, use
fwrite_i16_le(),fwrite_i16_be(),fwrite_i32_le()andfwrite_i32_be(). The first argument is the file descriptor, the second argument is the value to write. -
To read an integer with a particular endianness from a memory area, use
read_i16_le(),read_i16_be(),read_i32_le()andread_i32_be(). The first argument is a pointer on the memory area, the second argument is a pointer on a variable that will receive the value read from the memory area. Alternatively, you can use thepeek_i*()functions that take no second argument but instead return the read value. -
To write an integer with a particular endianness to a memory area, use
write_i16_le(),write_i16_be,write_i32_le()andwrite_i32_be(). The first argument is a pointer on the memory area, the second argument is the value to write.
Mnemonic to remember the arguments order : the object that has a defined endianness is considered central and therefore always comes first.
Here is some sample code and the result of running it.
fwrite_i32_be (stdout, 0x12345678); fwrite_i32_le (stdout, 0x12345678); fwrite_i16_be (stdout, 0xabcd); fwrite_i16_le (stdout, 0xabcd);
12 34 56 78 78 56 34 12 AB CD CD ABdeutex-4.4.902/docsrc/readme.dos 0000644 0003245 0003245 00000002225 10301444206 016004 0 ustar aym aym 0000000 0000000 DeuTex $VERSION - DOS binary distribution WHAT ARE DEUTEX AND DEUSF DeuTex and DeuSF are programs than can do many things with Doom, Heretic, Hexen and Strife wad files such as extracting and inserting graphics, sounds, levels and other resources. See the manual for details (dtexman6.txt). This is a binary distribution. It only contains a DOS pre-compiled executable and the user documentation. The source and the rest of the documentation are in deutex-$VERSION.tar.gz. INSTALLING Copy deutex.exe and deusf.exe in a directory of your PATH. LEGAL DeuTex is Copyright Olivier Montanuy 1994-1995 and Copyright André Majorel 1999-2005 and available under the terms of the GPL, except lzw.c which is Copyright David Koblas and others and available under the terms of the PBMPLUS license. See the LICENSE file. All trademarks are the property of their owners. CONTACT Home page : http://www.teaser.fr/~amajorel/deutex/ Doom questions : news:rec.games.computer.doom.editing DeuTex questions : The Yadex mailing list (http://www.teaser.fr/~amajorel/yadex/lists.html) -- AYM $SELF_DATE deutex-4.4.902/docsrc/todo.html 0000644 0003245 0003245 00000035102 10305107536 015701 0 ustar aym aym 0000000 0000000
To-do list for DeuTex
Directives file
-
In the directives file and textures files, "
include" directive to include the rest of another block/file. -
In the directives file and textures files, allow references to environment
variables (E.G.
$E(name)). -
In the directives file and textures files, allow user variables (E.G.
$(name)) - Make it easier to let a texture have a description identical to another texture
- In the directives file, add a mean to import all/only named/all except named flats as patches.
- In the directives file, add a mean to import all/only named/all except named patches as flats. This implies 1) accepting flats larger than 64×64 (by clipping) 2) converting transparent pixels to a certain colour (which one ?).
- In the directives file, add a mean to automatically generate a texture for all/only named/all except named patches. The height of the automatic texture is 128, its width is the least power of two wide enough to contain the patch. The automatic texture is filled with the patch by tiling, starting from the top left corner. The name of the automatic texture is the name of the patch.
- Wherever an image is imported, give the option of applying graphical transforms: crop, tile, rotate, mirror, roll, colour.
- Wherever an image is imported, give the option of composing the image from several files. This would be particularly useful for flats, which cannot be composed from several patches like textures do. This might complicate the wadinfo.txt syntax, though.
-
Instead of allowing any and all characters in the script file, require them
to be quoted.
And, when doing
-xtract, produce the script file with the appropriate quotes... Since, under Unix, the only characters that are not allowed in a file name are NUL and "/", I don't see why DeuTex should prevent users from extracting lumps with weird characters in their names. However, that might cause compatilibity problems with the DOS version. - When composing, warn about invalid sections (E.G. "
[poo]").
Game support
- Doom alpha
GNUM[0-9]:- find name for 10x12, preferably ending in "p" (xxx),
- implement
IDENTxxx(), - add
[xxx]section towadinfo.txt, -
make list of lumps that used to go in
lumps/and now go inxxx/and put that inchanges.html, - create corresponding
-sprites-like option
-
When extracting the Doom alpha 0.2 iwad, "
Can't find PNAMES in wad". - Doom alpha 0.4 and 0.5:
MENUMAPis not supported. -
DeuTex should not look for
doom.wadin the directory set by-heretic! - Heretic:
E2ENDis extracted with the wrong palette. -
Hexen: does not extract graphics quite correctly (applies transparent
colour translation to opaque images such as
FINALE1andFINALE2). This is probably related to [1]. - Strife: compile scripts.
- Strife: what else is missing ?
- ROTT: add
-rottand remove theROTTmacro. -
ROTT: use
AP_PALinstead ofPALfor the Apogee thing. -
ROTT: work on the identification (
ANIMSTRT,EXITSTRT,EXITSTOP,ABVWSTART,ABVMSTRT,HMSKSTRT,GUNSTART,ELEVSTRT/ELEVSTOP,DOORSTRT/DOORSTOP,SIDESTRT/SIDESTOP,MASKSTRT/MASKSTOP,UPDNSTRT/UPDNSTOP,SKYSTART/SKYSTOP,SKYSTART/SKYSTOP,ORDRSTRT/ORDRSTOP,ORDRSTRT/ORDRSTOP,SPECMAPS,PLAYMAPSSHAPSTRT/SHAPSTOP,DIGISTRT/DIGISTOP,SONGSTRT,PCSTRT/PCSTOP,ADSTRT/ADSTOP). - ROTT: seems to implement lump aliases by pointing to the same offset as an other lump. All lumps but the last have a zero size.
Graphics
-
The presence of the GIF routines might push DeuTex into the non-free
section of Debian.
Would it be sufficient to
#ifdefthem out ? -
Determine why converting Doom graphics to PPM and back does not yield the same thing. This also happens with BMP but much less so.
Update 2000-01-04 : for example, with Heretic, patch
WALL17has its (4Eh, 50h, 4Dh) pixels turned into (4Eh, 4Eh, 4Eh). It seems DeuTex sometimes uses a close match even when an exact match exists.PPM and GIF do not agree with each other. An extract/build round trip on the Ultimate Doom iwad does not produce the same wad on DOS as it does on Unix because the default format on DOS is GIF. If you extract with
-ppmon DOS, you do get the same wad you do on Unix. -
Bug: some flats seem to be extracted with certain pixels set to the
transparent colour (Doom's
CEIL4_1). DeuTex 3.6 for DOS exhibits the same problem [1]. -
Building seems to be slower than extracting.
Perhaps
RAWtoPIC()could use some optimization. - Include the Gimp and PSP palettes in the distribution.
-
For people who have old graphics files generated by DeuTex 3 with cyan (0,
255, 255) as the transparent colour : it would be nice if DeuTex 4
could import those files automatically.
The way I see it, if no transparent pixel has been found in an image so far
and if a cyan pixel is found, a warning is emitted ("
Warning: xxxxxxxx.xxx: assuming the transparent colour is cyan.") and the transparent colour for this image is set to cyan. This would make for a smooth transition from DeuTex 3 to DeuTex 4. There should be a command-line switch to disable that feature. -
Sneas are supported when doing
-xtractbut not when doing-build(they're ignored). Fix that, or at least mention it somewhere. Though I don't see many people wanting to make wads for Doom alpha anyway...
Sound
-
Regarding audio support, Matthew W. Miller
<
mattm=infinet+com> offered the following comment on 1999-07-04 :Audio handling in deutex (I'm referring to the irix 5.3 version's included source code) is, I believe, based on dmgraph, but is pretty dire in any case.
[...]
Also, one would hope that eventually one or more of the source ports will start to support bitrates other than 8 bit, and (maybe?) stereo samples. You may want to start leaning on various source ports' programmers to get their acts together and start coming to some sort of agreement. ;)
Importation of .wav files is pretty crufty. Like dmgraph before it, the deutex 5.3 source expects there to be just one big 'data' chunk, and doesn't notice the 'info' chunks that certain stupid Windows programs (*cough*cough*CoolEdit*GoldWave*cough*) insist on putting in (usually with copyright messages for the program itself, which in a just world would be illegal). Greater explanation of all this whacky chunk business can be found at:
http://www.compsoc.man.ac.uk/~maniac/resource_web/wav_file_format/(wav1.htm, wav2.htm, wav3.htm, 4.htm, 5.htm)Essentially, you want to clip out the first 'data' chunk and ignore crap like 'info', 'inam', 'list', or whatever.
-
Fix this :
atc4:/doom/dev/test/wav/16$ deutex -doom /doom/doom -xtract ../16bit44k.wad DeuTex 4.0.3 Main directory: /doom/doom. Extracting entries from WAD ../16bit44k.wad Reading WAD /doom/doom/doom.wad: (2306 entries) Reading WAD ../16bit44k.wad: (1 entries) PWAD entry identification...done Color palette is Doom Warning: ** Appending to file ./wadinfo.txt ** Extracting Levels... Extracting Lumps... Extracting Sounds... Bug: *** not a WAVE *** Please report that bug.
- Look into importing sounds as .wav's. What are the highest supported sample rates and resolution ? Seems to depend on the engine.
Command line
-
The command line interface is not always intuitive and it's fussy about the
position of certain options.
-iwadseems to be ineffective if placed last.-xtractand friends must be placed last if they don't have all their arguments. - Options shouldn't care whether there is space between them and their argument. Hmm... or should they ?
-
-checkshouldn't require an argument. It should use the iwad by default. -mainshould be implemented for DeuTex as well.-
Matthew Miller wants to be able to specify the name of the iwad instead of
just its path (this is how it should have been done from the start, IMHO).
Possible ways to do that :
-
stat()the argument to-doom,-heretic, etc. If it's a file and not a directory, use that. -
Look for a different basename in the iwad directory, depending on the
option through which the directory was specified. E.G. if it was set
with
-doom2, look fordoom2.wadfirst. And ifdoom2.wadwas not found, emit a warning.-doomand-hereticshould look for all basenames because that's what previous versions of DeuTex did. -
Add an option to specify the name of the iwad file, without specifying
which iwad it is and let DeuTex guess what needs to be guessed.
Apparently, there's already such an option (
-main) but it's for DeuSF only. Why ?
-
-
Add
-V(equivalent to--version). Include the URL of the original distribution archive ?
Documentation
- It's in shambles.
- Mention that negative patch Y-offsets are forced to 0 by the engine.
- Mention that sneaps are extracted but not built.
- Man page: mention that some options are DeuTex-only, not DeuSF.
-
Document the messages.
What I have in mind :
which expands to :$(msg AB34 w "Sneeze %{name}s: %{num}f dB > 100 dB, bad for straw huts" $("fname (pathname)" "strerror (errno)") $<Sneeze $p name is louder than 100 dB. Versions of House lesser than Wood will collapse.$> )
and :Warning("Sneeze %s: %f dB > 100 dB, bad for straw huts", fname (pathname), strerror (errno));.TP \fBAB34 Sneeze \fIname\fB: \fInum\fB dB > 100 dB, bad for straw huts\fR Sneeze \fIname\fP is louder than 100 dB. Versions of House lesser than Wood will collapse.
Platform
- Borland C: to revive the port, must find a way to make all pointers implicitly huge.
Misc.
-
TBD: New options
-fstartand-fendto control the start-of-flats and end-of-flats markers used in pwads. Default toFF_STARTandF_ENDrespectively. Warning: here again, don't use those options just because they're here. The default markers are perfectly fine, and they conform to the de-facto standard. If you deviate from them, you're asking for trouble. -
-f_end -
Why does "
deutex -ipf alpha -doom .. -sprites -graphics -patches -xtract" trigger"Error: *** Can't open file ./lumps/titlepic.lmp ***" ? -
todo.htmlgrows faster thanchanges.html. Fix that.;-) -
-usedidx: don't count sneats (-nosneats?). -
The dependencies on
deutex.hare missing in the makefile. - Integrate AJA's patch compression patch.
- Change text file line numbers from shorts to longs.
-
If you
-xtractdoom.wad twice then build, you get either a PA90 bug or a wad that's twice as big as the original. -
PrintInit()is called way too late. All error messages relative to parsing the command line will be written to standard error, not the specified file (asFile). Options that setasFileshould be honour in the first pass. -
The fact that
Info(),Detail()andPhase()write to standard output is wrong if you take the stance that the real distinction between stdout and stderr is not information vs. error but "data to be processed by the next filter in the pipe" vs. "messages to be read by a human".If so, need to check that all uses of
Output()are indeed "pipeable". Also, is it right to copyOutput()to the log ?
", "picture format (\1alpha\3, *\1normal\3, \1pr\3, \1rott\3)"},
{OP2,1,"itf", COMtf, "", "input texture format (\1nameless\3, \1none\3, *\1normal\3, \1strife11\3)"},
{OP2,1,"itl", COMitl, "", "texture lump (\1none\3, *\1normal\3, \1textures\3)"},
{OP2,0,"iwad", COMiwad, NULL, "compose iwad, not pwad"},
{OP2,0,"le", COMle, NULL, "assume all wads are little endian (default)"},
{OP2,0,"musid", COMmusid, NULL, "use old music identification method"},
{OP2,0,"obe", COMobe, NULL, "create big endian wads (default LE)"},
{OP2,0,"ole", COMole, NULL, "create little endian wads (default)"},
{OP2,1,"otf", COMtf, "", "output texture format (\1nameless\3, \1none\3, *\1normal\3, \1strife11\3)"},
/*by request from George Hamlin*/
{OP2,0,"s_end", COMgeorge, NULL, "use \1S_END\3 for sprites, not \1SS_END\3"},
{OP2,1,"tf", COMtf, "", "texture format (\1nameless\3, \1none\3, *\1normal\3, \1strife11\3)"},
#endif /*DeuTex*/
{SEC,0,NULL, NULL, NULL, "Lump selection"},
{OP2,0,"flats", COMflat, NULL, "select flats"},
#ifdef DeuTex
{OP2,0,"graphics", COMgraphic, NULL, "select graphics"},
{OP2,0,"levels", COMlevel, NULL, "select levels"},
{OP2,0,"lumps", COMlump, NULL, "select lumps"},
{OP2,0,"musics", COMmusic, NULL, "select musics"},
{OP2,0,"patches", COMpatch, NULL, "select patches"},
{OP2,0,"scripts", COMscripts, NULL, "select Strife scripts"},
{OP2,0,"sneas", COMsneas, NULL, "select sneas (sneaps and sneats)"},
{OP2,0,"sneaps", COMsneaps, NULL, "select sneaps"},
{OP2,0,"sneats", COMsneats, NULL, "select sneats"},
{OP2,0,"sounds", COMsound, NULL, "select sounds"},
#endif /*DeuTex*/
{OP2,0,"sprites", COMsprit, NULL, "select sprites"},
#ifdef DeuTex
{OP2,0,"textures", COMtextur, NULL, "select textures"},
#endif /*DeuTex*/
#ifdef DeuTex
{SEC,0,NULL, NULL, NULL, "Graphics"},
{OP2,0,"bmp", COMbmp, NULL, "save pictures as BMP (\1.bmp\3)"},
{OP2,0,"gif", COMgif, NULL, "save pictures as GIF (\1.gif\3)"},
{OP2,0,"ppm", COMppm, NULL, "save pictures as rawbits PPM (P6, \1.ppm\3)"},
{OP2,3,"rgb", COMrgb, " ", "specify the transparent colour (default 0 47 47)"},
#endif
#ifdef DeuTex
{SEC,0,NULL, NULL, NULL, "Sound"},
{OP2,0,"au", COMau, NULL, "save sounds as Sun audio (\1.au\3)"},
{OP2,0,"fullsnd", COMfullsnd, NULL, "save sounds beyond declared length"},
{OP2,1,"rate", COMrate, "", "policy for != 11025 Hz (\1reject\3, \1force\3, *\1warn\3, \1accept\3)"},
{OP2,0,"voc", COMvoc, NULL, "save sounds as voc (\1.voc\3)"},
{OP2,0,"wav", COMwave, NULL, "save sounds as WAVE (\1.wav\3)"},
#endif
{SEC,0,NULL, NULL, NULL, "Reporting"},
#ifdef DeuTex
{OP2,1,"di", COMdi, "", "debug identification of entry"},
{OP1,1,"log", COMlog, "", "name of log file (default \1deutex.log\3)"},
#elif defined DeuSF
{OP1,1,"log", COMlog, "", "name of log file (default \1deusf.log\3)"},
#endif
{OP2,0,"v0", COMverbose, NULL, "set verbosity level to 0"},
{OP2,0,"v1", COMverbose, NULL, "set verbosity level to 1"},
{OP2,0,"v2", COMverbose, NULL, "set verbosity level to 2 (default)"},
{OP2,0,"v3", COMverbose, NULL, "set verbosity level to 3"},
{OP2,0,"v4", COMverbose, NULL, "set verbosity level to 4"},
{OP2,0,"v5", COMverbose, NULL, "set verbosity level to 5"},
{SEC,0,NULL, NULL, NULL, "WinTex-related options"},
#ifdef DeuTex
{OP2,5,"win", COMwintxn, "