[1.0] ** WELCOME TO THE DOOM MANAGEMENT SHELL ** Version: 1.00 Dated: 10th May, 1994 Engineered by: Phil Th‚ [Filthy] on Compuserve: 100242,3423 [1.1] INTRODUCTION: This program was conceived in order to aid DOOMER's in using the various DOS utilities available for editing, constructing and otherwise tinkering with WAD files. With the release of DOOMMAN, users will no longer have to exit to DOS in order to build a node tree using BSP or edit sounds and graphics via other Apps! : DOOMMAN handles the lot (well nearly). The companion program WADMAN handles WAD File Management and allows users to Copy, Rename, Delete, Backup and Recover WAD Files quickly and efficiently. [1.2] IMPORTANT NOTICE AND DISCLAIMER: While I'm pretty sure this program will work relatively bug free, I cannot guarantee it! ======================================================================== The author of DOOMMAN and WADMAN will not provide support or be liable for damage directly or indirectly caused by the use of the DOOMMAN and/or WADMAN software. ======================================================================== DOOMMAN and WADMAN incorporate extensive error checking. With everyday use you should not have any problems, however there are always ways of stuffing up an otherwise crash proof app! Tinkering with any backed-up WAD files (in the WADFILES.BAK directory), entering bizarre parameters into programs, mucking around with file attributes, creating sub-directories within the WADFILES.BAK directory with names matching potential WAD file backups, pouring hot java over your keyboard (are you getting the drift?) may stuff up DOOMMAN and/or any supported programs ... so in a word, DONT!!!!!! [1.3] SUPPORTED PROGRAMS: * DOOM The great game from ID software * DEU In my opinion, the best DOOM editor available to date * BSP The Node Tree Compiler as recommended by the DEU programming team! * DMAUD DOOM Audio Editor software * DMGRAPH DOOM Graphics Editor software * WADRUN DOOM WADFILE Manager * WADMAN My DOOM WADFILE Management Utility DOOMMAN does not provide you with copies of the above programs; you must download these files from a BBS or from the COMPUSERVE GAMERS forum, Library 8 (Action Game Aids) in order to gain the complete functionality of DOOMMAN. If any new bits of software appear that complement the above programs I'll be more than willing to add them to the supported programs list. [1.4] TECHNICAL BITS: DOOMMAN (and the companion program WADMAN) were coded and compiled using: BORLAND TURBO Pascal 6.0 DOOMMAN is not memory hungry and should work on most PC's that can run DOOM. DOOMMAN has been extensively tested on i486 based PC's with 4, 8 and 12Mb of RAM and hasn't crashed yet (no prizes to the first person to crash DOOMMAN!). I recommend that DOS version 5.0 or higher (preferably 6.0 or 6.2) be loaded on your PC although some lower DOS versions may work (those of you using DOS lower than 5.0 should probably upgrade in anycase; memory management is pretty important now-a-days!) DOOMMAN (and WADMAN) use certain DOS commands (primarily the COPY, RENAME and DELETE commands). As such you MUST have your DOS directory listed within your current PATH. There is also a setting in the DOOMMAN.INI file that requests the PATH to your COMMAND.COM file. Provided this is set correctly, no functionality loss of DOOMMAN (or WADMAN) should occur. Note that the default path to your COMMAND.COM file is: [ \ ] (backslash). This should work on all PC's unless DOOM is on a Hard-drive which is not the same as the Hard-drive you boot with. [1.5] INSTALLATION: There is no installation short of copying the ZIP file off your BBS or Compuserve GAMERS Forum into your DOOM directory and using PKUNZIP to extract the files. [1.6] FILE-LIST: The following files should be contained within the DOOMMAN.ZIP file: DOOMMAN.EXE : DOOM Management Shell Executable. DOOMMAN.DOC : This document file. DOOMMAN.INI : Default settings for DOOMMAN.EXE. DOOMMPAR.INI : Default Parameter settings for DOOMMAN.EXE. WADMAN.EXE : WAD File Manager Executable. [1.7] RUNNING DOOMMAN: Type DOOMMAN [Enter] from within your DOOM directory. To exit DOOMMAN from the Menu, type and then Y when prompted. DO NOT ATTEMPT TO RUN DOOMMAN FROM OUTSIDE YOUR DOOM DIRECTORY - IT EITHER WON'T WORK OR WILL WORK IN A WAY YOU DIDN'T EXPECT!!! [1.8] PARAMETERS: When running applications from within DOOMMAN there are three ways you can enter parameters: 1) You can ignore any parameters by typing X when prompted 2) You can use the parameters saved in your DOOMMPAR.INI file by typing [Enter] when prompted. 3) You can enter parameters to over-ride your .INI settings by typing the parameters in when prompted. [1.9] COMMANDS: RUN APPLICATIONS: D This runs DOOM (what more can I say?) U This runs the DOOM EDITOR UTILITIES (DEU.EXE). Note that you must have a copy of DEU.EXE in order to use this option. B This runs the BSP Node Builder Utility (BSP.EXE). Note that you must have a copy of BSP.EXE in order to use this option. G This runs the DOOM Graphic Editor (DMGRAPH.EXE). Note that you must have a copy of DMGRAPH.EXE in order to use this option. A This runs the DOOM Audio Editor (DMAUD.EXE). Note that you must have a copy of DMAUD.EXE in order to use this option. R This runs the WAD Runner Utility (WADRUN.EXE). Note that you must have a copy of WADRUN.EXE in order to use this option. W This runs the W.BAT file created by the WAD Runner Utility (WADRUN.EXE). Note that you must have a copy of WADRUN.EXE in order to use this option. Alternatively you can generate your own W.BAT batch file from DOS. M This runs the WAD File Manager Utility (WADMAN.EXE). This program is normally bundled with DOOMMAN (DOOMMAN.EXE) and should already be installed on your PC. See the documentation on WADMAN later in this text file. EDIT PARAMETERS: I Edit the DEU.INI file (part of the DEU package). You must have set the DOOMMAN.INI settings to point to a 3rd party text editor (such as EDIT.COM) in order to use this option. P Edit the DOOMMAN.INI settings. There are two parameters required: - the path to a COMMAND.COM file on your system. some examples: \ \DOS D:\DOS - the path to and NAME of a Third party text editing program. some examples: c:\dos\edit.com c:\dos\edlin.com (I don't recommend this one!) N Edit the DOOMMPAR.INI file. This file contains the default parameters for several of the supported programs: Program ID: Description [DOOM] ID's nifty game [DEU] DOOM Editor Utilities [BSP] BSP Node Builder [DMGRAPH] DOOM Graphic Editor [DMAUD] DOOM Audio Editor In order to use this file the following rules must be followed: 1) The line containing a Program ID must only display that Program ID For example, [DOOM] is ok, but [DOOM] (This is the DOOM parameter) is not! 2) The line immediately following the Program ID contains the actual parameters to be used when running that Program. If there is more than one line of parameters for a particular Program ID, the first line of parameters will be chosen. For example, [DOOM] -file e1l1.wad -skill 1 -warp 1 2 will run DOOM with the -file e1l1.wad file loaded and the skill level set to 1; the -warp 1 2 command will be ignored! A default DOOMMPAR.INI file has been provided with this software where each Program ID has a blank line following it. Simply type in your frequently used parameters into the blank line. [2.0] ** WELCOME TO THE WAD FILE MANAGER ** Version: 1.00 Dated: 10th May, 1994 Engineered by: Phil Th‚ [Filthy] on Compuserve: 100242,3423 [2.1] INTRODUCTION: This program is a WAD File management utility. It allows users to Copy, Rename, Delete, Backup and Restore WAD files without going to the DOS prompt. It's greatest functionality is when it is used in conjunction with the DOOM Management Shell described above. Hopefully this program will increase the productivity of DOOM level editors and designers by protecting their work from accidental deletion and mistakes. [2.2] RUNNING WADMAN: Type WADMAN [Enter] from within your DOOM directory. You can also run WADMAN from the DOOMMAN menu screen by typing M. To exit WADMAN from the Main screen, type and then Y when prompted. DO NOT ATTEMPT TO RUN WADMAN FROM OUTSIDE YOUR DOOM DIRECTORY - IT EITHER WON'T WORK OR WILL WORK IN A WAY YOU DIDN'T EXPECT!!! [2.3] THE WADMAN SCREEN: WADMAN allows up to 80 WAD Files to be accessed (this number was chosen to compliment the number of WAD Files accessible by the WADRUN application). If more than 80 WAD Files are present in your DOOM directory, WADMAN will select the first 80 listed in directory order and sort them when displayed on screen. Other WAD Files will not be accessible via WADMAN. To select a displayed WAD File, use the arrow keys to move the selection highlight around the screen. At the bottom of the screen is the info box and the menu bar. The info box lists information on the currently selected WAD file including type (IWAD or PWAD), Episode and Mission, file size, Date Time and Number of Backups saved in the WADFILES.BAK sub-directory. WADMAN allows each WAD File to possess upto 10 backup copies of itself. These files are stored in the WADFILES.BAK sub-directory which is created when the software is started if it does not already exist. These backup files can be easily identified as they have the same filename as the WAD File but with a numeric extension. For example, FRED.WAD may have FRED.01, FRED.02 and FRED.07 as backup files in the WADFILES.BAK sub-directory. When backup file details are viewed from within WADMAN you will find that they have been sorted in date and time order from most recent (top) to the oldest (bottom). This should allow you to perform rolling backups throughout the 10 backup slots provided. As a late addition, available disk-space information is also provided at the bottom of the screen. Note that all file sizes and hard-disk space values are in Kb ie. 1024 bytes, NOT 1000 bytes. [2.4] COMMANDS The following five keyboard commands are supported: C Copy WAD File: This command allows the user to duplicate the currently highlighted WAD File. When selected you will be asked to enter a new filename. Keep your filenames to 8 characters or less; WADMAN will append the default extension .WAD to the end of it. If the filename already exists, you will be warned that you are about to overwrite the specified file. - To abort the COPY action, simply type N. - To commence the COPY action, type Y. The software will then: COPY YOUR SELECTED WAD FILE AND ALL OF IT'S BACKUPS TO THE NEW FILE OVERWRITING ANY EXISTING WAD FILE AND BACKUPS WITH THAT SPECIFIED NAME D Delete WAD File: This command allows you to delete either THE SELECTED WAD FILE AND ALL OF IT'S BACKUPS (OPTION W) or A SELECTION OF THE WAD FILE'S BACKUPS LEAVING THE WAD FILE UNTOUCHED (OPTION B). Type either W or B to select one of the above deletion methods. OPTION W: If OPTION W is selected you will be asked if you are sure you wish to delete the WAD File AND all of it's backups. - To abort the delete action, type N. - To perform the delete action, type Y. OPTION B: If you select OPTION B, you will provided with a list of existing backups for the selected WAD File. - To delete a backup type in the number on the left hand side of the screen that corresponds to the Backup slot you wish to delete. The delete action will take place immediately. You may repeatedly delete backup files by selecting other slot numbers as desired. - When you have finished deleting backup files, press the key to leave delete mode. B Backup a WAD File: This option allows you to backup the selected WAD file to the WADFILES.BAK directory. When this option is chosen, a list of currently backed up files is displayed on screen. - Type in the number corresponding to the backup slot you wish to use. The backup should take place immediately. - Type in to abort the BACKUP action. If a file already exists in the selected slot, you will be warned that you are about to overwrite an existing backup. - Type Y to perform the backup and overwrite the existing file. - Type N to abort the BACKUP action. R Restore a WAD File from a backup: This option replaces the selected WAD file with one of it's backups stored in the WADFILES.BAK sub-directory. When this option is chosen a list of available backups is displayed on screen. - Type in the number corresponding to the backup file you wish to restore. You will be asked if you are sure you wish to perform the action: - Type Y to perform the RESTORE action. - Type N to cancel the RESTORE action. - To cancel the RESTORE action from the backup list screen, press the key. N Rename a WAD file: This command allows the user to rename the currently highlighted WAD File. When selected you will be asked to enter a new filename. Keep your filenames to 8 characters or less; WADMAN will append the default extension .WAD to the end of it. - To abort the RENAME action, simply type N. - To commence the RENAME action, type Y. The software will then: RENAME YOUR SELECTED WAD FILE AND ALL OF IT'S BACKUPS TO THE SPECIFIED FILENAME IMPORTANT NOTE: - If the filename already exists, you will be advised that the specified file exists; the rename action will then be aborted. [3.0] TROUBLESHOOTING: You choose a command from the menu but nothing happens. - The path to the COMMAND.COM file may be incorrect; use the P command to ensure that this setting is correct (and remember to add a \ to the end of the path). You choose an option and the following error message appears: not found or has S,H and/or R attributes set. - The file you wish to execute is not within your DOOM directory or has some of it's file attributes set incorrectly. Check if the file exists in your DOOM directory and make sure that either no attributes or only the A attribute is set for that file. The program halts and displays the following error message: DOS Error # has occurred. Note this error number and the actions you performed to generate it and contact Filthy on Compuserve 100242,3423 for a bug fix! - This is the error I hope no-one ever sees! It means one of the following: * either I goofed in a big way when coding (hope not!) * you tampered with some of the files created by or part of the DOOMMAN system. * an unexpected error occurred (of course, the fact that I put this code in suggests that I expected the error to occur!). Solution: Let me know about the conditions that caused the error as well as the error code and I'll see what I can do! Please be as specific as possible; things like the names of affected files, number of backups in the WADFILES.BAK directory etc. will help in tracking down the problem. [4.0] COPYRIGHTS DOOMMAN and WADMAN have been created by Phil Th‚, 100242,3423. These programs can be freely distributed as required. You may not sell DOOMMAN and/or WADMAN for personal gain or profit. Getting a tingly warm feeling in your belly from giving DOOMMAN and/or WADMAN to friends and BBS's is OK by me! DOOM is a trademark of id software. DEU has been created by Brendon Wyber (b.wyber@csc.canterbury.ac.nz) and Raphael Quinet (quinet@montefiore.ulg.ac.be) and is NOT an id Software product. BSP has been created by Colin Reed (Colin@Argonaut.com) and Dylan Cuthbert (dyl@cix.compulink.co.uk). DMGRAPH and DMAUD have been created by Bill Neisius (Bill@Solaria.hac.com). WADRUN has been created by Blackfist, 72123,1521. ==============================================================================