home *** CD-ROM | disk | FTP | other *** search
/ Quake 'em / QUAKEEM.BIN / quake / programs / qeu03bin / readme < prev    next >
Encoding:
Text File  |  1996-03-03  |  4.8 KB  |  100 lines
  1.      Quake Editing Utilities v0.2 by Raphael Quinet - 03 Mar 1996
  2.      ------------------------------------------------------------
  3.  
  4.        NOTE: NO BINARIES ARE INCLUDED IN THIS PACKAGE!
  5.        I don't have a PC for the moment and I do all my
  6.       development on a UNIX machine.  Most of you would
  7.       not be able to use Solaris binaries, so this only
  8.         contains the source code for the programs I'm
  9.       developing.  If you don't have a C compiler, this
  10.           will probably be useless for you.
  11.  
  12. This package contains a few tools that can help you to edit Quake
  13. files.  More exactly, they will allow you to extract some resources
  14. from the PAK, WAD2 or BSP files and examine them.  There is no real
  15. editor yet, because I don't have enough information about the BSP file
  16. structure.
  17.  
  18. I decided to release this source code in order to share information
  19. about Quake file structures and to speed up the development of
  20. third-party utilities.  Of course, I hope that you will help me
  21. writing a good editor for Quake rather than starting your own
  22. independent project.  But even if you choose to do everything on your
  23. own, the information contained in these files should be useful to you.
  24.  
  25. Instead of keeping all the information for me, I decided to publish my
  26. source code so that everybody can benefit from it.  In counterpart, I
  27. ask you to credit me if you use any information contained in these
  28. files.  I think it's fair.  If you don't like this, stop reading now.
  29.  
  30. The Makefile included in this package will compile several small
  31. programs.  They only use a part of the routines provided in the
  32. package, because most of these routines are intended to be used in a
  33. bigger program.  These sample programs are:
  34.  
  35. * UNPAK  -- Unpacks a Quake *.PAK file
  36.  
  37.   Usage:  unpak -h              Get some help.
  38.           unpak -v id1.pak      View the contents of id1.pak without
  39.                                 extracting anything.
  40.           unpak id1.pak         Creates a new directory id1.dir and
  41.                                 extracts the contents of id1.pak in this
  42.                                 directory.
  43.           unpak id1.pak gfx.wad Extract only gfx.wad from id1.wad.
  44.  
  45. * REPAK  -- Re-creates a Quake *.PAK file
  46.  
  47.   Usage: repak new.pak file1.lmp file2.lmp ...
  48.                                 If the PACK file already exists, data is
  49.                                 appended to it.
  50.  
  51. * UNWAD2 -- Unpacks a Quake *.WAD file (WAD2)
  52.  
  53. * REWAD2 -- Re-creates a Quake *.WAD file (WAD2)
  54.  
  55. * UNWAD  -- Unpacks a Doom/Heretic/Hexen *.WAD file (IWAD or PWAD)
  56.  
  57. * REWAD  -- Re-creates a Doom/Heretic/Hexen *.WAD file (IWAD or PWAD)
  58.  
  59. * UNBSP  -- Unpacks a Quake *.BSP file
  60.  
  61. * SPRVIEW -- View the structure of a sprite.
  62.  
  63. Note that UNBSP is a quick hack based on the other utilities.  The BSP
  64. files contain 14 unnamed entries.  For simplicity, I give them names
  65. (entry00, entry01, ... entry13) so that they can easily be saved to
  66. separate files.  I will write a cleaner version of UNBSP which decodes
  67. all chunks, but I'm still trying to understand the format of some of
  68. them (the first one is easy...).  Any information would be welcome...
  69.  
  70. I'm also trying to understand the format of the MDL files.  I have
  71. decoded some fields of the header and I can extract all bitmaps and
  72. save them to BMP files (you can do that in a few lines of code with
  73. the routines "ReadBitmap" and "SaveBMP" provided in f_bitmap.c); I
  74. also know a bit about the structure of the file (vertices +
  75. triangles), but there are still some unknown values in the header.
  76.  
  77. Discussions of the Quake file formats takes place only in the
  78. newsgroup rec.games.computer.quake.editing.  I read this newsgroup
  79. several times a day, so you can post your questions and suggestions
  80. there.  Actually, it is better to post in the newsgroup than to e-mail
  81. me directly, since lots of people will be able to answer your
  82. questions or benefit from the information that you post there.  If you
  83. really want to reach me directly, my e-mail address is:
  84. Raphael.Quinet@eed.ericsson.se.  But don't expect a quick reply,
  85. because I'm supposed to work on serious projects during the day and I
  86. can only read my mail and write QEU during my spare time.
  87.  
  88. Note for the curious: there are no binaries in this package because I
  89. don't have my PC with me for the moment.  I'm currently on a business
  90. trip (for three weeks) and I can only write my programs in the evening
  91. (after work), on a Sun workstation.  The only PC to which I have
  92. access doesn't have a compiler, so I cannot even verify if what I
  93. wrote runs on a PC or not (but I think so, since the code is based on
  94. DEU 5.3 and it is very portable).  If you have a DOS compiler and you
  95. managed to compile these programs on a PC, I would be glad if you
  96. could upload them to ftp.cdrom.com (but whatever you do, don't send
  97. the binaries to me by e-mail - I want to keep my mailbox clean...).
  98.  
  99. -Raphael
  100.