PC Home 32

home *** CD-ROM | disk | FTP | other *** search

/ PC Home 32 / PC_HOME_95-uncompressed-cd-image.iso / heretic / nwt / nwt.doc < prev next >

Wrap

Text File | 1995-01-20 | 29.6 KB | 585 lines

NewWadTool NWT v1.3 Copyright (c) 1/95 by Denis Möller, TiC, denis@doomsday.shnet.org Documentation -------------------------------------------------------------------------- Index: [ 1] - Introduction & Legal stuff [ 2] - Credits [ 3] - Description [ 4] - Requirements [ 5] - Setup [ 6] - Using NWT (short global view) [ 7] - Viewing graphic and playing sound resources [ 8] - Extracting resources (export) [ 9] - Inserting resources (import) [10] - Editing textures [11] - Viewing/Editing PNames resources [12] - Using Sprites & Flats in PWADs [13] - Working with PWADs [14] - Batch mode commands [15] - Versions, Changes, Bug fixes - History [16] - Error messages [17] - Restrictions, Future plans -[ 1]- Introduction & Legal stuff -------------------------------------------------------------------------- Use NWT at your own risk. The software in this archive is distributed "as is" without warrenty of any kind. The author is not liable for any direct or indirect damage caused as a result of using this program. The software is distributed as Freeware. NO fee or payment may be charged for this program. You are not allowed to change the program. Doom & Doom 2 are trademarks of id software - of course :) Heretic was developed by Raven Software for id Software DEU is written by Raphaël Quinet & Brendon J Wyber. DeuTex & DeuSF are written by Olivier Montanuy. Dmaud & Dmgraph are written by Bill Neisius. Dmadds/f are written by Bernd Kreimeier. -[ 2]- Credits -------------------------------------------------------------------------- Thanks to - id software, raven software - Raphaël Quinet & Brendon J Wyber for the great editor utility - Hank Leukart / Matt Fell for the Doom Specs - Vladimir (Wladows) Arnost, QA-Software (xarnos00@dcse.fee.vutbr.cz) for the MUS-player - DJ Ski for the nice asm-listing of DoomView I can't get it working with NWT ;( - but I'm working on it. - Olivier Montanuy for many, many helpful advices! NWT is completely written in plain Turbo C with a lot of assembly routines. The GIF save/load routines are taken from a SimTel CD, author unknown. The MUS-player is written by Vladimir Arnost. No other parts of the source were taken from other programs. NOTE: NWT will not be converted for any other system. Get DeuTex & DeuSF if using another system. If you prefer batch-wad-editing try DeuTex, DMGraph or DMaud. THIS VERSION DOES NOT WORK WITH SHAREWARE-DOOM/HERETIC ANYMORE! -[ 3]- Description -------------------------------------------------------------------------- With NWT you got a very powerful tool in your hands. NWT will offer you the following things to do with your Doom, Doom 2 or Heretic WADs: - extract (export) any kind of resource saving it to GIF, PCX, WAV, VOC, RAW or WAD (PWAD) files - insert (import) any kind of resource from GIF, PCX, VOC, WAV or RAW into IWAD, PWAD or RAW files - view any graphic-resources in standard VGA 320x200x256 or as hex dump, play any sound resource through a SoundBlaster (or compatible) soundcard - play any existing MUS-data in your WAD-file through AdLib-FM compatible soundcards (including Soundblaster Pro stereo) - rename, delete and create resources - edit or add new texture patches, includes editing PNames resource, save it to WAD, RAW or TXT files (for compatibility to DeuTex :) - if you change sprites or flats, you must pack all sprites/flats in your PWAD - NWT will do it for you (replaces DMADDS/F & DeuSF) - another way using Sprites & Flats: merge your PWAD into your IWAD - open any WAD (PWAD) file and extract (export) all resources you want for your own PWAD file - WAD cleaner - due to the use of tools (also NWT), a WAD file may contain useless stuff - NWT will rewrite your WAD (IWAD or PWAD) - join two PWADs into one file - combines all resources into one PWAD - all features possible with every version of Doom & Doom 2 ! All features should work with Heretic too. Heretic and Doom are using a different palette. The setup allows you to choose the palette. Also, both games are using different instrument setups! You have to save the resource GENMIDI from the Heretic-WAD to hear the original Heretic sound... Finally, you'll never need any other tool, except a level editor of your choice to make new levels. :-) With NWT you can view a few resources of Rise Of The Triad too! But don't be disappointed - only a few pics with the wrong palette. -[ 4]- Requirements -------------------------------------------------------------------------- NWT is a DOS program, you don't need Wind*ws to run it. It should work on any machine Doom runs on (in Dos). I can't guarantee that NWT will work on your computer, but it works well on my 486. You need at least 480k of free memory to run it and a mouse is and will NOT be supported. If you use the arrows it is probably a bit slow because of checking and displaying resource data on the screen. Norton's SPEEDISK makes great improvements as does cache-memory. The menu idea is taken from 'Wad Tools 1.00' by Jeff Miller. (never updated I think). First I wanted a tool like this but it became monstrous. At least basic knowledge of the structur of WAD files is required.If you don't know how to add a PWAD to Doom, how to use sprites in PWADs or even what a resource is - stop here and read the Doom Specs first. -[ 5]- Setup -------------------------------------------------------------------------- After the first start NWT will prompt you to setup the program. Just use the cursor keys to change the configuration. Press RETURN to save your changes. ESCAPE ends without saving keeping the current settings. Don't forget to choose the palette - Doom or Heretic? Remember: 'Primary graphic output file' means that NWT will give you a filename with this extension. If you set it to GIF now and you want a PCX later, just type a filename with this extension later. NWT will check the extensions to get the format used. Sometimes it is useful to have a window and the original palette when viewing graphic resources. If you want it, just move the X to YES. You can edit the setup anytime you wish. Just press ALT-S or delete the file NWT.CFG before starting NWT. If you want to hear some MUS-files, be sure to copy GENMIDI.OP2 in the same directory! -[ 6]- Using NWT -------------------------------------------------------------------------- You can use NWT in menu mode or batch mode. Some functions are not available in batch mode, others are not in menu mode. See section 'Batch mode commands' for details. To use menu mode, just start NWT without any parameters. At the first view, NWT seems to be a bit confusing... Try it and you will know how easy it is. If you can't get it, print out 1STSTEPS.DOC and follow the instructions to see how it works. -[ 7]- Viewing graphic and playing sound resources -------------------------------------------------------------------------- To view a graphic resource or play a voice resource through the output device SoundBlaster , just push RETURN. NWT will check the resource to get the type of it. You can't view any non-graphic resources. You can't play the speaker sound resources (DPxxxxxx). To view a hex dump of it just type F1 and use the arrows to move. With version 1.2 you can also play the MUS-sound-resources through your AdLib-FM compatible soundcard (including SoundBlaster Pro stereo). Just type RETURN to play a song, then press ESC to stop it or SPACE to play the music in background while editing your WAD-file. If you want detailed information about the MUS-player, e-mail the author Vladimir (Wladows) Arnost, QA-Software. If you play some voice resources while music is playing in background, the quality of the voice output is lower, because of timer problems. Btw:the SoundBlaster base address MUST be 220h or 240h for voice output. -[ 8]- Extracting resources (export) -------------------------------------------------------------------------- To extract a single resource to a RAW file, just choose the resource with the Up & Down arrows and push F2. You can change the name of the output file or just press RETURN to confirm. If you want more than one resource to extract, mark the resources with SPACE and finally push F2. NWT will now extract all marked resources. Push SPACE again to unmark a single resource or press F10 to unmark all marked resources. To extract resources to GIF/WAV files, type F3 - NWT will check for the type of every single resource (if more than one). To extract to a PWAD file type F4 - if the PWAD file already exist, NWT will always APPEND resources not existing in the PWAD. If a resource already exist in it, NWT will overwrite it leaving the old one in it! Right, the old one is useless, but writing everytime the hole PWAD takes a lot of time. If you got all resources you want in it, just CLEAN the PWAD with NWT. (Btw: Dmgraph & Dmaud are doing it mostly the same way) To save to a new PWAD, change the name or delete the old one. -[ 9]- Inserting resources (import) -------------------------------------------------------------------------- There are three ways of importing resources: - Import into existing IWAD (opened DOOM.WAD or alternate PWAD) - Import into existing/new PWAD(s) - Import with saving to RAW Again, seems to be a bit confusing but it is very useful. If you got a resource as a RAW file and you want it to be a PWAD file, just type F6 and change or confirm the given name. Done. NWT will append PWAD files the same way described above. It works the same way with importing GIF & WAV. Key commands are as follows: F5 - Import RAW file into IWAD (changing your DOOM.WAD) F6 - Import RAW file into PWAD (append/overwrite if exist) F7 - Import GIF/WAV into IWAD, NWT will check type by extension F8 - Import GIF/WAV into PWAD F9 - Import GIF/WAV to RAW, just converting GIF/WAV to RAW If you write a resource into the main IWAD file, NWT will check for the new and old length of it, smaller resources will be overwritten, larger will be appended at the end of the file. (just like Dmgraph & Dmaud) If you import a resource from a GIF or PCX file, the size of it is taken from the original resource! (you don't have to save your graphics with the correct size, but you MUST save your new graphic in the upper left corner!) - but you can change the size and offsets after typing the name of the file. To make it a bit more confusing, you can only enter new sizes and offsets if you are inserting single resources. NOTE: If you want to import a new WAV or VOC file, they MUST have 11025 samples per second! Convert it with your sound-editor before inserting. With version 1.3 (and higher) it is possible to insert a completely new resource. The import-function just overwrites a existing resource with new data - with this new feature you can (real) insert a resource and give it a name of your choice! The last step for a complete resource is to import the wanted data with the normal F-keys. To insert a new resource just press the INSERT key. NWT will create a new resource at the current cursor position. Now NWT will prompt you to enter a name for it. After this the resource has a length of 0 bytes and no exact position in the WAD file. Just import graphic, sound or raw data to give it a type, size and position. Thats all. Another very useful command is ALT-E. After importing several resources, maybe sprites, often you have to correct the sizes & offsets. With this command you can re-enter this important data. -[10]- Editing Textures -------------------------------------------------------------------------- This is a very nice feature of NWT. You can edit old texture-patches by overwriting them. Also you can edit completely new patches, with new names and use them in Doom or in DEU too! You can save the new texture data as RAW, WAD or TXT files. TXT is a very plain method of DeuTex to edit new textures. You can use DeuTex to generate the new data for Doom. (but why?) To edit a new texture-patch, you must find the texture resource in your Doom IWAD first. In Doom there are two of them, TEXTURE1 for the shareware version and TEXTURE2 for the walls used in the registered version. To find them in the resource list of NWT, just type ALT-T or type the word 'text' and NWT will search for it. Choose the one you want (in Doom 2 is only one texture resource) and push RETURN. NWT will now show a list of all texture-patches defined in this texture resource. Press RETURN to view one, F1 to list the used patches in the active texture-patch. To edit a texture-patch type F2, confirm the given name or enter a new one. Then confirm or enter the output filename. NOTE: the extension deter- mines the format to save. The next important parameter is the size of your texture patch. Don't use any exotic size, normal textures are 256x128, 64x64, 64x128... The largest texture may be 256x128. Avoid odd numbers!! The sum of the sizes of all wall patches used must be <= 64k. NWT also limits the maximum of used patches to 64. This is the maximum used in Doom & Doom 2. After you entered the size, NWT will list all PNAMES. Doom allows only graphic resources for texture patches listed in this PNAMES-list. Of course you could put all graphic resources in this list, but this is not very usefull. Now you can mark all PNames you want for your new texture patch. NWT will display the name of a texture using this PName so you can easily choose them without viewing all PNames. (Because these PNames are the resource-names they are not called CEMENT or GRAY, mostly they are called WALLxxx, not giving any idea of their type). After you marked all PNames you want, type F2 again. Now you are able to edit the texture patch. Simply push SPACE to add a patch to your texture. NWT will switch to graphics mode and you can place the patch wherever you want. Press RETURN to confirm or escape to abort placing the patch. Back in textmode you can view your texture (F2), list the patches used so far (F1) or clear the hole patch (F3), if you don't like it. Push SPACE to add another patch, save the texture with F10 or press ESCAPE to abort editing. If you save the texture, NWT will read the hole texture data from the output file (if existing) and overwrite it with your changes. This way you can edit a lot of new textures saving them in the same file. Of course you can edit the same texture many times, overwriting it everytime. :) If you save every texture patch in a single file you will NOT be able to combine them to one texture resource! (You can't add two PWADs containing the same resource to Doom or DEU - one will overwrite the other.) That's all about texture editing. Trial and error is the best method of learning it! :) -[11]- Viewing/Editing PNames resources -------------------------------------------------------------------------- Every Doom IWAD needs this resource. It's a list of wall patches, which are used in textures resources. For more information read the Doom Specs. With NWT you are able to edit this list; editing means adding & deleting objects (resources). To view/edit the PNames list, press ALT-P. Type RET to view a resource, F2 to add pnames or F3 to delete pnames. You can mark more than one pname and delete them all by pressing F3. NOTE: If you are a lucky guy trying to irritate Doom - just delete some of the pnames and start Doom. All other people - don't try to delete some of the given pnames. This function is implemented only for deleting pnames added by you. Like saving texture-resources, you can't save this pnames-list direct into the main IWAD - better save as a RAW file and insert this RAW file later into your WAD. -[12]- Using Sprites & Flats in PWADs -------------------------------------------------------------------------- If you want to use your own Sprites & Flats in your levels you have 3 possibilities: 1. Save your pictures direct into the Doom (2) IWAD --> 'destroys' your IWAD, very slow 2. Put your pictures into PWADs and add ALL other sprites to it using NWT, DEUTEX or DMADDS --> slow, takes a lot of disk space --> but keeps your IWAD unchanged 3. Merge your PWAD (including only resources you really want to change) to your Doom/Heretic main IWAD The last choice is the easiest and fastest way to use Sprites & Flats. You can have any other resources in your PWAD too - no problem. Alas, NWT will change the IWAD a bit. But with NWT it is possible to restore your IWAD anytime you want. [History...] Early december I received a Grenade/Crossbow patch. I was wondering how they used to change the weapons without any tool... they just 'replaced' some resources not existing in the IWAD. Mmmmhhh... Then I tried some ideas with the Doom IWAD and it worked great. I think DeuTex is doing it nearly the same way... That's why I used the DeuTex-commands -merge & -restore. After using the NWT -merge command you always have to add your PWAD when starting Doom (2) or Heretic. If you want to run Doom without your PWAD you have to restore Doom first. Both functions are only changing a few bytes in your main IWAD - therefore it is very fast and safe! I recommend not to change the IWad after merging it. It's safe - you can clean the WAD file, extract resources - be careful with changing sprite & flat resources. Better restore it before editing. NOTE: The merge-feature of NWT is different than DeuTex's! Don't try to merge with NWT and restore with DeuTex... -[13]- Working with PWADs -------------------------------------------------------------------------- With NWT you can view the resource directory of any PWAD. You can extract single or all resources to other PWADs (appending them) or export them for editing (GIF, WAV). Also, you can load a PWAD and delete all resources you want. Simply type '-' to delete a resource. Of course all marked resources will be deleted. I decided to use this key, because it is a very dangerous function. To open a PWAD type ALT-L. NOTE: NWT will NOT delete the resources, it will change the directory of the opened PWAD. After deleting some resources, I recommend using the batch command -c (WAD-cleaner). Please use PWADs only with authors agreement! If you load a PWAD, it will be named as the active IWAD file, this means if you save any resource into IWAD now, it will be written into your opened PWAD. Of course your PWAD is still a PWAD file. -[14]- Batch mode commands -------------------------------------------------------------------------- Now I will list all parameters available at the command line for NWT. * NWT -file wadfile.wad Will force NWT to load an alternate WAD file. The WAD file is now called IWAD, because it replaces the (normally loaded) DOOM.WAD file. Of course it is not really a IWAD file. With this option you can edit several WAD files without having any Doom version installed. NOTE: If you like to edit new textures in this kind of IWAD files, they must contain the TEXTURE & PNAMES resource! Of course all P-resources (wall patches) are needed! (So, better edit new textures having your DOOM.WAD loaded :) * NWT -c wadfile.wad Will rewrite any WAD file completely. Because after using tools (including NWT) there may be unused stuff in WADs. Can take a while. e.g. NWT -c doom.wad * NWT -as wadfile.wad Will add all sprites not existing in your wad. If you got no sprite resources in your PWAD, NWT will export all sprite resources. You can have any other resources in your PWAD too. It doesn't matter. Of course there must be a Doom IWAD in the same directory. e.g. NWT -as mywad.wad * NWT -af wadfile.wad The same as above but flats (floor & ceiling textures). e.g. NWT -af thesame.wad * NWT -merge wadfile.wad This command will merge a PWAD (wadfile.wad) to your Doom IWAD. Anytime you wish you can restore your IWAD; you don't need the PWAD to restore the IWAD file. This is a very safe way to use Sprites & Flats (and all other resources of course) with Doom/Heretic. See section 'Using Sprites & Flats in PWADs' for detailed information. * NWT -restore Will restore your IWAD anytime you want. NWT will check the file, so restoring without 'merging' is impossible. * NWT -join file1.wad file2.wad Will join two PWADs copying all resources from file2.wad to file1.wad appending file1.wad. NWT will not check both texture & pname resources. -[15]- Versions, Changes, Bug fixes - History -------------------------------------------------------------------------- Version 1.0ß, 11/14/94 * Initial release Version 1.1, 11/20/94 + Various little bugs fixed + Dmgraph-GIF-bug fixed (because dmgraph adds unused extra stuff to GIFs) + Better editing of filenames + Added directory display (can display a maximum of 1500 files/dir !) + Directory sort by NAME or DATE - default settings in setup + New feature: editing PNames resources + New feature: deleting resources from your opened WAD, very useful :) + NWT now remembers the name of the last texture file & the last PWad file edited + Speed up (file in-out functions) + More free memory for resources (see Restrictions) - Speaker sound output does not work anymore due to change of memory model, maybe in future versions Version 1.2, 1/6/95 + Little WAV/VOC-save bug fixed (those shitty little bugs...argh) + New feature: added MUS-play routine - thanks to V.Arnost, great work! + New feature: renaming resources is now possible (ALT_R) + New feature: Merge a PWAD into your IWAD, see 'Using Sprites & Flats' + Added DOS Shell; there is not much memory left, but it may be useful + Tricky VILE-filename bug fixed (replaces [\] with 123) * This version does not work with Shareware-Doom anymore, hopefully! + Detailed info about LMP-demos, you can view the textmode-resources too + Soundblaster Base address (for voice output) is now adjustable (220h or 240h) * Added HERETIC support. All features should work. NWT will NOT work with shareware Heretic! Version 1.2a, 1/8/95 * Only a new e-mail address! Version 1.3, 1/21/95 + Various little bugs fixed + Fixed date/time & attribute 'bugs' + Fixed pnames mem-alloc bug (argh!) + Merge-feature is now better & safer (batch command) + sprite & flat adding feature is better (batch command) + New feature: '-join' command combines 2 PWADs + New feature: real inserting of resources - see section 9 for details + New feature: re-enter the size & offset data of graphic resources after importing. Just press ALT-E. See section 9 for details. + Added index & error message list to the document you are reading. If you received an updated version of NWT, be sure to delete NWT.CFG before starting NWT! -[16]- Error messages -------------------------------------------------------------------------- * Error messages of NWT in batch mode: Error #2: No DOOM.WAD, DOOM2.WAD or HERETIC.WAD found. Copy NWT in your Doom/Heretic directory or use the command -file. Error #3: Not enough memory. Kill some TSR's, free your memory. I think 480k free memory should be enough to run NWT. * These are error messages of the program in menu mode: Message | Description ------------------------------------------+------------------------------- Can't show/play this resource! | The tagged resource is not a | graphic or sound resource. Error reading file! | The file does not exists, the | filename is wrong or the file | is read-only. Error writing file! | Not enough disk space or the | filename is wrong. Can't export. No GIF/WAV resource! | The tagged resource is not a | graphic or sound resource. Error playing sound resource! | Error message of the player. | Maybe wrong MUS format or | not enough memory? SoundBlaster base address error! | Invalid base address, use the | Setup (ALT-S) to correct. | Or your soundcard is not | responding correctly, no way | to solve the problem. Can't import. No GIF/WAV resource! | The tagged resource is not a | graphic or sound resource. Can't find texture-resource! | Appears if you wanted NWT to | search for a texture resource | with ALT-T. The loaded WAD | contains no texture resource. Editing impossible - no pnames marked! | To edit a (new) texture you | must mark some PNames first. | See section 10 for details. Can't save. No texture edited! | Says it I think. Can't add.Reached maximum of 64 patches! | See section 10 for details. Can't add. Reached maximum of 64k! | See section 10 for details. Can't find PNames resource! | Appears if you wanted NWT to | look for a pnames resource | with ALT-P. The loaded WAD | contains no pname resource. AdLib not found. Can't play MUS-data. | Your soundcard is not | responding correctly. Error writing/opening MUS-data. | Mostly write error; not enough | disk space or other disk | error. Error reading instr.data GENMIDI.OP2 ! | If you want to play some MUS | resources, be sure to have | GENMIDI.OP2 in your current | directory. If not, export the | resource GENMIDI as a RAW file | and rename it to OP2. Warning: This resource already exists! | Only a warning; if you have | renamed a resource, NWT checks | for double names. Can't del/ren/ins! Restore IWad first! | Your IWad is merged with a | PWAD - to delete/rename/insert | some resources, restore your | IWad first. Do not mark more than one unknown entry! | There are one or more unknown | (just created) resources. | You can only import one at a | time to specify the sizes & | offsets! Press F10 and import | every single resource. Invalid size! | The X or Y size of a graphic | resource is 0 or lower. | That is impossible. Can't edit. No graphic resource. | The only resources you can | edit are graphic resources | with sizes & offsets. Flats | got no offset. -[17]- Restrictions, Future plans -------------------------------------------------------------------------- This version of NWT is restricted as follows: Saving to PWAD allows a maximum of 3500 resources, the Doom or Doom 2 IWAD file may contain a maximum of 3500 resources, 500 PNames and 500 Textures. (in one texture resource). GENMIDI.OP2 is the instrument file used by the MUS-player. Don't forget to copy this file into your NWT directory! If you are missing this file, export the resource GENMIDI as a RAW-file and rename it to GENMIDI.OP2. With NWT you can view a few resources of Rise Of The Triad too! But don't be disappointed - only a few pics with the wrong palette. I don't think I will add further support for ROTT - it's not that good, to much problems (Apogee's WAD is not really a WAD) - so, only if enough people want me to do it. I received only a few mails since last version, so: --> What do you think? Do you like it? Not? --> Any ideas? Comments? Suggestions? Bug reports? Let me know! If you want to rewrite this document (my english is beschissen... :) ) e-mail me and go on! Btw: Please upload this program wherever you are on. Thanks. For germans only: Wo sind eigentlich die ganzen WAD-Kreativen aus Deutschland? Ich habe noch nicht eine einzige Mail bezüglich NWT bekommen! (c) 1/95 Denis Möller, TiC denis@doomsday.shnet.org BBS: Error +49-4351-2796, login as gast/gast (guest)