home *** CD-ROM | disk | FTP | other *** search
/ Quake 'em / QUAKEEM.BIN / quake / programs / thingy / thingy.doc < prev    next >
Encoding:
Text File  |  1996-04-08  |  5.2 KB  |  159 lines
  1.  Thing Utils, by Tom Wheeley. |  <tomw@tsys.demon.co.uk>  |  <splitbung>
  2. ------------------------------+---------------------------+--------------
  3.  
  4. Synopsis
  5. --------
  6.  
  7. Thing utils at last offer you an extremely pain-free method to distribute
  8. and use Modified Quake Maps.
  9.  
  10. Thing Utils give the benefits of:
  11.  
  12.   o  Legal to distribute (no textures or map design info)
  13.   o  Tiny file size (map test1 only takes 9k, not 580k!)
  14.   o  easy to edit.  You can edit the .THG file directly.
  15.   o  No unpacking of id.pak required whatsoever.
  16.  
  17.  
  18. Basic Idea:
  19. -----------
  20.  
  21. The map author runs EXTHING on their BSP file, which then creates a tiny
  22. THG file.  This can be edited in something like MS Edit, vi, Notepad etc.
  23.  
  24. The author writes an accompanying .TXT file, zips up the level, and sends
  25. it to a QUAKE ftp site (eg ftp.cdrom.com or ftp.stomped.com).
  26.  
  27. Mr QuakePlayer downloads the zip, and runs UPTHING, perhaps via a batch file
  28. or shell script written by the author.  This creates a new map files, which
  29. they can run immediately from QUAKE.
  30.  
  31.  
  32. Features of the Utilities
  33. -------------------------
  34.  
  35.  o  Automatic accessing of the PAK file.
  36.  
  37.     Both UPTHING and EXTHING can access the master id levels inside the
  38.     id1.pak file, so you don't need to unpack it.  (Although if you do, take
  39.     a look at XPAK (DOS only at present, Linux port in pipeline) :-)
  40.  
  41.     You can use this feature as follows:
  42.  
  43.     Instead of typing:  exthing test1.bsp
  44.     one could type:     exthing id1.pak@maps/test1.bsp
  45.  
  46.     Where the name before the `@' sign is the name of the pak file (almost
  47.     invariably id1.pak), and the name after is the directory name of the map.
  48.     Valid names in the Quake Test 1 release are:
  49.  
  50.         maps/test1.bsp
  51.         maps/test2.bsp
  52.         maps/test3.bsp
  53.  
  54.    Note the forward slashes (backslashes will not work!).
  55.    Perhaps more importantly, UPTHING supports this feature too, so your
  56.    end users will not have to unpack their .PAK file to play your level.
  57.  
  58.  
  59.  o Automatic CR / CRLF conversion
  60.  
  61.    To facilitate DOS users, EXTHING will convert the things lump to DOS
  62.    style ascii codes (with CRLF pairs).  This makes it easier for you to
  63.    edit, especially with old editors.  This does not happen in the Linux
  64.    version, as Linux does not use CRLF pairs.
  65.  
  66.    In order that Quake can cope (I expect), the thing list is converted
  67.    pack into UNIX style ascii codes (LF only) for inclusion in the BSP.
  68.    This all occurs transparently, so you won't really notice it.  This is
  69.    also done in the Linux version, so Linuxers can play Dossers maps :)
  70.  
  71.  o Automatic Back-ups
  72.  
  73.    Both EXTHING and UPTHING will create backups of any existing files
  74.    they try to write over.  They will delete existing backups of those
  75.    files.  Backups end with the extension .BAK.  This is not yet
  76.    implemented in the Linux version.
  77.  
  78.  
  79. Using EXTHING
  80. -------------
  81.  
  82.    EXTHING is the easier of the two packages to use, as you just type:
  83.  
  84.       exthing bspfile thingfile
  85.  
  86.    Where `bspfile' is the name of the BSP you want to edit / have edited, and
  87.    thingfile is the name of the file you want the things info to end up in.
  88.    EXTHING will supply a name for the thingfile if you omit it. (easier!).
  89.  
  90.    Note also that `bspfile' can reference a BSP file within a PAK file.  See
  91.    Above for details of syntax.
  92.  
  93.  
  94. Using UPTHING
  95. -------------
  96.  
  97.    UPTHING, unfortunately, is a bit more complex, mainly as it has three files
  98.    to deal with:
  99.  
  100.       upthing srcfile thingfile outfile
  101.  
  102.    Where `srcfile' is the same file as `bspfile' in EXTHING and `thingfile' is
  103.    the file distributed as the new map.  `outfile' is an optional parameter
  104.    specifying the name of the new BSP file.
  105.  
  106.    An UPTHING instruction sheet is provided for possible editing and sending
  107.    on to end users of your maps.
  108.  
  109. SHORTCUTS
  110. ---------
  111.  
  112. All files have a default extension:
  113.  
  114.  Pack files:  .pak
  115.  BSP files:   .bsp
  116.  Thing files: .thg
  117.  
  118. Omitting the extension in a command line argument will cause the default
  119. extension to be added.
  120.  
  121. The destination files (exthing: .thg file; upthing: .bsp file) default to
  122. the most logical name (exthing: name of the source BSP; upthing: name of the
  123. thing file), but with the proper default extension for the new file.
  124.  
  125. The full `pathname' for a PACK directory name does not have to be entered; the
  126. final `filename' will do.
  127.  
  128. examples:
  129.  
  130.     exthing id1@test3
  131.  
  132.  Will produce a thing file test3.thg from maps/test3.bsp in id1.pak.  Note
  133.  that there is a bug here in the Linux version.  Read LINUX.TXT.
  134.  
  135.    upthing id1@test3 test3
  136.  
  137.  Will produce a new BSP file test3.bsp in the current directory from the
  138.  bsp file maps/test3.bsp in id1.pak, and the thing file test3.thg.
  139.  
  140.  
  141. BUGS
  142. ----
  143.  
  144. I haven't added any nice error handling, really.  Some hints:
  145.  
  146. Runtime Error 2 is FILE NOT FOUND
  147.    "      "   3 is PATH NOT FOUND
  148. a copy: size mismatch error usually means you have run out of disk space
  149.  
  150. There is a wierdo bug in the Linux version.  Read LINUX.TXT for details
  151.  
  152. AUTHOR
  153. ------
  154.  
  155. Thing Utilities were written by Tom Wheeley <tomw@tsys.demon.co.uk>.
  156. Read MSDOS.TXT or LINUX.TXT for details on obtaining source code.
  157.  
  158. SUPPORT ENQUIRIES TO <support@tsys.demon.co.uk> PLEASE! :-)
  159.