home *** CD-ROM | disk | FTP | other *** search
/ Game Killer / Game_Killer.bin / 949.WOLFEDIT.DOC < prev    next >
Text File  |  1992-06-08  |  7KB  |  200 lines
  1. WolfEdit 2.0                                         (c) 1992  Bill Kirby
  2.   
  3.                     Wolfenstein 3-D Graphics Editor
  4.  
  5.  
  6. INSTALLATION
  7.  
  8. To install WolfEdit, simply unpack the zip file into the same directory
  9. the game is installed in. 
  10.  
  11. To start the editor:
  12.  
  13. WOLFEDIT [-ey]
  14.  
  15.     -e  forces keyboard mouse emulation even if a mouse driver is
  16.         detected
  17.  
  18.     -y  use mode Y (320x200) instead of mode X (320x240)
  19.     mode Y gives 72Hz refresh rate, where mode X gives 60Hz
  20.  
  21.  
  22. The screen is divided into several windows:
  23.  
  24. EDIT WINDOW
  25.  
  26.   This window displays the current image being edited.  Clicking the mouse 
  27. in this window performs different functions depending on which edit tool is
  28. selected.  The color used is dependent on which mouse button is pressed.
  29. Each mouse button has a different color associated with it.
  30.  
  31. Currently there are only 3 edit tools:
  32.  
  33.      Pencil     : draws a single pixel
  34.  
  35.      Dropper    : "picks up" a color off the image and assigns it to
  36.                   whichever button is pressed
  37.  
  38.      Paintbrush : fills an area
  39.  
  40.  
  41. PALETTE WINDOW
  42.  
  43.   This window displays all 256 colors available to draw with.  It also
  44. has a picture of a mouse, which displays the colors currently associated
  45. with each button.  
  46.  
  47. NOTE!  The last color (lower right corner of the palette) is a special 
  48.        color.  It is used to indicate "transparent", when editing object
  49.        images.
  50.  
  51.  
  52. STATUS WINDOW
  53.  
  54.   This window displays information about the image in the edit window:
  55.  
  56.     IMAGE          : image number
  57.     TYPE           : WALL or OBJECT 
  58.     LOCATION       : where the image is located (DISK, MEMORY, LOADING)
  59.     MODIFIED       : whether or not the image in memory has been modified
  60.                      since it was loaded
  61.     IMAGE SIZE/MAX : current size of the image, and the maximum size that
  62.                      the image can be
  63.     IMAGES LOADED  : number of images currently in memory
  64.     MEMORY LEFT    : amount of memory left
  65.  
  66. The image size information is only usefull for object images.  The wall
  67. images are always 4096 bytes, and will have "4096/4096" displayed for
  68. the size/max information.  Object images vary in size depending on how
  69. much of the image is transparent.  The images are stored in the file in
  70. segments of 512 bytes each, so if the original image is only 513 bytes,
  71. there will be a 1024 byte section of the file allocated for the image.
  72. This is why the image size can be smaller than it's maximum size.  
  73. A modified image cannot be saved if it requires more space than the maximum
  74. allowed for that image (the maximum size is different for each image).
  75.  
  76.  
  77. SCROLL BAR 
  78.  
  79. When WolfEdit starts, it loads the first image into memory.   You can use
  80. the scroll bar to select other images.  Clicking on the left and right
  81. arrow buttons scrolls through the images one at a time.  You can also click 
  82. anywhere on the bar to skip straight to a particular image.  When clicking
  83. on the left/right arrow buttons, the right mouse button scrolls continuously,
  84. while the left button scrolls one image, then waits for the mouse button
  85. to be released.
  86.  
  87. If you select an image that is not currently in memory, WolfEdit will 
  88. attempt  to load it.  If there is not enough memory available to load the 
  89. image, WolfEdit will try to clear some memory by removing an image that 
  90. hasn't been modified.  If all the images in memory have been modified, 
  91. WolfEdit won't load the new image, and a message will be displayed in
  92. the edit window to this effect.
  93.  
  94.  
  95. EDIT BUTTONS
  96.  
  97. Below the edit window, there are two rows of buttons.  The top row are
  98. for selecting the edit tool.  Initially, the "pencil" tool is selected.
  99.  
  100. The second row of buttons are for selecting various file functions:
  101.  
  102. GIF IMPORT:  (GIF with up arrow)
  103.  
  104.    Load in a portion of a GIF file into the current image.  If the GIF
  105.    was created with the GIF EXPORT function, it will be loaded into the
  106.    current image automatically.  If it is not a GIF that was created by 
  107.    WolfEdit, it will be displayed on a separate screen, and you will 
  108.    select the 64x64 section to copy into the image.   If the GIF selected 
  109.    is larger than 320x200 or 320x240 (depending on which video mode WolfEdit 
  110.    is running in), only the upper-left 320x200 or 320x240 portion of the 
  111.    GIF will be displayed.
  112.  
  113.    When loading a GIF, it must be converted to use the palette that Wolf3D 
  114.    uses.  This will cause some noticable differences in the GIF. 
  115.  
  116.    When loading a GIF into an object image (guard, table, etc), you will have 
  117.    to paint the transparent parts yourself.  If you don't, the image will be
  118.    to big to save.
  119.  
  120.  
  121. GIF EXPORT:  (GIF with down arrow)
  122.  
  123.    Saves the current image to a GIF file.
  124.  
  125. SAVE CHANGES: (disk)
  126.  
  127.    If no images are modified, clicking on this button will have no effect.
  128.    If the image currently displayed has not been modified, the display
  129.    will switch to the first modified image in the list.  Then the following
  130.    window will appear:
  131.  
  132.       Save changes:
  133.       SAVE/SKIP/DONE
  134.  
  135.           SAVE - save the current image.  If no more are modified, control
  136.                  returns to the editor, otherwise go to the next modified 
  137.                  image.
  138.           SKIP - go to the next modified image.  If there are no more
  139.                  modified images, this has no effect.
  140.           DONE - return to normal operation.
  141.    
  142.  
  143. QUIT: (dos prompt)
  144.  
  145.    Exit WolfEdit.  If there are any modified images in memory, you will
  146.    be prompted with:
  147.  
  148.       Save changes?
  149.       YES/NO/CANCEL
  150.  
  151.           YES    - identical to clicking on the "save changes" button,
  152.                    with the exception that after the last modified image 
  153.                    has been saved, the program will exit.  If you click 
  154.                    on "DONE" while there are still modified images, you 
  155.                    will be returned to the above prompt.
  156.           NO     - exits without saving the changed images.
  157.           CANCEL - returns to the editor.
  158.  
  159.  
  160.  
  161. MOUSE EMULATION
  162.  
  163.   If you do not have a mouse, WolfEdit will turn on the keyboard mouse
  164. emulator.  The emulator will let you use the arrow keys in place of the
  165. mouse.  Holding down more than one arrow key, or using the HOME, PGUP,
  166. PGDN, and END keys will move the mouse diagonally.
  167.  
  168. Also, the keys Q,A,[, and ] will function as the UP,DOWN, LEFT, and RIGHT
  169. arrow keys.
  170.  
  171. The emulator has three different button modes:
  172.  
  173.        mode    left button    right button
  174.    ---------------------------------------
  175.         1      Left ALT       Right ALT
  176.         2      Left CTRL      Left ALT
  177.         3      Right ALT      Right CTRL
  178.  
  179. WolfEdit starts in button mode 1, and can be switched to other modes
  180. by pressing F1, F2, or F3.
  181.  
  182.  
  183. --------------------------------------------------------------------------
  184.  
  185. If you have comments, suggestions, or find any bugs, I can be reached
  186. via e-mail at:
  187.  
  188.     bkirby@cs.umr.edu
  189. or      s088536@umrvmb.bitnet
  190.  
  191. If you find a GIF that WolfEdit can't load, I would appreciate it if you 
  192. send me a copy (uuencoded), or send e-mail telling me where I can find it
  193. via ftp.
  194.  
  195. Thanks,
  196. Bill Kirby
  197.  
  198.  
  199.  
  200.