home *** CD-ROM | disk | FTP | other *** search
/ World of Shareware - Software Farm 2 / wosw_2.zip / wosw_2 / CPROG / WGT_SPR2.ZIP / SPRITE2.DOC < prev    next >
Text File  |  1992-07-25  |  20KB  |  509 lines

  1.         WordUp Graphics Toolkit Sprite Creator
  2.                  Version 2.0
  3.           Copyright 1992 WordUp Software Productions
  4.            ***********SHAREWARE************
  5.                Written by Chris Egerter
  6.  
  7.  
  8.  
  9. Requirements: IBM Compatible computer
  10.           VGA display
  11.           Microsoft Compatible Mouse (at least two buttons)
  12.  
  13. The Shareware Concept
  14. ~~~~~~~~~~~~~~~~~~~~~
  15.  
  16.      WGT Sprite Creator has been released for distribution as
  17. shareware. You are granted a 15 day evaluation period to examine
  18. and use the WGT Sprite Creator. If you like the program and
  19. expect to use it beyond the evaluation period, then you are
  20. required to register.  WGT Sprite Creator costs $20 (Canadian) for
  21. registration.  Please see the file called order.frm for more
  22. information.
  23.  
  24.  
  25. WordUp Software Productions
  26. ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  27.  
  28.      If you have any questions, comments, or suggestions,
  29.      WORDUP Productions can be contacted through
  30.  
  31.      BBS:    Barry Egerter (EMAIL)
  32.          Softnet BBS (NANET)
  33.          (519)-457-0065
  34.  
  35.     OR WRITE
  36.  
  37.          Barry Egerter
  38.          94 Andover Drive
  39.          London, Ontario
  40.          Canada, N6J 3X2
  41.  
  42.  
  43.  
  44.  
  45.  
  46.             Table of Contents:
  47.  
  48. To go to the topic desired, use the search command of your favourite
  49. word processor and search for the Page codes.
  50.  
  51.  
  52. Topic                        Page Code
  53. ~~~~~                        ~~~~~~~~~
  54. Introduction.......................................P1
  55. Installing the WGT Sprite Creator..................P2
  56. Running the WGT Sprite Creator.....................P3
  57. THE EDIT WINDOW....................................P4
  58. THE COLOUR SELECTOR................................P5
  59. SIZE WINDOW........................................P6
  60. SCROLL BUTTONS.....................................P7
  61. WIDTH AND HEIGHT INDICATORS........................P8
  62. CONTROL PANEL......................................P9
  63. SPRITE NUMBER INDICATOR............................P10
  64. STORAGE SECTION....................................P11
  65. TOOLS IN THE CONTROL PANEL.........................P12
  66. CHANGING THE COLOURS...............................P13
  67. ANIMATING YOUR SPRITES.............................P14
  68. THE FILE SELECTOR..................................P15
  69. ADDITIONAL COMMAND KEYS............................P16
  70. Using PCX and CELs.................................P17
  71. The Future.........................................P18
  72.  
  73.  
  74.  
  75.  
  76. P1        WordUp Graphics Toolkit Sprite Creator
  77.       A sprite editor built for gaming and graphic programmers.
  78.  
  79. This sprite creator is part of the WordUp Graphics Toolkit 2.0 for Turbo
  80. Pascal and C.  It is meant specifically for this package and therefore
  81. saves and loads files which are currently only supported by WGT.  If
  82. you wish to purchase the WordUp Graphics Toolkit, please see the file
  83. called order.frm included. To demonstrate what WGT can do, the graphic
  84. procedures used in this sprite creator were completely from the 
  85. Turbo C++ version of WGT.  No BGI procedures were used! As well, a
  86. demonstration file called invader.exe is included.  Please read the
  87. documentation included about that file.
  88.  
  89. The WGT Sprite Creator is designed to give the programmer many
  90. tools for designing small pieces of graphics. These pieces can
  91. be saved in a common file to be loaded and displayed in your
  92. own programs.
  93. Version 2.0 of the WordUp Graphics Toolkit has special procedures
  94. for displaying the sprites.  You can have up to 40 sprites on the
  95. screen at once, each moving and animating independantly. One line
  96. commands control all the movement and animation for the sprites,
  97. so once you set up the movement and animation, you don't need to
  98. worry about where they are.  They move around on their own!
  99. WGT controls everything for you, so you can concentrate on other
  100. matters.
  101.  
  102.  
  103. P2        Installing the WGT Sprite Creator
  104.         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  105.  
  106.    To execute the WGT Sprite Creator V. 2.0, first make a directory,
  107. and unzip or copy everything into that directory.
  108.  
  109.  
  110. P3
  111. Now go to the correct directory and type SPRITE2. The main screen
  112. should appear and wait for your actions.
  113.  
  114.    If something goes wrong, you must make sure you have
  115. a VGA monitor and card, enough memory (remove some TSR's if
  116. necessary) and a Microsoft compatible mouse with at least two buttons.
  117.  
  118. The Sprite Creator demands a LOT of memory because it can hold
  119. up to 200 sprites at once, plus a full screen buffer.
  120. Please make sure you have enough memory before you try using the
  121. program.  WordUp Software Productions is not responsible for any
  122. loss of data, or damage caused by this product.  If you do however
  123. find a problem with this program, please contact us so we can find
  124. and correct the bug.
  125.  
  126.    The screen is divided into several sections, which will be covered
  127. in detail below.  The main areas are the edit window, colour selector,
  128. control panel, storage, and size window.
  129.  
  130. P4
  131. THE EDIT WINDOW    
  132. ~~~~~~~~~~~~~~~
  133.  
  134.     The edit window is in the top left corner.  It shows an area
  135. of the current sprite, in which all editting is performed.  It has
  136. variable magnification depending on what you set the size to be in
  137. the size window.  When you load the WGT Sprite Creator, the pencil 
  138. tool will be selected as a default.  Try clicking in the edit window.
  139. It will set the pixel you click on to the colour selected.  Notice
  140. if you press the right hand button, a different colour is used.
  141. This is good for quick editting, in case you make a mistake.  See
  142. the 'colour selector' below for more details.  
  143.  
  144.  
  145. P5
  146. THE COLOUR SELECTOR
  147. ~~~~~~~~~~~~~~~~~~~
  148.  
  149.     User definable colours range from 0 to 252.  Colour 253-255
  150. are used for the sprite creator's grey buttons.  If you click on one
  151. of the colours, a box next to the mouse is filled with that colour and
  152. the number of that colour is displayed in the box as well.  This
  153. is your drawing colour.  You can have different drawing colours for
  154. left and right mouse buttons.  Simply click on the right button to 
  155. change the right mouse colour.  If you click on the picture of the
  156. mouse between the drawing colour boxes, the colours will exchange
  157. with each other.  This is useful for mistakes using the change tool.
  158. Below the mouse is a box called 'Edit'.  Clicking on the box
  159. will bring up a submenu for changing the RGB values of the colours.
  160.  
  161.  
  162. P6
  163. SIZE WINDOW
  164. ~~~~~~~~~~~
  165.  
  166.     The maximum size for a sprite is 64x64 pixels.  The minimum 
  167. size is 2x2.  A 64x64 buffer is used even if the sprite is smaller.
  168. This way you can keep a whole sprite in memory, while zooming in
  169. closely for fine editting, and then zoom back out to the full size.
  170. The zoomed area shown in the edit window is defined by a box in the
  171. size window (top right corner).  Clicking (and dragging) the mouse in
  172. the window will change the size of the box.  Notice it only changes the
  173. bottom right corner.  Below the size window is two buttons controlling the
  174. corner movement.  By clicking on the left button, you can move the
  175. other corner of the box.  Also note how the edit window is zoomed in
  176. and out when you change the size.
  177.  
  178.  
  179. P7
  180. SCROLL BUTTONS
  181. ~~~~~~~~~~~~~~
  182.  
  183.     Beside the size window are four buttons for scrolling the
  184. sprite in a direction.  Simply click on the button and the sprite will
  185. move in that direction.
  186.  
  187.  
  188. P8
  189. WIDTH AND HEIGHT INDICATORS
  190. ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  191.  
  192.     Below the size window are two lines showing the width and
  193. height of the current sprite.  These are updated when you change
  194. the size of the sprite.
  195.  
  196.  
  197. P9
  198. CONTROL PANEL
  199. ~~~~~~~~~~~~~
  200.  
  201.     This is located in the top middle part of the screen.  It
  202. contains most of the tools you will need to control the WGT sprite
  203. creator.  Each tool in the control panel will be described in detail
  204. later.
  205.  
  206.  
  207.  
  208. P10
  209. SPRITE NUMBER INDICATOR
  210. ~~~~~~~~~~~~~~~~~~~~~~~
  211.  
  212.     Shows the sprite number the storage is pointing to.
  213. This is updated when you move through the storage.
  214.  
  215.  
  216.  
  217. P11
  218. STORAGE SECTION
  219. ~~~~~~~~~~~~~~~
  220.  
  221.     The storage section is basically a group of sprites, which
  222. can be moved around in the storage, copied from one to another and
  223. of course saved and loaded back in.  Instead of having many files
  224. containing separate sprites and loading them in one at a time, you
  225. can put all the graphics in one file, and load them into your
  226. programs with one command.  The palette is saved as well.  This is
  227. much more conveinent than having lots of small graphic files.
  228. You will see three boxes in the lower right corner of the screen.
  229. The middle box shows the sprite you are working with.  The boxes on
  230. either side show what is next in the storage area.  The sprite
  231. number indicator shows the number of this sprite.  The storage
  232. can hold up to a maximum of 200 sprites.
  233.     Above the boxes are four buttons.  Each has an arrow pointing
  234. in a direction.  The buttons pointing left and right move the current
  235. sprite back and forth through the storage area.  As you do this,
  236. the graphic in the edit and size window does not change.  To get a
  237. sprite from the storage into the edit window, push the button with
  238. the up arrow.  To put the sprite shown in the EDIT WINDOW (only
  239. what is shown in the edit window will be saved. Move the box in the
  240. size window to change what is saved) push the button with the down
  241. arrow.  You can copy one sprite to another by getting it from the 
  242. storage, moving to another sprite number in the storage, and finally
  243. putting the sprite into that number.  
  244.     Sprites do not have to be in any order, and you may leave spaces
  245. between sprites.  For example you may have a sprite in number one, and
  246. then have one in number 5.  This is perfectly acceptable.
  247.  
  248.  
  249. P12
  250. TOOLS IN THE CONTROL PANEL
  251. ~~~~~~~~~~~~~~~~~~~~~~~~~~
  252.  
  253.  
  254. PENCIL:    Puts a pixel where you click in the edit window.
  255.  
  256. LINE:      Draws a line from where you click to where the mouse is after
  257.        you drag it.
  258.  
  259. RECTANGLE: Draws a rectangle from where you click to where the mouse is
  260.        after you drag it.
  261.  
  262. BAR:       Draws a filled rectangle from where you click to where the
  263.        mouse is after you drag it.
  264.  
  265. CIRCLE:    Draws a circle from where you click to where the mouse is
  266.        after you drag it, using the first point as the center.
  267.  
  268. FCIRCLE:   Draws a filled circle from where you click to where the mouse
  269.        is after you drag it, using the first point as the center.
  270.  
  271. SPRAY:       Simulates a spray can where you click in the edit window.
  272.  
  273. FILL:       Fills an enclosed area with a colour. 
  274.        (Does not work perfectly yet!)
  275.  
  276. * All of the above use the left and right mouse buttons to draw with
  277. different colours *
  278.  
  279. GET:       Works like rectangle.  Gets a portion of the sprite so
  280.        you can paste it back on in a different location.  Has
  281.        no effect on the buffer.
  282.  
  283. PUT:       Puts the last portion back on using an XRAY (or see-through)
  284.        technique.  Hold down the mouse button and move the image 
  285.        to where you want it, then release the button to drop it on.
  286.        *IMPORTANT* You cannot get a portion of a sprite and then
  287.        zoom in closer.  You must either be at the same zoom level
  288.        or less than when you grabbed the portion. If you try to
  289.        put at a higher zoom, you will hear a beep.
  290.  
  291. CHANGE:    Changes any pixels in the edit window, from the right mouse
  292.        button colour to the left mouse button colour.  Works the
  293.        same as rectangle.
  294.  
  295. GET COLOUR:By clicking somewhere in the edit window, you can get the
  296.        colour of the pixel you clicked on.  This works for either
  297.        mouse button.
  298.  
  299. ROTATE:    Rotates entire 64x64 buffer at once, counterclockwise.
  300.  
  301. HORZ FLIP: Flips the entire 64x64 buffer horizontally.
  302.  
  303. VERT FLIP: Flips the entire 64x64 buffer vertically.
  304.  
  305. TRIM:      Shrinks the sprite by changing the bottom right corner.
  306.        If there is extra space (black) in the sprite, it will
  307.        shrink it down to the edges of the drawing.  By pressing
  308.        the right button, you can trim all of the sprites in the
  309.        file.  This is useful before saving to save some disk space.
  310.        *Only changes the bottom right corner, so it will not interfere
  311.        any ofsets for animation.*
  312.  
  313. ANIMATE:   Brings up a submenu to see how your sprites look in animation.
  314.        See below...
  315.  
  316. TRASH:       Deletes all the sprites in the storage.  Double checks beforehand
  317.  
  318. CLS:       Clears the sprite buffer completely.
  319.  
  320. DEL:         Deletes a sprite from the storage buffer.  All sprites
  321.        after the one deleted will be moved to fill the empty space.
  322.  
  323. INS:       Inserts an empty space into the storage buffer.  Sprites
  324.        after the one inserted are moved. If there is a sprite
  325.        in space number 200 when you insert, no space will be
  326.        inserted.
  327.  
  328. LOAD:       Brings up a file selector and loads in a sprite file.
  329.  
  330. SAVE:      Brings up a file selector and saves the sprite file.
  331.        To load sprites into your own Turbo Pascal or Turbo
  332.        C programs, get the WGT Library, from either your
  333.        local BBS, or write to us.
  334.  
  335. QUIT:      Ends the program.
  336.  
  337. UNDO:        Recalls what was last placed in the undo buffer. Use this
  338.        to correct any mistakes you made.  NOTE: The sprite buffer
  339.        is copied into the undo buffer when you click on a tool.
  340.        Remembering this will help you control what is stored in the
  341.        undo buffer.
  342.  
  343. FILES:     The sprite creator has a full screen buffer which can be
  344.        used for loading in pictures, saving pictures, grabbing
  345.        sprites from it, putting sprites onto it, and resizing
  346.        sprites on top of it.  This tool will show a submenu of
  347.        choices. Choose one of them to load or save the screen
  348.        buffer.
  349.        BLK and PAK are picture types specific to the WGT library.
  350.        PCX is a widely supported format, which has many versions.
  351.        The PCX pictures must be a fairly new version, and must
  352.        be 320x200x256.
  353.  
  354. GET SPRITE:Displays the screen buffer, and waits for a mouse click.
  355.        Click on the top left of the portion you wish to cut out,
  356.        and move to the lower right. Click again to grab it and
  357.        place it in the sprite buffer.  A right mouse click will
  358.        take you one step back.
  359.  
  360. PUT SPRITE:Displays the screen buffer and pastes the sprite in the
  361.        sprite buffer onto the screen when you click the left button.
  362.        If you click the right, it will cancel.  When you first click
  363.        on the tool, the button you press determines how the sprite
  364.        will be pasted on.  Left means xray mode, and right means
  365.        copy mode.  Xray mode does not copy any black spaces.
  366.  
  367. RESIZE:    Allows you to shrink or expand the sprite in the sprite
  368.        buffer.  The top left corner of the sprite always starts
  369.        in the top left corner of the screen and the bottom right
  370.        is where you click the left button.  Again, click the right
  371.        to return to the main screen.  If you click on this tool
  372.        with the right button, the whole screen buffer will be
  373.        resized instead of the sprite.
  374.  
  375. CLB:       Clears the screen buffer with the colour associated with
  376.        the mouse button you press when you select this tool.
  377.  
  378.  
  379.  
  380.  
  381. P13
  382. CHANGING THE COLOURS
  383. ~~~~~~~~~~~~~~~~~~~~
  384.  
  385.     Once you have clicked on the edit button underneath the
  386. mouse icon, a submenu will appear allowing you to change the
  387. red, green, and blue values for the palette.  It will look like this:
  388.  
  389. ----------------------------------------  Red, green, and blue values
  390. |    R   - ----I---- +   40         |  are shown on right, and a
  391. |    G   - --I------ +   23         |  graphical slider (I) shows
  392. |    B   - --------I +   63         |  the amount of each in the 
  393. |                       |  middle.  Clicking on the
  394. |  ----- ------ ------- ------ ------  |  - and + will change the values
  395. |  |SET| |COPY| |BLEND| |LOAD| |SAVE|  |  or you can click and drag
  396. |  ----- ------ ------- ------ ------  |  the sliders to new positions.
  397. |                       |  Next are some control buttons.
  398. |                       |
  399. |  Copy      10                   |  This line show where copy and
  400. |  To        40                   |  blend operations will take
  401. |                         |  place.
  402. |                ------               |
  403. |         | OK |               |  To finishing changing the 
  404. |         ------               |  colours, click here.
  405. ----------------------------------------
  406.  
  407. Choosing set, copy, or blend will activate the colour selector.  Press
  408. the left button to choose a colour or the right button to cancel the
  409. operation.  Blend and copy require two colour selections.
  410.  
  411. Load and Save will bring up a file selector for selecting the palette.
  412. (These are compatible with Autodesk Animator's .COL files)
  413.  
  414.  
  415. P14
  416. ANIMATING YOUR SPRITES
  417. ~~~~~~~~~~~~~~~~~~~~~~
  418.  
  419.     Once you have clicked on the animation button (running person)
  420. a submenu will appear allowing you to change the animation order and
  421. speed.
  422.  
  423. ----------------------------------------
  424. |             CLEAR   ALL              |  Clears all values
  425. |--------------------------------------|
  426. |                                      |
  427. |  Slot  :    -    1   +             |  Click on the + or - to change
  428. |  Sprite:      -    0   +             |  the values. You can animate
  429. |  Delay :      -    0   +             |  up to 40 sprites at a time.
  430. |                                      |  Change the sprite number to  
  431. |                       |  include that sprite in the    
  432. |                       |  animation. For example,
  433. |                              |  to animate sprites 1 and 2 set:
  434. |                              |  Slot 1  Sprite 1  Delay 3
  435. |                         |  Slot 2  Sprite 2  Delay 3
  436. |--------------------------------------|
  437. |            ANIMATE                 | OK |  Click OK to end, or to animate,
  438. |--------------------------------------|  click and hold the animate button.
  439. ----------------------------------------
  440.  
  441. Note:  The delay speed is not the same as the delay in the animate
  442. command in the WGT library.
  443.  
  444.  
  445.  
  446. P15
  447. THE FILE SELECTOR
  448. ~~~~~~~~~~~~~~~~~
  449.  
  450.     Any time you need to save or load a file, a file selector will
  451. appear.  At the top is a line which says "Type Filename:".  If you
  452. click on that top line, you can type in the filename instead of pointing
  453. and clicking with the mouse.  This is necessary when you want to save a
  454. new file which doesn't exist yet.  On the right side are some buttons with
  455. arrows.  The double arrows move to the top and bottom of the directory
  456. listing.  The single arrows move up and down one page.
  457. When you find the file you want, simply click on the name. Notice how
  458. the names are highlighted when you move the mouse over them.  This is
  459. so you don't click on the wrong name by accident.
  460. In case you don't want to pick a file, click on the button labelled 
  461. CANCEL.
  462. Currently, you cannot change drives from the file selector.
  463.  
  464.  
  465.  
  466.  
  467. P16
  468.             ADDITIONAL COMMAND KEYS
  469.             ~~~~~~~~~~~~~~~~~~~~~~~
  470. While on the main screen, the following keys can be pressed:
  471.  
  472.     M :  shows how much free memory is left
  473.     F1:  Displays version number and registration
  474.     D :  Goes to DOS shell.  Type exit to return.
  475.  
  476.  
  477. P17
  478.             Using PCX and CELs
  479.             ~~~~~~~~~~~~~~~~~~~~~~~~
  480.  
  481. The WGT Sprite Creator allows you to edit pictures using high quality
  482. paint programs and grab sprites from the pictures created.  Popular formats
  483. available are PCX and Autodesk Animator's CEL.  PCX pictures can
  484. be directly loaded in from the WGT Sprite Creator.  CEL pictures
  485. must be converted to BLK first.  CEL2BLK is included for this
  486. use.  Once converted, the BLK pictures may be loaded in directly.
  487.  
  488.  
  489.  
  490. P18
  491.                 The Future
  492.                 ~~~~~~~~~~
  493. REMEMBER:  The WordUp Sprite Creator is shareware.  When you become a
  494. registered user, you will receive the latest version of the sprite
  495. creator, with the first shareware notice removed.  You may also 
  496. receive some new software from WordUp Software Productions, for free.
  497. So please, register and support the shareware concept.
  498.  
  499.  
  500. Future improvements:
  501.     -Support for more file formats!
  502.  
  503.     -Including text into sprites
  504.  
  505.     -New line styles, and other special features!!!!
  506.  
  507. If you register, these features will be included into the next version,
  508. since I know you like the product.
  509.