home *** CD-ROM | disk | FTP | other *** search
/ Action Ware 10: Quake / ACWARE10.iso / acware10 / editors / mdlv14 / mdl.txt < prev    next >
Text File  |  1996-08-07  |  10KB  |  282 lines
  1. -----------------------------------------------------------------------------
  2. MedDLe v1.4
  3. -----------------------------------------------------------------------------
  4.  
  5.     by brian martin
  6.     brian@phyast.pitt.edu
  7.     http://www.phyast.pitt.edu/~brian
  8.     also look at http://www.phyast.pitt.edu/~brian/meddle
  9.  
  10.     Disclaimer: The author takes no responsiblity for misuse of
  11.   this program. He also is not responsible for any damage caused by it.
  12.  
  13.  
  14. -----------------------------------------------------------------------------
  15. Quick Start:
  16. -----------------------------------------------------------------------------
  17.  
  18. edit mdl.cfg to fit your needs
  19. run mdl (i.e. "mdl player.mdl")
  20. hit key '1' for help
  21.  
  22. what's new??
  23.     some new key's to hit
  24.     better multi skin support
  25.     much better import/export
  26.     pants/shirt color changing
  27.     saves mdl files
  28.  
  29. -----------------------------------------------------------------------------
  30. Contents:
  31. -----------------------------------------------------------------------------
  32.  
  33.         1. About MedDLe
  34.         2. Installation
  35.         3. Basic Use
  36.         4. Editing MDL files
  37.         5. History
  38.  
  39. -----------------------------------------------------------------------------
  40. 1. About
  41. -----------------------------------------------------------------------------
  42.  
  43. MedDLe is a program which lets you look at and edit the mdl
  44. files in quake. These are the files which describe the objects
  45. in quake and are located in the QUAKE\PROGS directory. You have to first
  46. unpack the id1.pak file with a program like unpack or qube. These can both
  47. be found at ftp.cdrom.com.
  48.  
  49. Features :
  50.         View bitmaps (object textures)
  51.         View/edit point mapping of the vertices
  52.         View/edit polygon mapping
  53.         Export model textures to a BMP file
  54.         Import BMP files to give objects a new 'skin'
  55.         View mdl header information
  56.         3D View of object (vertex/wire frame/flat shaded/texture mapped views)
  57.         Animation frame browser
  58.  
  59. -----------------------------------------------------------------------------
  60. 2. Installation
  61. -----------------------------------------------------------------------------
  62.  
  63. You should stick MedDLe in its own directory. Just unzip MDLv02.ZIP
  64. in a suitable directory (i.e. c:\mdl).  You should have these files
  65. in the MedDLe directory:
  66.  
  67.     MDL.EXE         -the executable
  68.     MDL.CFG         -the configuration file
  69.     MDL.FNT         -the fonts
  70.     MDL.PAL         -the palette
  71.     MDL.MAP         -the colormap
  72.     KEY.TXT         -quick reference sheet
  73.     MDLSRC.ZIP      -the source code
  74.     CWSDPMI.EXE     -dpmi environment (not needed if in windows)
  75.  
  76. If everything is in place, bring up MDL.CFG in a text editor and set
  77. the path variable and video driver to match your system. You can set
  78. the video resolution here too. When your done, save the file. That's it!
  79.  
  80. note: You may need a 386/483sx and math co-procesor or a 486dx or higher
  81. to run this. I don't know. There are several math emulators on the net
  82. if it doesn't work on your numerically challenged machine.
  83.  
  84. -----------------------------------------------------------------------------
  85. 3. Basic Use
  86. -----------------------------------------------------------------------------
  87.  
  88. MedDLe has no GUI at this point. Live with it. :)
  89.  
  90. MedDLe can both be used to view and edit mdl files. To
  91. start the program just type 'mdl file.mdl' where 'file.mdl'
  92. is a valid mdl filename.
  93.  
  94. You start in 3D mode.
  95.  
  96.          ARROW up/down : move eye position up/down
  97.          ARROW left/right : previous/next animation frame
  98.  
  99.          Esc :        exit
  100.          2 :            goto 2d mode
  101.          1 :            goto help (about)
  102.          t :            draw triangles
  103.          v :            draw vertices
  104.          s :            TAKE SCREEN SHOT (saved as pic#.bmp)
  105.          h :            show header
  106.          c :            auto cycle through animation frames
  107.          b :            change background color (black, gray, white)
  108.          r :             reset view
  109.          . or > :     next skin
  110.          , or < :        previous skin
  111.          " or ' :        next pants color
  112.          ; or : :        previous pants color
  113.          } or ] :     next shirt color
  114.          { or [ :        previous shirt color
  115.          Tab :        change rendering mode
  116.                     (flat shade, gourourd shade, texture, texture + shade)
  117.  
  118.          MOUSE up/down + right button : zoom in/out
  119.          MOUSE move + left button : rotate model
  120.          MOUSE move : move light source
  121.  
  122.  
  123. Just think of the mouse as your hand grabbing the object. It should
  124. then be easy to control. If you hit the '2' key, you will go to
  125. 2D mode. Here the keys are:
  126.  
  127.  
  128.          ARROW Keys:     move cursor
  129.  
  130.          Esc :        exit
  131.          3 :            goto 3d mode
  132.          1 :            goto help (about)
  133.          t :            draw triangles
  134.          v :            draw vertices
  135.          s :            SAVE MDL FILE
  136.          p :
  137.          m :
  138.          . or > :     next skin
  139.          , or < :        previous skin
  140.          " or ' :        next pants color
  141.          ; or : :        previous pants color
  142.          } or ] :     next shirt color
  143.          { or [ :        previous shirt color
  144.  
  145.          MOUSE move : move cursor
  146.          MOUSE left button: grab hi-lighted vertex
  147.  
  148.  
  149. The mouse can be used to move vertices in this mode.
  150.  
  151. Command line options of importance..
  152.  
  153.         import bmp to skin number # in model.mdl
  154.         (if # is greater than model skins, skin is added)
  155.  
  156.             mdl -i pic.bmp # model.mdl
  157.  
  158.  
  159.         export skin number # to bmp frome model.mdl
  160.         (if # is 0 or  negetive, a new blank skin with triangles is exported)
  161.  
  162.             mdl -e pic.bmp # model.mdl
  163.  
  164.  
  165. NOTE: When you use MedDLe, it will read the original mdl files from
  166. the quake/progs directory but will do all saving and reading from the
  167. current directory. If you load MedDLe in your quake/progs directory,
  168. you may end up erasing something you wish you hadn't. Of course you
  169. can change the read directory in the cfg file, but the save directory
  170. is always the current one.
  171.  
  172. -----------------------------------------------------------------------------
  173. 4. Editing MDL files
  174. -----------------------------------------------------------------------------
  175.  
  176. The following explains the basic proceedure for replacing object textures.
  177. In this example the 'player.mdl' file is modified with the texture
  178. 'play1.bmp'.
  179.  
  180.     1. First export the original texture. It will be saved in your
  181.     MedDLe directory.
  182.     'mdl -e play0.bmp 1 player.mdl'
  183.     NOTE: If you want to start from stratch, use
  184.     'mdl -e play0.bmp 0 player.mdl'
  185.  
  186.     2. Now go off and modify the texture in your favorite paint
  187.     program. Make sure you use the original palette of the 'play0.bmp'
  188.     file. Save the modified texture as 'play1.bmp' and place it in your
  189.     MedDLe directory. The file mdl.pal (included) can be loaded into
  190.     programs like Paint Shop Pro so you can use the correct palette.
  191.  
  192.     3. Import the new texture (play1.bmp).
  193.     'mdl -i play1.bmp 1 player.mdl'
  194.     NOTE: the bmp file must be 8 bit, but meddle is smart enough to
  195.     resize the picture and apply the correct color palette.
  196.  
  197.     4. Get into 2D mode (hit '2'). You can use the mouse to tweak some
  198.     of the vertices. You want to make sure that you don't change the
  199.     original layout too much, but also want to make sure there is no
  200.     background showing through any of the polygons. You should toggle back
  201.     and forth between 2D mode and 3D mode to check that the texture mapping
  202.     is ok. When your done tweaking, PRESS 's' IN 2D MODE to save your changes.
  203.  
  204.     Also, you can now change the shirt and pants color to see if you used
  205.     some colors you shouldn't have. Use the " [ ] ; ' " keys to do this.
  206.  
  207.     NOTE: If you don't press 's' in 2D mode your imported texture
  208.     will NOT be saved!
  209.  
  210.     5. Copy the new 'player.mdl' file to the quake/progs directory.
  211.     You may want to back up the original 'player.mdl' before doing this.
  212.  
  213.     6. Run QUAKE!
  214.  
  215.     Of course the player.mdl is you, so you won't see your changes... :)
  216.  
  217. Some added features that a serious editor will use are..
  218.  
  219.     - the file mdl.pal is used for quake. If you are editing a custom game,
  220.         you can replace mdl.pal with your own palette. The colormap can also
  221.         be changed (mdl.map).
  222.     - if you want to add a skin, just make sure the number is greater that
  223.         the current number of skins
  224.     - if you want to extract a blank skin is a number equal to or less
  225.         than zero.
  226.  
  227. -----------------------------------------------------------------------------
  228. 5. History
  229. -----------------------------------------------------------------------------
  230. v1.4
  231.     -fixed import/export- now its rocks
  232.     -shirt/pants color changing
  233.     -multi skins handled better
  234.     -saving enabled
  235.     -some new key mappings
  236. v1.3
  237.     -includes source with public release
  238.     -gouraud shading with colormap
  239.     -new file format support
  240.     -help screens
  241.     -more comments in source and some cleaning
  242. v1.2
  243.     -released with source
  244.     -better mouse control
  245. v1.1
  246.     -not released-gui experiments
  247.     -gouraud shading
  248. v1.0
  249.     -now you can edit the 2d vertices
  250.     -fixed bugs which caused crashes in 3d mode
  251.     -expanded video support via GRX20
  252.     -added flat shading to 3d models and texture mapping
  253.     -you can now cycle through the frames of animation
  254.     -several other little things
  255. v0.1
  256.     -added wire frame 3d view
  257.     -added importing/exporting BMP files
  258. v0.00002
  259.     - same as v0.00001 but with correct palette
  260. v0.00001 (not released, except on IRC)
  261.     - displayed the skin texture
  262.  
  263. ------------------------------------------------------------------------------
  264.  
  265. Programmers Note: in this version GRX20 was used along with 3DGPL.
  266. I sorta merged the two together and stuck some of my own stuff in there.
  267. The program is not optimized at all, and a sharp eye will notice that
  268. there is no _perspective_ texture mapping. Oh well, maybe I'll get around
  269. to that in a later version. Or maybe not.
  270.  
  271. Special thanks goes out to...
  272. Chris Babcock for making me aware of the frame data
  273. Raphael Quinet and Sean Werkema for giving out their source which
  274.   made learning to read BMP files easy (also the source taught me a few tricks)
  275. Sergei Savchenko for 3DGPL. I learned a lot of 3D programming from that and
  276.   use several modified versions of his routines for clipping and stuff.
  277. DJGPP v2 and the excellent GRX20 graphics lib.
  278. Id for quake.
  279. Becky for putting up with me :)
  280.  
  281. -end document------------------------------------------------------------------
  282.