home *** CD-ROM | disk | FTP | other *** search
/ Shadow Warrior / SWARRIOR.bin / data1.cab / Build_Docs / README.TXT < prev    next >
Text File  |  1997-08-25  |  11KB  |  263 lines
  1. ------------------------------------------
  2. Getting Started Customizing Shadow Warrior
  3. Written By Keith Schuler
  4. (c) 1997 3D Realms Entertainment
  5. ------------------------------------------
  6.  
  7. This file briefly explains how to get the Shadow Warrior utilities installed
  8. and running on your computer. These utilities include BUILD (an editor for
  9. creating your own levels), EDITART (allows you to put your own artwork into
  10. the game), and SLABSPRI (a utility for creating Shadow Warrior's 3D sprites.)
  11.  
  12. Refer to these documents in the \GOODIES\DOC directory on your Shadow
  13. Warrior CD for other important information:
  14.  
  15. ADVANCED.TXT - Brief explanations of room-over-room, sector objects, and
  16. other advanced Shadow Warrior mapping topics.
  17. EDITART.TXT  - Instructions and reference for using the EDITART program.
  18. EXAMPLE.TXT  - Documentation to accompany EXAMPLE.MAP, which includes
  19. demonstrations of almost all of Shadow Warrior's map functionality.
  20. SLABSPRI.TXT - Instructions and reference for using the SLABSPRI program.
  21. SWSOUNDS.TXT - An index of the sound effects and ambient sounds.
  22. SPRITAGS.TXT - Sprite tagging reference. Your guide to all the special
  23. sprites in Shadow Warrior and how to use them.
  24. SWBUILD.TXT  - A tutorial and reference guide to using the BUILD editor.
  25. WALLTAGS.TXT - Wall and sector tagging reference. These are all the wall and
  26. sector tags used in Shadow Warrior.
  27. -----------------------------------------------------------------------------
  28.  
  29.  
  30. ---------
  31. Contents:
  32. ---------
  33.  
  34. Where To Look On The CD                                 1
  35. How To Create A Working Directory                       2
  36.         Why A Working Directory?                        2.1
  37.         For Experienced Users Only                      2.2
  38.         Creating The Directory                          2.3
  39.                 Using KEXTRACT                          2.3.1
  40.                 Using KGROUP                            2.3.2
  41. Installing BUILD                                        3
  42.         BUILD.EXE                                       3.1
  43.         TILES000.ART - TILES021.ART                     3.2
  44.         SWVOXFIL.TXT                                    3.3
  45.         *.KVX                                           3.4
  46.         PALETTE.DAT                                     3.5
  47.         SETUP.DAT                                       3.6
  48.         BSETUP.EXE                                      3.7
  49.         TABLES.DAT                                      3.8
  50.         *.MAP                                           3.9
  51. Installing EDITART                                      4
  52.         EDITART.EXE                                     4.1
  53.         TILES000.ART - TILES021.ART                     4.2
  54.         PALETTE.DAT                                     4.3
  55.         TABLES.DAT                                      4.4
  56. Installing SLABSPRI                                     5
  57.         SLABSPRI.EXE                                    5.1
  58.         PALETTE.DAT                                     5.2
  59.  
  60. -----------------------------------------------------------------------------
  61.  
  62.  
  63. -------------------------------
  64. 1.      Where To Look On The CD
  65. -------------------------------
  66.  
  67. BUILD, EDITART, and SLABSPRI can all be found on the CD in the \GOODIES\TOOLS
  68. directory. RTSMAKER, the utility for creating your own RTS taunt files,
  69. can be found in the \GOODIES\RTS directory.
  70.  
  71.  
  72. -----------------------------------------
  73. 2.      How To Create A Working Directory
  74. -----------------------------------------
  75.  
  76. ┌──────────────────────────────────────────────────────────────────────┐
  77. │ This information is provided as is.  It is very possible to corrupt  │
  78. │ your copy of Shadow Warrior, so make backups!!!  3D Realms & Apogee  │
  79. │ cannot and will not support the use of this program.  If you choose  │
  80. │ to use it, you do so on your own.  We cannot help with questions     │
  81. │ about this program or its use.                                       │
  82. └──────────────────────────────────────────────────────────────────────┘
  83.  
  84. 2.1     Why A Working Directory?
  85.  
  86. You should do all of your customizations to Shadow Warrior from a "working
  87. directory." This is another directory containing the Shadow Warrior game,
  88. plus the utilities and files you plan to use or need. Since you're going to
  89. be modifying the actual Shadow Warrior game, its best to modify the
  90. working version rather than your "clean" version. There are a three chief
  91. reasons for this:
  92.  
  93.         1. If you change your game data, you probably won't be able to play
  94.            a multiplayer game with somebody else, unless they've got the
  95.            same modifications. It's good to have a clean version to play
  96.            versus their clean version.
  97.         2. You may accidentally corrupt the game data, in which case you
  98.            may no longer be able to to play the game at all, even in solo
  99.            mode. If this happens, it's nice to not have to re-install from
  100.            the CD.
  101.         3. Even if you don't corrupt the game, you may want to start a new
  102.            modification from scratch, in which case again, its easier to
  103.            recopy the clean version rather than re-install from the CD.
  104.  
  105. 2.2     For Experienced Users Only
  106.  
  107. Another warning at this point: modifying Shadow Warrior files is best left
  108. to experienced MS-DOS users, and probably not a good idea for novices. If
  109. you find the task of using simple MS-DOS commands to be daunting, then you
  110. may want to spend a little time learning DOS before you go about tackling
  111. these Shadow Warrior utilities. None of them will run properly under
  112. Windows 95, and they are anything but user friendly.
  113.  
  114. 2.3     Creating The Directory
  115.  
  116. Create a directory ("md swwork", for instance) and copy all of the contents
  117. of your Shadow Warrior directory into that directory. Then copy the contents
  118. of the \GOODIES\TOOLS directory on the CD into your working directory. You
  119. will then need to use KEXTRACT.
  120.  
  121.         2.3.1 Using KEXTRACT
  122.  
  123.         KEXTRACT is a utility for extracting files from the SW.GRP file.
  124.         To use it, the command line format is:
  125.  
  126.         KEXTRACT [group file][@file or filespec...]
  127.  
  128.         The group file is SW.GRP. @file would be used to specify a list file,
  129.         while filespec is the name of the actual file or files to extract.
  130.         Wildcards are accepted. You will probably want to use the following
  131.         command:
  132.  
  133.         KEXTRACT SW.EXE *.MAP *.ART *.DAT *.KVX *.TXT
  134.  
  135.         This will extract all of the necessary art and data files, as well
  136.         as all of Shadow Warrior's level maps.
  137.  
  138.         2.3.2 Using KGROUP
  139.  
  140.         KGROUP is the opposite of KEXTRACT. You won't need to use it right
  141.         now, but you may wish to use it later in order to pack your new
  142.         data into the SW.GRP group file. The format of KGROUP is:
  143.  
  144.         KGROUP [group file][@file or filespec...]
  145.  
  146.         Again, wildcards are accepted. An example would be:
  147.  
  148.         KGROUP SW.GRP *.MAP
  149.  
  150.         This would pack every .MAP file in the directory into the SW.GRP
  151.         file.
  152.  
  153.  
  154. ------------------------
  155. 3.      Installing BUILD
  156. ------------------------
  157.  
  158. BUILD needs all of the following files in the working directory. These can
  159. all be extracted from SW.GRP by using KEXTRACT (see above.)
  160.  
  161.         3.1     BUILD.EXE
  162.  
  163.         This is the editor itself. See SWBUILD.TXT for more information
  164.         about how to use this.
  165.  
  166.         3.2     TILES000.ART - TILES021.ART
  167.  
  168.         These are the art files. These contain all of the game's 2D art.
  169.         If these aren't in the same directory as BUILD.EXE, then you won't
  170.         be able to see anything in 3D edit mode.
  171.  
  172.         3.3     SWVOXFIL.TXT
  173.  
  174.         This is a script file for BUILD and the Shadow Warrior game itself.
  175.         It tells these programs which sprite picnums are to be replaced by
  176.         voxels (3D sprites.) If this isn't in the working directory, you
  177.         won't be able to see the voxels in 3D edit mode.
  178.  
  179.         3.4     *.KVX
  180.  
  181.         The .KVX files are the voxel files themselves. The .KVX file is
  182.         output by SLABSPRI.EXE.
  183.  
  184.         3.5     PALETTE.DAT
  185.  
  186.         This is the palette and translucency table for BUILD and the game.
  187.         Without this, the colors will be wrong, if the program even runs
  188.         at all.
  189.  
  190.         3.6     SETUP.DAT
  191.  
  192.         This is the configuration file for BUILD. It is produced by BSETUP.
  193.  
  194.         3.7     BSETUP.EXE
  195.  
  196.         This is a utility for configuring BUILD. Be warned that a -lot- of
  197.         features in this program are actually not available or
  198.         configurable. Your best bet is to use the default SETUP.DAT
  199.         we provided, and never run BSETUP.
  200.  
  201.         3.8     TABLES.DAT
  202.  
  203.         This is additional information about the tile set. Required by BUILD
  204.         and EDITART.
  205.  
  206.         3.9     *.MAP
  207.  
  208.         A .MAP file is the level data produced by BUILD. These should be in
  209.         the same directory with BUILD so you can load them into the editor.
  210.         BUILD will run without them, but you'll only be able to build a map
  211.         from scratch.
  212.  
  213.  
  214. --------------------------
  215. 4.      Installing EDITART
  216. --------------------------
  217.  
  218. You may as well keep EDITART in the same directory with BUILD. EDITART is
  219. used to import custom 2D art into the Shadow Warrior. You will need the
  220. following files in the same directory with EDITART in order to use it:
  221.  
  222.         4.1     EDITART.EXE
  223.  
  224.         This is the actual editing program. See EDITART.TXT for more info
  225.         about how to use this.
  226.  
  227.         4.2     TILES000.ART - TILES021.ART
  228.  
  229.         These are the art files. These contain all of the game's 2D art.
  230.         If these aren't in the same directory as EDITART.EXE, then you'll
  231.         only be able to start a new set of .ART files from scratch.
  232.  
  233.         4.3     PALETTE.DAT
  234.  
  235.         This is the palette and translucency table for BUILD and the game.
  236.         Without this, the colors will be wrong, if the program even runs
  237.         at all.
  238.  
  239.         4.4     TABLES.DAT
  240.  
  241.         This is additional information about the tile set. Required by BUILD
  242.         and EDITART.
  243.  
  244.  
  245. ---------------------------
  246. 5.      Installing SLABSPRI
  247. ---------------------------
  248.  
  249. SLABSPRI is the utility for creating Shadow Warrior's voxels (3D sprites.)
  250. You might want to keep SLABSPRI and its accompanying files in a directory
  251. separate from BUILD and EDITART, and copy .KVX files over as you create them.
  252.  
  253.         5.1     SLABSPRI.EXE
  254.  
  255.         This is the actual voxel editor. See SLABSPRI.TXT for more
  256.         information about how to use this.
  257.  
  258.  
  259.         5.2     PALETTE.DAT
  260.  
  261.         This actually isn't entirely necessary, but it's not a bad idea to
  262.         include it in the same directory.
  263.