                            WordUp Graphics Toolkit
                                 Sprite Editor



                                 User's Manual
                                 
                          Copyright 1994 Chris Egerter



                   WordUp Graphics Toolkit:  Sprite Editor            Page 2

                          Table Of Contents
SYSTEM REQUIREMENTS:.........................................5

INTRODUCTION:................................................5

THE SHAREWARE CONCEPT:.......................................6

WARRANTY:....................................................6

CONTACTING THE AUTHOR:.......................................7

INSTALLING THE WGT SPRITE EDITOR:............................7

SYSTEM STATISTICS:...........................................7

PROGRAM CONFIGURATION:.......................................8

EDIT WINDOW:................................................10

COLOR SELECTOR:.............................................10

DRAWING COLORS:.............................................10

SWAP COLORS:................................................10

COLOR EDIT:.................................................10

TOOLBANK:...................................................12

THE TOOLS:..................................................12

First Toolbank:.............................................12
PENCIL:.....................................................12
LINE:.......................................................12
BOX:........................................................12
BAR:........................................................12
CIRCLE:.....................................................13
FILLED CIRCLE:..............................................13
ELLIPSE:....................................................13
FILLED ELLIPSE:.............................................13
POLYGON:....................................................13
FILLED POLYGON:.............................................13
SPRAY CAN:..................................................14
FILL REGION:................................................14

                   WordUp Graphics Toolkit:  Sprite Editor            Page 3

COLOR CHANGE:...............................................14
WHICH COLOR:................................................14
GET REGION:.................................................14
PUT REGION:.................................................15
HORIZONTAL FLIP:............................................15
VERTICAL FLIP:..............................................15
CLEAR SPRITE:...............................................15
DELETE SPRITE:..............................................15
INSERT SPRITE:..............................................15
TEXT:.......................................................16
LOAD/SAVE PICS:.............................................16
TRASH SPRITES:..............................................17
CLEAR CLIPBOARD:............................................17
UNDO:.......................................................17
LOAD SPRITES:...............................................17
SAVE SPRITES:...............................................18
QUIT:.......................................................18
OTHER TOOLBANK:.............................................18
Second Toolbank:............................................18
ROTATE 90:..................................................18
FREEHAND ROTATE:............................................18
RESIZE SPRITE:..............................................19
RESIZE SCREEN:..............................................19
GET SPRITE:.................................................19
PUT SPRITE:.................................................19
COPY SPRITES:...............................................20
MOUSE CURSOR:...............................................20
GRID GRAB:..................................................20
REMAP SPRITES:..............................................21
GET BIG SPRITE:.............................................21
PUT LAST:...................................................21
LOAD ANIMATION:.............................................21
SAVE ANIMATION:.............................................21
ANIMATE:....................................................22
SHRINK SPRITE:..............................................23
TRIM SPRITE:................................................23
TRIM ALL:...................................................23
MACRO ON:...................................................23
MACRO OFF:..................................................23
MACRO PLAY:.................................................24
LOAD MACRO:.................................................24
SAVE MACRO:.................................................24
CREATE FONT:................................................24
REGISTRATION:...............................................24
SETUP OPTIONS:..............................................24
DOS SHELL:..................................................25
FREE MEMORY:................................................25
OTHER TOOLBANK:.............................................25

QUICK PICK COLORS:..........................................25

PUT STORAGE:................................................25

                   WordUp Graphics Toolkit:  Sprite Editor            Page 4

GET STORAGE:................................................26

STORAGE AREA:...............................................26

STORAGE POSITION:...........................................26

ZOOM WINDOW:................................................26

ZOOM SELECTORS:.............................................27

SCROLLERS:..................................................27

HELP SYSTEM:................................................27

STATUS:.....................................................27

THE FILE SELECTOR:..........................................28

                   WordUp Graphics Toolkit:  Sprite Editor            Page 5

System Requirements:
~~~~~~~~~~~~~~~~~~~~
	386 or better IBM Compatible computer
	VGA or better display card and monitor
	Microsoft Compatible Mouse (at least two buttons)
	EMS memory optional

Introduction:
~~~~~~~~~~~~~

The WGT Sprite Editor is a paint program for drawing images which can later 
be used in your own programs.

This sprite editor is part of the WordUp Graphics Toolkit 4.0 for Turbo C++.
It is meant specifically for this package and therefore saves and loads 
files which are currently only supported by WGT.  Upon registration you will 
receive the file format and source code to load them into various graphics 
libraries and video modes. 

If you wish to purchase the WordUp Graphics Toolkit, please print an order
form from the registration screen within the WGT Sprite Editor.  To
demonstrate what WGT can do, the graphic procedures used in this sprite
editor are all found in the Turbo C++ version of WGT.  

The WGT Sprite Editor is designed to give the programmer many tools for 
designing small images. These images can be saved in a common file to be
loaded and displayed in your own programs.  While the main function of the 
Sprite Editor is to design sprites, it has a variety of other built in tools 
which allow you to design fonts, custom mouse cursors, animation sequences, 
and palettes.  It is a very important piece of software that is used a lot
during the development of any game or graphical program.


                   WordUp Graphics Toolkit:  Sprite Editor            Page 6

The Shareware Concept:
~~~~~~~~~~~~~~~~~~~~~~
WGT Sprite Editor has been released for distribution as shareware. 
If you like the program and want to be able to use your sprites in a program,
(commercial, shareware, or public domain) WGT Sprite Editor costs $20 for 
registration.   Registering provides you with a number of benefits:

-A disk containing the most current version of the program.
-A lifetime license to use the product.
-Support via mail, Internet, and various other message networks.
-The registration nag screen is removed.
-Sprite file format is given to you, so you may load sprite files into
 other languages and graphic libraries.
-Several conversion utilities written in C and Pascal (includes source)
 to convert sprite files into a format usable by the following libraries:
	Fastgraph 256 colors (C)
	Fastgraph 16 colors (C)
	BGI (C and Pascal)
	AniVGA (Pascal)
	TGE (C)
	XLIB (C)
	GameTP (Pascal)


Warranty:
~~~~~~~~~
Chris Egerter does not make warranty of any kind, express or implied, 
including without limitation, any warranties of merchantability 
and/or fitness for a particular purpose.

Chris Egerter shall not be liable for any damages, whether direct,
indirect, special or consequential arising from a failure of this 
program to operate in the manner desired by the user.  Chris Egerter
shall not be liable for any damage to data or property which may be
caused directly or indirectly by use of the program.

IN NO EVENT WILL CHRIS EGERTER BE LIABLE FOR ANY DAMAGES, 
INCLUDING ANY LOST PROFITS, LOST SAVINGS OR OTHER INCIDENTAL OR 
CONSEQUENTIAL DAMAGES ARISING OUT OF YOUR USE OR INABILITY TO USE THE 
PROGRAM, OR FOR ANY CLAIM BY ANY OTHER PARTY.


                   WordUp Graphics Toolkit:  Sprite Editor            Page 7

Contacting the Author:
~~~~~~~~~~~~~~~~~~~~~~
     If you have any questions, comments, or suggestions,
     I can be contacted through:

	BBS:	Chris Egerter (EMAIL)
		Home Base BBS
		(519)-633-9565

	Fido conferences:
		CPlusPlus, CLanguage
      	(Sorry, no netmail)

        Internet:
	        chris.egerter@homebase.com

	OR WRITE
	Chris Egerter
	94 Andover Drive
	London, Ontario
	Canada, N6J 3X2

Please do not feel like you are wasting my time by asking questions.  I will
try to answer everyone's questions as quickly as possible.


Installing the WGT Sprite Editor:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If you received this in a zipped or other archived file, first make a 
new directory for the editor.  Uncompress the files into the directory
using the appropriate archive utility program (such as pkunzip, lha, or
arj).

Now go to the correct directory and type SPR4. 


System Statistics:
~~~~~~~~~~~~~~~~~~
When the editor is run, a number of statistics about your computer are 
shown.  They are:

CPU Type:	This can be one of 286, 386, 486 or Pentium (586).

Video:		This always displays "VGA compatible card detected"
                if a VGA or better video card is found.

EMS:		This displays the state of the EMS driver, either 
                detected or not detected. 

                   WordUp Graphics Toolkit:  Sprite Editor            Page 8

Mouse:		This will display "Microsoft compatible" and the number of 
                buttons the mouse has, if a mouse was found.  It then reports
                what kind of mouse it is, out of the following:
		     Bus mouse
		     Serial mouse
		     InPort mouse
		     PS/2 mouse
		     Hewlett-Packard mouse
		The IRQ of the mouse driver is also shown.   

Memory Status: 	This shows how much conventional and EMS memory is free,
		and a total amount of memory of the two combined.


Program Configuration:
~~~~~~~~~~~~~~~~~~~~~~
The first time you run the editor, you will be required to configure some 
options.  A setup screen will appear which contains the following:

        Ŀ
            EMS USAGE                 AMOUNT OF EMS USED          
         NONE             x           - 768 +  OF  1024           
         STORE CLIPBOARD  x                                       
         STORE SPRITES    x                                       
        Ĵ
                                                                  
         COLOR LOCK       ON/OFF                                  
         SOUND            ON/OFF                                  
         CREATE BACKUPS   ON/OFF                                  
                                                                  
           SAVE CONFIG                               EXIT CONFIG  
        

The WGT Sprite Editor can use EMS memory for two purposes.  You can store
the clipboard and another virtual screen, saving 128k of conventional
memory, or you can store all of the sprites in EMS.  This allows you to
load large sprite files using the EMS routines in WGT.   You may also
set how much EMS the editor will use.  If you are using the EMS to store
the clipboard, you should only use 128k.  If you don't plan on using another
program either from a multitasking shell such as Windows, or through the 
dos shell, you can use all of the available memory.

Turning the color lock off will prevent the editor from reassigning the
menu colors when loading in a picture.  This will make sure the picture
is shown correctly, however the editor's menus will change color.

Turning the sound off may be desired when you are running a long macro,
or you are working in a quiet area.

When Create Backups is turned on, the editor will rename old sprite files
to an extension of ".spb" when you save over an existing file.  This will
protect your data against corrupt files and accidentally saving over the
wrong file.


                   WordUp Graphics Toolkit:  Sprite Editor            Page 9

When run for the first time, either the Save Config button or Exit Config
button will automatically save your settings.  If you have chosen setup
from within the editor, only Save Config will save to the configuration file.
The EMS options do not take effect until you restart the editor from DOS.


The screen is divided into several sections, which will be covered
in detail below.  The main areas are the edit window, color selector,
toolbank, storage, and size window.

Below is a diagram of all the important areas on the screen.

ͻ ͻͻ ͻ
                                                                   18
                                                                  ͹
                                                          15        
                                                                  ͹
                                        7                            
                                                   ͼ ͼ
              1                                    ͻ ͻ
                                                      16    17    19
                                                   ͼ ͼ
                               ͼ    Width:   64
                               8Ŀ 20 Height:  64
                                   Slot:     1
                               ͻͻ ͻ                   ͻ
                                 9   10    12۳ۺ 13
ͼ ͼͼ ͼ         14        ͼ
ͻ ͻ
              2                                                        
ͼ                                         
ͻ       ͻ      ͻ       11            11           11     
  3   <    ĺ   >   4                                           
ͼ       5ͼ      ͼ                                         
            ͻ                                                    
               6                                                       
            ͼ            ͼ


1 -  Edit Window                 11 - Storage Area
2 -  Color Selector              12 - Decrease Storage Position
3 -  Left Mouse Button Color     13 - Increase Storage Position
4 -  Right Mouse Button Color    14 - Storage Movement Slider
5 -  Swap Colors                 15 - Drawing Buffer / Zoom Window
6 -  Color Edit Menu             16 - Upper Left Zoom Box Selector
7 -  Toolbank                    17 - Lower Right Zoom Box Selector
8 -  Quick Pick Colors           18 - Scrollers
9 -  Retrieve from Storage       19 - Help System
10 - Put into Storage            20 - Sprite Statistics



                   WordUp Graphics Toolkit:  Sprite Editor            Page 10
Edit Window:
~~~~~~~~~~~~
This is where all sprite editing is done.  Clicking in the edit window will 
cause different actions depending on which tool is currently in use.  It 
shows a magnified area of the sprite being edited.  It may be magnified 
from 2 to 32 times the original size.  Higher magnifications make it easier 
to draw since the pixels are larger.

Color Selector:
~~~~~~~~~~~~~~~
The Color Selector contains all of the colors available for drawing your 
sprites.  Each sprite file contains a single palette, which is used by all 
the sprites in the file.  Each mouse button may have a different color 
assigned to it, by clicking with that button on one of the colors.  If you 
hold down the ALT key while over the first few colors, you can select colors 
252-255 which are normally unavailable to the user. If you change these 
colors, the WGT Sprite Editor's menu colors will be changed.


Drawing Colors: 
~~~~~~~~~~~~~~~
These boxes show which colors have been assigned to each mouse button.  
When a tool is used in the edit window, one of these colors will be used
depending on which button is pressed. 


Swap Colors:
~~~~~~~~~~~~
The mouse icon will swap the colors of the left and right mouse buttons.
This is useful when using the color change tool and choosing a right mouse
button color from the quick pick boxes.


Color Edit:
~~~~~~~~~~~
This will open a color control panel which allows you to modify the 
current palette.  You can set new red, green, and blue components for each
of the 256 available colors, copy one color to another, blend between two 
colors, and load or save palettes.  


                   WordUp Graphics Toolkit:  Sprite Editor            Page 11

Once you have clicked on the edit button underneath the mouse icon, a 
submenu will appear allowing you to change the red, green, and blue 
values for the color.  It looks like this:


ͻ  Red, green, and blue values are
	R   - I +   31           shown on the right, and a graphical
	G   - I +   19           slider shows the amount of each in
	B   - I +   63           the middle.  Clicking on the plus  
				         and minus will change the values or
 ͻ ͻ ͻ ͻ ͻ    you can click and drag the sliders
 SET  COPY BLEND LOAD SAVE    to new positions.
 ͼ ͼ ͼ ͼ ͼ    Below are some control buttons for
				         performing various actions on the
				         palette.
  Copy      10			         This line show where copy and
  To        40			         blend operations will take
  				         place.
   	       ͻ		       
  	        OK 		         To finish changing the 
	       ͼ		         colors, click on the OK button.
ͼ

Choosing SET, COPY, or BLEND will activate the color selector.  Press
the left button to choose a color or the right button to cancel the
operation.  Blend and copy require you to select two colors.

SET simply selects the color to change the RGB values of.

COPY will copy the first color to the second color.

BLEND will smoothly blend the colors between the two selected.  For example,
to create a gray scale, set one color to black, and another to white.  Blend
the two together by clicking on the black, and then the white.  The more
colors between the two selected, the smoother the transition is between
them.

LOAD and SAVE will bring up a file selector for selecting the palette.
The default palette may be changed by modifying the "default.pal" file.


                   WordUp Graphics Toolkit:  Sprite Editor            Page 12

Toolbank:
~~~~~~~~~
This is located in the top middle part of the screen.  It
contains most of the tools you will need to control the WGT Sprite
Editor.  Each tool in the toolbank is described in detail below.

The toolbank is split into two sets, and you can switch between them with
the bottom right tool in the toolbank.


The Tools:
~~~~~~~~~~

First Toolbank:
~~~~~~~~~~~~~~~

PENCIL:
                The pencil tool lets you draw individual pixels where you 
		click the mouse. It is the simplest of the tools.

LINE:
		The line tool will draw a line between two points. Click on
                the first point, and hold the button. Move the mouse to the
                second point and release the button to draw the line.

BOX:
            	The box tool will draw a rectangle between two corners. Click
                on one corner of the rectangle. Hold the button down while
                you move to the second corner and then release the button to 
                draw the rectangle.

BAR:
	        The bar tool will draw a filled rectangle between two 
              	corners.  Click on one corner of the rectangle. Hold the 
              	button down while you move to the second corner and then 
              	release the button to draw the bar.

                   WordUp Graphics Toolkit:  Sprite Editor            Page 13

CIRCLE:
		The circle tool will draw a hollow circle where you click 
               	the mouse.  Click on the center of the circle and hold the 
               	button while you move the mouse away from the center point. 
                This will change the radius of the circle.  Release the 
                button to draw the circle.

FILLED CIRCLE:
		The filled circle tool lets you draw a filled circle where 
               	you click the  mouse. Click on the center of the circle and 
              	hold the button while you move the mouse away from the center
                point.  This will change the radius of the circle. Release 
                the button to draw the filled circle.

ELLIPSE:
	        The ellipse tool lets you draw a hollow ellipse where you 
                click the mouse. Click on the center of the ellipse and hold 
                the button while you move the mouse away from the center 
                point.  This will change the horizontal and vertical radius 
                of the ellipse depending on the distance away from center in
                each direction.  Release the mouse button to draw the 
                ellipse.

FILLED ELLIPSE:
		The ellipse tool lets you draw a filled ellipse where you 
                click the mouse. Click on the center of the ellipse. Hold 
                the button while you move the mouse away from the center 
                point. This will change the horizontal and vertical radius 
                of the ellipse depending on the distance away from center in 
                each direction. Release the mouse button to draw the filled 
                ellipse.

POLYGON:
	        The polygon tool lets you draw a hollow polygon from a set 
                of points you select.  Click on the first point with either
                the left or right mouse button. This will start the polygon
                using the appropriate button color.  You may continue to 
                add new points using the left button.  The right button will 
                finish the polygon and connect the first point with the last.

FILLED POLYGON:
		The filled polygon tool lets you draw a filled polygon from a
                set of points you select.  Click on the first point with 
                either the left or right mouse button. This will start the 
                polygon using the appropriate button color.  You may 
                continue to add new points using the left button.  The 
                right button will finish the polygon by connecting the first 
                point with the last, and filling the shape.


                   WordUp Graphics Toolkit:  Sprite Editor            Page 14

SPRAY CAN:
	      	The spray can lets you draw random pixels around the place 
                you click with the mouse, simulating a spray paint effect.
                Left and right buttons have different drawing colors when 
                clicking in the edit window.

                If you click on the spray can tool in the toolbox with the 
                right hand button, a small menu appears which allows you
                to change the spray settings.  Click on the plus and minus 
                buttons to change the values. From this menu, you can modify 
                the delay time, and size of the spray.

FILL REGION:
		The fill region tool lets you fill an area of the sprite 
                with a color.  The area is bounded by any color other than 
                the one at the pixel you clicked on. Left and right buttons
                have different drawing colors.

COLOR CHANGE:
		The color change tool lets you change pixels of one color to
                a new color, given a rectangular area. Click on the first 
                corner of the rectangle. Hold the button and move to the 
                second corner.  Release the mouse button and all pixels of
                the right mouse button color will be changed to the left 
                mouse button color.

WHICH COLOR:
		The which color tool lets you change the left or right mouse 
                button color by choosing a color from the sprite.  Click on 
                the pixel anywhere on the screen and the drawing color for 
                the button you pressed will be changed.

GET REGION:
		The get region lets you cut and paste portions of a sprite.
                Click on the first corner of the area to grab. Hold the 
                button and move to the second corner. Release the mouse 
                button and the area selected will be stored in a paste 
                buffer.  You then use the paste region tool to paste the 
                area onto the sprite in a new location. The area selected is 
                not cleared to color 0.  


                   WordUp Graphics Toolkit:  Sprite Editor            Page 15

PUT REGION:
		The put region lets you cut and paste portions of a sprite.
                Click and hold the mouse button while in the edit window.  
                You can move the region that was grabbed by the get region 
                tool to the new location. Releasing the button will paste 
                the region onto the sprite.  If you change your mind, and do
                not want to paste the region onto the sprite, move the 
                region off the bottom right side so the sprite will not be
                modified.

HORIZONTAL FLIP:
		The horizontal flip tool flips the entire 64x64 drawing
                buffer horizontally.  

VERTICAL FLIP:
		The vertical flip tool flips the entire 64x64 drawing
                buffer vertically.

CLEAR SPRITE:
		The clear sprite tool erases the drawing buffer for working
                on a new sprite.  The current zoom window area is not reset 
                to the full window.  Use the UNDO tool to recover the sprite
                if you click on this by mistake since it doesn't confirm 
                the action. 

DELETE SPRITE:
		The delete sprite tool removes a sprite from the storage, 
                and moves any sprites after it back one storage slot.  Make 
                sure you insert a blank sprite if program already uses the 
                file or your sprites will have the wrong slot numbers.

INSERT SPRITE:
		The insert sprite tool moves all sprites between the current 
                slot location and the end of the file up one slot number. 
                It then puts a blank sprite (which takes no memory) into
                the current slot. In other words, it makes a space for a new
                sprite between the current slot and the slot before. If a
                sprite exists at the last slot (2000) the operation is 
                aborted.

                   WordUp Graphics Toolkit:  Sprite Editor            Page 16

TEXT:
	       	The text tool allows you to print text onto the clipboard. 
                You can use and test custom fonts that have been created 
                with the sprite editor. A text menu will appear when you
                select this tool. It has the following options:
 
                                ͻ
                                  Load Font   
                                 Default Font 
                                  Type Text   
                                     Exit     
                                ͼ

                Load font will bring up the file selector.  Font files have 
                the extension ".wfn" and can be created using the Create Font
                tool.

                Default font returns to the default 8x8 font, if you have 
                chosen a custom font previously.

                Type text switches views to the clipboard. Click on the 
                place you want the text to appear. Type in your text with 
                the keyboard.  Hitting enter will move the cursor to the 
                next row. Also, you can use the backspace key to correct 
                any mistakes.  The left mouse button color is used for the
                text color.

                Exit will take you back to the main menu.

LOAD/SAVE PICS:
                This tool brings up a menu for loading and saving pictures 
                which are stored in another format. You can load BLK, PCX, 
                PAK, CEL, or GIF pictures.  You can save BLK, PCX, PAK or
                CEL pictures.

                After clicking on the button, you will be asked if you want 
                to load or save a picture. The first two selections operate
                on the picture in the clipboard.  The second two selections
                (load/save single) operate on the sprite in the current
                storage slot.  Using these, you can directly load an 
                image into a single sprite slot, or export individual
                sprites.

                After selecting one, another menu appears which lets you 
                choose which kind of picture to load or save.  If you choose 
                a type, a file selector appears and you may select your 
                picture.  If you are loading a picture, it will not be shown 
                immediately when you are loading it into the clipboard.  You
                will have to use the Get Sprite or Get Big Sprite tool to 
                use the picture.

                Loading a GIF picture
               	~~~~~~~~~~~~~~~~~~~~~
                Loading a GIF is different than the other pictures because 
                they may be larger than the screen.  Use the arrow keys to 
                pan around a large picture and hit enter to use the current 


                   WordUp Graphics Toolkit:  Sprite Editor            Page 17

                portion being displayed.  You need to hit enter even if the
                GIF is smaller than the screen.

                If you are loading a picture which contains a palette, you
                will be asked if you want to use the palette of the picture,
                or remap the picture to the current colors.  Remapping will                
		attempt to recolor the picture with the current palette.
                When loading a picture, the Sprite Creator modifies the 
                palette for its own use. It makes sure color 1 is white,
                and colors 253-255 are grays.  If the picture uses these
                colors, it will appear different.  To get around this, load
                the picture in twice, the first time using the palette,
                and the second time remapping it.  This will ensure the
                picture is as close as possible to the original.  
                Alternately, you can turn off the color lock option from the
                setup screen.  This will force the editor's menu colors to
                be the ones in the picture.


                If you are loading a single picture into a storage location, 
                the palette information is ignored, and no color remapping 
                is performed.

TRASH SPRITES:
		The trash sprites tool deletes all of the sprites from the 
                storage. You will be asked to confirm this action.

CLEAR CLIPBOARD:
		The clear clipboard tool will clear the clipboard with a 
                color, depending on which mouse button you click.  

UNDO:
	        The undo tool restores the sprite with what is in the 
                current undo buffer. The sprite is copied into an undo buffer 
                every time you click on a tool button.  For example, if you 
                click on the circle tool and draw a circle, then click on 
                the undo tool, the circle will disappear, and the sprite
                returned to how it looked before.  Undo only works for tools 
                in the edit window. Actions such as CLB, or getting/putting 
                with the storage cannot be undone.

LOAD SPRITES:
		The load sprite file tool prompts for a filename with the 
                file selector.  The current storage area is erased and the 
                new sprite file is loaded.  All sprites in the current
                storage area will be lost.


                   WordUp Graphics Toolkit:  Sprite Editor            Page 18

SAVE SPRITES:
		The save sprite file tool prompts for a filename with the 
                file selector.  If the sprite file you choose already exists, 
                a backup will be made with the extension ".spb".  You may 
                turn this option off in the setup screen.  The current 
                storage is saved into a sprite file for loading into your 
                own programs.

QUIT:
           	The quit tool will exit the sprite editor and your unsaved 
		sprites will be lost.  You will be confirmed on this action.

OTHER TOOLBANK:
		The other toolbank allows you to switch between two sets of 
                tools.  The first tools you see when running the sprite 
                editor are only half of them.  Click on this to use the 
                second half.  

Second Toolbank:
~~~~~~~~~~~~~~~

ROTATE 90:
	      	The rotate 90 degrees tool quickly rotates the image by 90 
                degrees counterclockwise.  For other angles, see the freehand
                rotate tool.

FREEHAND ROTATE:
		The freehand rotate tool brings up a rotation menu which 
                looks like this:

                                ͻ
                                    One frame    
                                ĺ
                                 Start  -  1  +  
                                 End    - 10  +  
                                ĺ
                                 Multiple Frames 
                                ĺ
                                       Exit      
                                ͼ

                One frame will allow you to choose the angle of rotation and 
                visually see the sprite when it is rotated by that angle.  
                After choosing your angle, click on the done button. The 
                sprite will be grabbed into a 64x64 buffer.  If the rotated 
                sprite is larger than 64x64, it will be cut off around the
                edges to fit into the zoom window.  The start and end buttons 
                select a range of sprites which will be used when the 


                   WordUp Graphics Toolkit:  Sprite Editor            Page 19

                multiple frames button is selected.  The sprite will be 
                rotated 360 degrees within the start and end range.  This 
                makes it extremely easy to rotate an image.  To rotate an
                image 360 degrees by 10 degree increments, choose a range 
                with 36 sprites and click on multiple frames.

                The sprite editor will first find the smallest sprite size 
                needed to fit all of the rotated images. It will then rotate 
                each image and place it in the storage area.  Sprites may 
                need to be adjusted manually for centering, and pixel 
                touch-ups.

RESIZE SPRITE:
		The resize sprite tool takes the current sprite in storage 
                and resizes it over the clipboard.  While on the clipboard 
                screen, pressing the left button will resize the sprite 
                between the top left corner and the mouse cursor, and the 
                right button will exit. 

RESIZE SCREEN:
		The resize clipboard tool is the same as the resize sprite 
                tool only it resizes the entire clipboard instead of the 
                current sprite. 

GET SPRITE:
		The get sprite tool grabs a portion of the clipboard into 
                the edit window.  This lets you grab sprites from PCX, GIF, 
                and other pictures. Click on the top left corner of the 
                sprite.  Move to the bottom right  corner and click again.
                The maximum size for this tool is a 64x64 sprite. To grab 
                large sprites, see the get big sprite tool.

PUT SPRITE:
		The put sprite tool takes the sprite in the drawing buffer 
                and allows you to paste it onto the clipboard.  You can 
                create a full screen picture by pasting various sprites onto 
                the clipboard, and save it as a PCX, CEL or WGT's custom 
                image formats.  Clicking the left button while viewing the 
                clipboard will paste and the right button will exit. 
                If the right button is clicked on this tool, the sprite in 
                the current storage slot will be pasted instead of the sprite
                in the drawing buffer.  This allows you to paste sprites
                which are larger than 64x64 onto the clipboard.

                   WordUp Graphics Toolkit:  Sprite Editor            Page 20

COPY SPRITES:
                The copy sprites tool lets you copy a range of sprites to a 
                new location.  A menu will be displayed where you can select 
                the range you wish to copy. After setting the source and 
                destination slot numbers, click on the copy button.  If the 
                source and destination ranges overlap, the sprites will not
                be copied, and a tone will sound.  Clicking on the abort 
                button will return to the main drawing screen.

MOUSE CURSOR:
		This tool allows you to design a new shape for the mouse 
                cursor.  Two 16x16 pixel sprites are needed to use this 
                tool.  Draw all pixels that will appear white in the first
                sprite.  Any color other than 0 will be considered white.
                To create the second sprite, choose a different color and 
                make an outline around the first sprite.  Any pixels set in 
                this sprite will appear black.  To test the mouse cursor, 
                position the current storage area on the first sprite, and 
                choose the Mouse Cursor tool. If the sprites are not 16x16 
                or the storage is in the incorrect place a tone will sound 
                and you will return to the main screen.  Otherwise, the mouse
                will change into your cursor so you can see what it will 
                look like.  Pressing S will prompt for a filename with the 
                file selector.  It then saves a portion of C language code 
                which you can later use with the mouseshape command in WGT.  

GRID GRAB:
	      	The grid grab tool lets you quickly grab a number of images 
                which have been arranged in a grid on a picture.  The most 
                common use for this tool is for grabbing tiles, since they 
                are all equal in size and fit into a grid perfectly. A menu 
                will appear which looks like this: 

                            ͻ
                                Grid Width           16    
                                Grid Height          16    
                                Number of Columns    20    
                                Number of Rows       12    
                                Horizontal Spacing   1     
                                Vertical Spacing     1     
                                Offset from left     0     
                                Offset from top      0     
                            ĺ
                             V I E W   G R A B   E X I T 
                            ͼ


                   WordUp Graphics Toolkit:  Sprite Editor            Page 21

                If you click on the number beside each option, you may edit 
                the value.   Horizontal and vertical spacing is the number 
                of pixels between each tile in the grid. The offset values
                let you move the grid around the screen.  Click on view to 
                see what the grid looks like with the current values.  
                Clicking on grab will go through each tile in the grid and 
                grab the next sprite.  Sprites will be grabbed starting at
                the current storage location, but only if the grid box is
                completely on the screen.

REMAP SPRITES:
		The remap sprites tool prompts you for a filename of a 
                palette file.  All the sprites in the storage will then be
                remapped to use the palette chosen.  

GET BIG SPRITE:
		The Get Big Sprite tool allows you to grab a sprite off the 
                clipboard that is larger than 64x64 pixels.  Note that you 
                cannot edit these sprites due to the limitations of the 
                sprite editor.  You can paste the large sprites back onto 
                the clipboard by pressing the right hand button on the put 
                sprite tool.  Other WGT commands that use sprites will be 
                able to use these large sprites without any modifications 
                to your program.  A sprite larger than 64x64 will be 
                reduced to fit within the storage location at the bottom
                of the screen, and the sprite's actual size is displayed
                at the top of the reduced image.

PUT LAST:
	       	The Put Last Tool is the same as the Put Sprite tool but you 
                do not get to select where it will go on the clipboard. 
                Instead, the sprite is pasted where you last grabbed a 
                sprite with either the Get Sprite or Get Big Sprite tools.
                You can edit a full screen picture easier with this tool.  
                First grab an area of the picture using the Get Sprite tool.
                Edit the area as you would a normal sprite.  Now click on 
                this tool and your changes will be copied to the clipboard.  

LOAD ANIMATION:
		This tool loads in an animation sequence that was previously 
                saved with the Save Animation Sequence tool.  Animation 
                sequences are created and used in the animation menu.

SAVE ANIMATION:
		This tool saves an animation sequence that you have designed 
                in the animation menu.  This is useful if your animation is 
                fairly long and it is difficult to recreate.  You should
                keep animation sequences of important images so you can 
                easily see what the final animation will look like if you
                make some changes.

                   WordUp Graphics Toolkit:  Sprite Editor            Page 22

ANIMATE:
	        The animate tool lets you preview your sprites in animation.
                This is useful for seeing if the sprites will animate 
                correctly within your program.  A menu will appear in the 
                edit window.  It has the following options:

                                 ͻ
                                         Clear all        
                                 ĺ
                                                          
                                  Slot number   -  0 +  A 
                                  Sprite number -  3 +  D 
                                  Delay         -  6 +  D 
                                                          
                                                          
                                                          
                                                          
                                 ĺ
                                   Animate         OK    
                                 ͼ

                CLEAR ALL will wipe out the whole animation sequence. 
                You will be asked to confirm this choice.  The last three 
                options have push buttons for increasing or decreasing 
                values.  Clicking the left button will change it by one.                 
		Clicking the right button will keep changing the value
                while you hold down the button. This is useful for quickly 
                setting the number.

                SLOT NUMBER may range from 1 to 80.  This means you can have 
                up to 80 sprites in the animation sequence.  Each slot has a
                unique sprite number and delay value.  

                SPRITE NUMBER contains the sprite from the storage for this 
                slot.  The sprite will be shown just below the delay option. 
                A sprite number of -1 means the sequence is finished.

                DELAY contains the delay value for the current slot.  
                To the right of the slot number values is a button called 
                ADD. Clicking on it will increase the slot number, and 
                increase the sprite number at the same time. This is very 
                useful if you have arranged your sprites in sequence.  You 
                can quickly set up the animation sequence by holding the 
                right mouse button. If you go too far, set the first unwanted 
                sprite to -1, to stop the animation at that point.

                At the bottom of the menu is the animate button. Press and 
                hold this button to animate the sprite. For each slot, the 
                sprite is shown for a period of time, depending on how long 
                the delay value is.  The sequence is repeated when a sprite 
                value of -1 is found.  See the Save and Load animation tools
                for managing your animation sequences.
                

                   WordUp Graphics Toolkit:  Sprite Editor            Page 23

SHRINK SPRITE:
		The shrink sprite tool removes all black pixels (color 0) on 
                the top left edges of the current sprite in the storage.  
                This is meant to chop off any extra space that is not needed 
                in the sprite. After the sprite is shrunk, it is moved into 
                the edit window.  If you have aligned your sprites for 
                animation purposes to a certain x and y offset, this tool 
                will cause you problems, and you should only use the trim 
                sprite tool.

TRIM SPRITE:
		The trim sprite tool removes all black pixels (color 0) on 
                the bottom right edges of the current sprite in the storage.
                This is meant to chop off any extra space that is not needed 
                in the sprite. After the sprite is trimmed, it is moved into 
                the edit window. If you have aligned your sprites for 
                animation purposes to a certain x and y offset, do not 
                worry. Trim will not move your sprite to the top left 
                corner of the window. Trim only changes the bottom right 
                corner if necessary. 

TRIM ALL:
	       	The trim all sprites tool removes all black pixels (color 0) 
                on the bottom right edges of all of the sprites in the 
                storage. This is meant to chop off any extra space that is 
                not needed in the sprite.  It operates the same as the
                trim sprite tool.  This tool is useful before saving a 
                sprite file. It will decrease the size of the sprite file,
                and save memory when you load the sprites from your 
                program. 

MACRO ON:
	       	This tool starts recording a macro which stores all of your 
                mouse selections.  You can later execute these actions again 
                on other sprites.  To make a set of actions perform on a 
                range of sprites, you can click on one of the storage 
                slider buttons as the last action.  When you play the macro 
                back a number of times, it will move to a new sprite and 
                perform those actions. Only mouse movements/clicks are 
                recorded.  If a keypress is detected, the macro will stop 
                playing.   Mouse actions in the file selector are NOT 
                recorded, so macros must not involve file operations.
                Macros are very useful for repetitive operations such as
                changing colors in sprites, and alignment adjustments.

MACRO OFF:
	      	This tool stops recording a macro, if you have previously 
                started recording using the macro on tool.   


                   WordUp Graphics Toolkit:  Sprite Editor            Page 24

MACRO PLAY:
		This tool will play the current macro the specified number 
                of times.  If you press the right button on this tool, you
                can set the number of times a macro will play.  This counter 
                will reset to 1 every time you execute the macro.  A macro 
                can be stopped in mid-execution by pressing a key.

LOAD MACRO:
                This tool lets you recall a macro you have saved.  This is 
                useful for keeping macros that you use often.

SAVE MACRO:
                This tool saves the current macro under a new name.  A file 
                selector will appear and allow you to choose a new name for 
                the macro.  Macros have the extension ".smc".

CREATE FONT:
                Custom fonts may be created using this tool.  A filename
                is requested for the new font file.  Font files have the
                extension ".wfn".  These fonts can be used with the text
                tool and within the WGT programming library.  To make a
                font file, place the images of the letters in storage
                locations 0-127.  The storage location corresponds to the
                number of the character in the ASCII table.  Several sample
                sprite files containing fonts have been included for you
                to begin with.  You can load in one of these files and simply
                replace the current images with your own, and save the file
                under a new name.  Once your characters are ready, click on
                this tool and type in a new font name.  Each sprite will be
                scanned and converted into a font.  Only monochrome fonts 
                with on/off states are allowed, and any pixel other than 
                color 0 will be considered to be turned on.  Font characters 
                must not be greater than 64x64 in size.  To test your new 
                font, load it into from the text menu and try typing some 
                text.

REGISTRATION:
		This button will display the initial title screen and allows
                you to print an order form.

SETUP OPTIONS:
                This button will take you into a setup screen where you can 
                toggle specific options of the WGT Sprite Editor on or off.
                This setup screen is described above in the installation 
                section of the Sprite Editor Manual.


                   WordUp Graphics Toolkit:  Sprite Editor            Page 25

DOS SHELL:
	      	This button will attempt to enter a DOS shell.  If you do 
                not have enough memory, it will return to the editor 
                Immediately.  Typing "exit" will return to the editor as you
                left it.                            

FREE MEMORY:
		This button will show how much free memory is left.  There 
                are three kinds of memory that are shown.  

                Conventional is the amount left in conventional RAM.

                EMS is the amount free in EMS memory.

                Fragmented is the amount of EMS memory that has been 
                fragmented.  Sprites will be placed in this memory first
                before trying to place them into EMS memory.

OTHER TOOLBANK:
		The other toolbank allows you to switch between two sets of 
                tools.  The first tools you see when running the sprite 
                editor are only half of them.  Click on this to use the 
                first half. 

Quick Pick Colors:
~~~~~~~~~~~~~~~~~~
The quick pick boxes are designed to store several commonly used colors
which can be recalled without hunting through the color selector.  Click
on the box with the right button to assign a new color to the box.  Move
the mouse over the color you wish and click the left button to assign
the new color.

Clicking the left button on the quick pick will set the left mouse button
color to the color in the quick pick box.


Put Storage:
~~~~~~~~~~~~
This button will save what is inside the zoom box into the current 
storage slot.  It does NOT save what is in the zoom window.  It only saves 
what is displayed in the edit window.  If a sprite already exists in the 
current storage slot, it is erased, and replaced with the new sprite.


                   WordUp Graphics Toolkit:  Sprite Editor            Page 26

Get Storage:
~~~~~~~~~~~~
This button will delete whatever is currently in the drawing buffer, 
and replace it with the sprite in the current storage slot.  If no sprite 
exists in the storage slot, nothing happens.

Storage Area:
~~~~~~~~~~~~~
The storage area holds all of your sprites.  It can hold up to 2000
sprites at once.  The middle box shows the current storage slot, while the 
ones on either sides show the previous and next slots. When a sprite file 
is saved, all the storage slots are saved into the file. 

The storage section is basically a group of sprites, which can be moved 
around in the storage, copied from one to another and of course saved and 
loaded back in.  Instead of having many files containing separate sprites 
and loading them in one at a time, you can put all the graphics in one file, 
and load them into your programs with one command.  The palette is saved as
well.  This is much more convenient than having lots of small graphic files 
because it allows you to edit them for animation quickly.  You will see 
three boxes in the lower right corner of the screen.  The middle box shows 
the sprite you are working with.  The boxes on either side show what is next
in the storage area.  The sprite number indicator shows the number of the 
middle box.

At the ends of the storage, a box marked with a large X will be shown.
You cannot store sprites in these storage slots.  If a storage slot does not 
contain a sprite, the word "EMPTY" will be shown at the top of the storage 
box.  This helps distinguish between sprites filled with black, and truly
empty sprites which take up no memory.

Storage Position:
~~~~~~~~~~~~~~~~~
The current storage slot may be changed by clicking on the icons on the 
left and right, and using the slider in the middle.  Clicking the right 
mouse button on the side icons will quickly move through the storage.  To use
the slider, hold the left button and move it to a new location.  The slider 
moves through the storage area in multiples of 20 sprites.



Zoom Window:
~~~~~~~~~~~~
This window shows the sprite with the actual size it will appear.  
Also, a zoom box is shown over the sprite.  This box is the region which 
is shown in the edit window.  The zoom box controls which area of the sprite 
is shown in the edit window, and it also defines what will be put into the 
storage when you click on the Put Storage icon.

                   WordUp Graphics Toolkit:  Sprite Editor            Page 27

Zoom Selectors:
~~~~~~~~~~~~~~~
These icons will allow you to change either corner of the zoom box.  
The first icon lets you change the upper left corner, and the second changes 
the bottom right.  An outline is shown around one of these boxes, to show
which corner can be moved.  As you change the size of the zoom box, the size 
indicators change accordingly.  

Scrollers:
~~~~~~~~~~
These allow you to scroll the sprite around within the sprite buffer.
They are used to view another area of the sprite while maintaining the same 
zoom magnitude, and also to move the sprite to a new location within the
drawing buffer.


Help System:
~~~~~~~~~~~~
The WGT Sprite Editor contains a help system that can be examined while
within the program.  To activate this system, click on the question mark
icon on the right of the screen.  The mouse cursor will change into a
question mark.  This is the point and click help mode.  If you click with
the left mouse button on a tool or other area on the screen, the help
information on that item will be shown.  A right mouse button click will
exit the help mode.   If you click on the help button twice, a table of
contents is shown.  You can use the mouse to browse through all the
available help topics and read the ones you click on.  Again, a right 
mouse button click will exit the help mode.

When a help topic is shown, it may contain more than one page of information.
Click a button or press a key to advance to the next page.

Status:
~~~~~~~
The status indicators show where the sprite storage slot is selected, 
and how large the current zoom box is.  You can modify these values by
clicking on the value, and typing in a new one.  This way you can jump to
a specific storage slot, or change the dimensions of the sprite to an exact 
size.


                   WordUp Graphics Toolkit:  Sprite Editor            Page 28

The File Selector:
~~~~~~~~~~~~~~~~~~
Any time you need to save or load a file, a file selector window will appear.  
The file selector is used to select a file, and move to different disk
drives and directories.   The file selector looks like this:

ͻ
         Load a sprite file          
ĺ
  
ĺ
 Ŀ    Ŀ    Ŀ 
  *.spr       *.*       *.spr  
          
 Ŀ Ŀ 
 A:                   <DRIVE>  - 
 B:                   <DRIVE>  Ĵ 
 C:                   <DRIVE>  ۳ 
 D:                   <DRIVE>  ۳ 
 GAMES                  <DIR>    
 WORK                   <DIR>    
 ADVENT.SPR             12056  Ĵ 
 SUPER.SPR             150345  + 
   
ĺ
               Cancel                
ͼ

At the top of the window, a title will be shown which tells you what file 
operation will be performed on the chosen file.  The most common file 
operations are loading and saving.  Below the title is a black box.  This is
the text entry box.  If you prefer typing in a filename instead of using the 
mouse, you can simply begin typing the filename.  After the first letter is 
pressed, a cursor will be shown in the text entry box.  You may also click 
on the box to begin entering your text.  The backspace, delete, and arrow 
keys are all functional when in the text entry box. 

Below the text entry box are three file mask buttons.  The first contains
the current file mask.  All files with this extension will be listed in 
the directory listing below.  If you want to change the file mask, click
on the first button and type in the new mask.  Hit enter when you are 
finished and the file listing will change accordingly.  The second file
mask button is always "*.*", which will list every file in the current
directory.  The third button sets the file mask to the default mask which
was first used in the file selector.  

In the middle of the file selector, the file listing is shown.  There are
three kinds of elements in the listing, each distinguished by the text to the
right of them.  Disk drives are shown with "<DRIVE>" beside the drive name.
Clicking on a drive will attempt to change the current directory to that
drive.  Directories are shown with "<DIR>" beside the directory name.  
Use the ".." directory name to move back a level in the directory tree.
Files are shown with their file size to the right of them.  Clicking on one
of these will close the file selector, and perform the action on the file.


                   WordUp Graphics Toolkit:  Sprite Editor            Page 29

To the right of the directory listing is a slider and two buttons.  The 
buttons move up and down through the directory listing.  The slider shows
a box in relation to which portion of the listing is being shown.  If you
hold the mouse button while dragging the box, you can quickly move to a
different location in the listing.  As well, moving up or down a page at
a time can be achieved by clicking above or below the box.

At the bottom of the file selector is a cancel button.  This is used to
abort the file operation.








