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