home *** CD-ROM | disk | FTP | other *** search
/ The Games Machine 31 / XENIATGM31.iso / quakedit / quark.txt < prev    next >
Text File  |  1997-07-20  |  7KB  |  166 lines
  1.  
  2.  *** Quake Army Knife ***
  3.  
  4.  
  5. This is a level/patch/etc editor for Quake, the game by ID Software. This
  6. file is an introduction to Quake Army Knife. Please have a look at it if
  7. you don't know it. Note that Quake Army Knife is based on QuakeMap.
  8.  
  9. A good introduction to Quake Army Knife's features, with screen shots and
  10. all that kind of things, as well as infos on the latest Quake Army Knife
  11. updates and other Quake Army Knife odd-ons is available at Derrick's Home
  12. Page, as well as on-line documentation :
  13.  
  14.   http://www.planetquake.com/quark
  15.  
  16. Quake Army Knife ("QuArK" for short) is centralized on a proprietary file
  17. format, with extension ".qme". Although you may use it as a standard ".map"
  18. editor, I recommend using the ".qme" file format, because it can store a
  19. lot of things more than just a map.
  20.  
  21. You can store several maps, code patches (written in QuakeC), files like new
  22. sounds or new models for Quake, and more, in a single .qme file. When you run
  23. QuArK, the window you see is the "QuArK Explorer", which allows you to
  24. edit such .qme files. See the introduction below and instructions in file 
  25. EXPLORER.TXT. When you open a map, either a standard .map file or a map 
  26. included in a .qme file, a new window pops up : the "QuArK Editor", a 3D 
  27. level editor. See EDITOR.TXT for a detailed description of the editor.
  28.  
  29. QuArK also has a Model editor. No documentation is available about it at the
  30. time I wrote this.
  31.  
  32.  
  33.  *** Requirements ***
  34.  
  35. Target Quake version : from 0.91 to 1.06 REGISTERED ; QuakeWorld. It may
  36. work with other versions, at least partially, but it has not been tested
  37. with these.
  38.  
  39. The QBSP, VIS and LIGHT utilities from id Software are required to
  40. "nodebuild" maps, i.e. to prepare them in order to play to Quake in them.
  41.  
  42. Using a more recent version of QBSP than id's first one is recommended.
  43. Try out the one recommended in file FAQ.TXT, for example.
  44.  
  45. Estimated Hardware/Software Requirements:
  46. - 486DX2/66 or better processor.
  47. - 16mb RAM
  48. -  1mb Hard Drive Space for QuArK
  49. - Windows 95
  50. - Registered version of Quake
  51. These are estimates based on limited testing.
  52.  
  53.  
  54.  *** Installation ***
  55.  
  56. Just unzip all the files in whatever directory you want. I recommend creating a
  57. new directory, named for example "QuArK", and unzipping the archive there.
  58. You will be asked when required where Quake is. You don't have to put QBsp, Vis
  59. and Light in the same directory as QuArK; if they are elsewhere, QuArK will
  60. ask you where.
  61.  
  62. When QuArK needs to run Quake, it sometimes create a lot of files
  63. (.map and .bsp files, progs.dat, quake.rc, .cfg files, etc). That is why it
  64. creates a temporary temporary directory structure under your Quake directory,
  65. named "QMapExec\". Files are extracted at their correct location under this
  66. directory : for example, maps are extracted in "QMapExec\maps\", sounds in
  67. "QMapExec\sounds\", etc. When it launches Quake, QuArK uses a "-game QMapExec"
  68. command-line parameter to tell Quake to use these files.
  69.  
  70. WARNING: consider this QMapExec directory and all its sub-dirs as TEMPORARY !
  71. Never save your work under it. Do not put QuArK itself in it. QuArK may
  72. erase the whole directory and its sub-dirs at any time ! It does so, for example,
  73. when you click on the "GO!" button that tells it to extract all entries and run
  74. Quake. A misadventure happened to someone how had all his work erased this way.
  75. Since then, I have coded securities in QuArK to prevent it from erasing
  76. something else than its temporary directory, and to prevent you from saving files
  77. in this directory.
  78.  
  79.  
  80.  *** QuArK Explorer ***
  81.  
  82. QuakeMap 2.0 - QuArK is based on QuakeMap 3.beta4 -
  83. had numerous changes.  One of the most significant
  84. is the new file format, .qme, which is the format used by QuArK
  85. Explorer.  The advantage of this format is that it allows
  86. you to save many different types of data in one file.  In
  87. addition to holding the .map file, a .qme file can contain the
  88. text description file, Quake C patches and even .bsp's with
  89. textures removed.  In this way, QuArK can also be used as
  90. a front-end to Quake, managing multiple patches for you.
  91. Keep in mind, if you wish to distribute your files this way, the
  92. user HAS to use QuArK to run it.  However, A DOS run-time
  93. version of QuArK is available (30kb)(*), which make it easier to
  94. distribute files in this format. All you have to distribute with
  95. your .qme files is a URL at which users may download this small
  96. add-one. And these 30kb are well worth the possibilities of
  97. QuArK ! Even if your .qme contains a single compiled .bsp, the
  98. 30kb to download will be smaller than the kb won by the absence
  99. of textures in the .qme.
  100.  
  101. (*) The DOS run-time is not available for the current version
  102. of QuArK yet.
  103.  
  104. Let's take a closer look at the possibilities of the .qme format.
  105. It allows us to associate QuakeC patches with particular levels.
  106. With this, we are able to build level-specific programs, like we 
  107. did in Hexen. For example, we could do something like Hexen's
  108. first level, where there are walls that make a half turn, fire a 
  109. few fireballs on you, and then rotate back in place. This could 
  110. be done in a standard QuakeC patch, but associating this patch 
  111. with the level make it far easier to use, and prevent oneself from 
  112. playing the level without the patch or vice-versa.
  113.                
  114. It also provides a consistent way of assigning actions with new
  115. keys - you know, "impulse" commands. You'll be shown a list of
  116. new actions the installed patches provides, and you'll have to
  117. choose a key for each of them. QuArK will then automatically
  118. remap impulse numbers as needed (useful for several patches from
  119. serveral sources) and write the "autoexec.cfg" to bind them with
  120. the keys you have choosen.
  121.  
  122.  
  123.  *** SHAREWARE ***
  124.  
  125. QuArK is Shareware.
  126.  
  127. Please see file REGISTER.TXT.
  128.  
  129.  
  130.  ***
  131.  
  132. Any comment, suggestion or bug report is welcome.
  133.  
  134. Thanks: to Derrick McKay for his QuArK Home Page and for all his comments and helps
  135.             (http://www.planetquake.com/quark)
  136.         to Mike Melzer for writing and updating a large part of the documentation;
  137.         to Steve ("sturm") for having provided the previous home page for QuakeMap;
  138.         to Christophe Weibel for having organized textures into groups;
  139.         to everybody who wrote me comments and bug reports;
  140.         and of course to id Software for Quake !
  141.  
  142. As usually, I won't assume any responsability for whatever might occur by
  143. using my program, either directly or indirectly. No warraties !
  144.  
  145.  
  146.  *** Legal stuff ***
  147.  
  148. You may distribute this program on any support, as far as you don't make anybody
  149. pay for it. You may charge shipping and handling costs on users, but not more.
  150. You may by *no* mean make profit from solding, leasing, or anything else with
  151. this program. You may, however, do whatever you like with whatever you made with
  152. this program.
  153.  
  154. id Softare does NOT support This program at all. The author of QuArK is by
  155. no way related to id Software. DO NOT ask id Software anything about QuArK.
  156.  
  157. "QuArK" is a unofficial short name for "Quake Army Knife" and is by no way
  158. related to "Quark, Inc.".
  159.  
  160. Quake is (TM) (C) by id Software, Inc. All rights reserved.
  161. The Quake logo is (C) by id Software.
  162.  
  163.  
  164. Armin Rigo.                             (arigo@alphanet.ch)
  165.                    (no file attachments nor mailing lists at this address !!!)
  166.