home *** CD-ROM | disk | FTP | other *** search
/ Superpower (Alt) / SUPERPOWER.iso / q / util / mbq355 / readme.txt < prev   
Encoding:
Text File  |  1996-07-14  |  4.9 KB  |  147 lines
  1. ******************************
  2. *       Makebrush v0.3       *
  3. ******************************
  4. *    (c) by Lars Bensmann    *
  5. ******************************
  6.  
  7. Introduction
  8. ------------
  9.  
  10. This utility is for everyone who wants to try making a Quake MAP-file.
  11. It will make the most difficult part way easier. You don't have to care
  12. about those numbers in the brushes anymore.
  13.  
  14.  
  15. How does it work?
  16. -----------------
  17.  
  18. Well, it's really easy.
  19. Just type:
  20.  
  21.     makebrush [option] [texture]    (Linux version)
  22.     makeb [option] [texture]        (DOS version)
  23.  
  24. Makebrush will then ask you how many points your object has. Just enter
  25. the correct value and then enter the coordinates from all the corner
  26. points of your object.
  27.  
  28. Because cubes and planes are pretty common in level design, makebrush has
  29. to special modes to handle them (Of course can you use the regular mode for
  30. those as well if you like typing).
  31.  
  32.  
  33. Defining cubes
  34. --------------
  35.  
  36. Enter '1' to the first question to define a cube. You need to know one point
  37. of your cube with all 3 neighboring points.
  38.  
  39.     +---------+   So if you enter P1 as you first point, the next points
  40.        /|        /|   need to be P2, P3, and P4 (order is not important for
  41.    P4 / |       / |   the last three points).
  42.      +--+------+  +
  43.      | / P3    | /    Actually, you can define cubes in the plane mode pretty
  44.      |/        |/     simple as well. So have a look which mode you like
  45.      +---------+      better.
  46.     P1         P2
  47.  
  48.  
  49. Defining planes
  50. ---------------
  51.  
  52. Now let's get to the plane mode. Typing '2' at the beginning will put makebrush
  53. into the plane enter mode.
  54.  
  55. In plane mode you can define any shapes that have the same thickness at every
  56. point (including cubes). First of all you have to tell makebrush how many
  57. corners the 2D plane has and then you have to enter a vector for the thickness.
  58. Because it is a vector, you are not restricted to horizontal planes.
  59.  
  60. After this, you just have enter all the corner points of the 2D plane.
  61.  
  62.  
  63. And what happens now?
  64. ---------------------
  65.  
  66. About 0.1 sec after entering the last value you will see your brush on
  67. the screen (if you entered points that make sense, e.g. if all points
  68. were on the same plane you had a pretty flat 3D-object or entering
  69. the same point more than once is also a pretty stupid thing to do.)
  70.  
  71. If you specified 'texture' on the command line your brush will have the
  72. right texture already. If you didn't specify it, the field will default
  73. to 'BRICKA2_2'.
  74.  
  75. I wrote this utility under Linux, so I just cut and paste the brush into
  76. my MAP-file. Maybe you can use it the same way in a Win95 DOS-box, but
  77. at least for all DOS users it is a little more complicated (for more
  78. information look at option '-q').
  79.  
  80.  
  81. Options
  82. -------
  83.  
  84. Makebrush knows a few options entered from the command line:
  85.  
  86.     -h      Gives you a pretty help screen
  87.     -v#     Set verbose mode:  0   Quiet mode
  88.                    1   Regular mode
  89.                    2   Debugging information
  90.                    3   Who wants to read all this?
  91.     -q      Quiet mode (same as -v0)
  92.  
  93. The Quiet mode is especially useful for DOS users, because 'makebrush'
  94. won't print any information except the actual brush. If you send the output
  95. of 'makebrush' to a file ('makeb /q [texture] > FILENAME') you get a file
  96. you can directly import in your MAP-file.
  97. The only problem with this mode is that you won't be prompted to enter any
  98. information. But after using 'makebrush' a couple of times in the regular
  99. mode, it shouldn't be a problem to enter the information blindly.
  100.  
  101.  
  102. Can I have the source code?
  103. ---------------------------
  104.  
  105. If there should be interest in the source code, just mail me
  106. (lars@b-man.ruhr.de). But be warned: The source code isn't documented at
  107. all and it was a pretty quick and dirty hack.
  108.  
  109.  
  110. Thanks
  111. ------
  112. This whole thing was just made possible by the great Quake MAP Specs from
  113. Nicholas Dwarkanath. If you're interested in making a MAP-file get
  114. the latest version from http://www.infi.net/~nichd/qmapspec.html.
  115.  
  116.  
  117. Bugs
  118. ----
  119. Well, this program isn't too user-friendly, but it should do it's work.
  120. So please don't tell me that you cannot get back to correct your last entry
  121. or whatever, but if you find anything that produces wrong results, please
  122. tell me (lars@b-man.ruhr.de).
  123. When trying to generate larger brushes, I sometimes got an errors from
  124. 'QBSP' (AddBrushPlane: numbrushfaces == MAX_FACES). Well, I thought maybe
  125. the object has to many faces, but I got this error even on an object with
  126. just seven planes. And my object with the most faces that compiled correctly
  127. had 9 planes. If anybody has an idea if this is a limitation of the
  128. Quake engine or QBSP or a bug in makebrush, please tell me.
  129.  
  130.  
  131. History
  132. -------
  133.  
  134. 0.1     First release
  135.  
  136. 0.2     Added command line switches
  137.  
  138. 0.3     Added cube and plane mode
  139.  
  140.  
  141. Legal stuff
  142. -----------
  143.  
  144. I don't promise this program will do anything useful. It may work for you or
  145. it may not. It works for me that's all I can tell you.
  146.  
  147.