home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / World_Of_Computer_Software-02-387-Vol-3of3.iso / w / wgtspr35.zip / SPRITE35.DOC < prev    next >
Text File  |  1993-01-28  |  22KB  |  548 lines

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