********************************************************************
* configuring a sprite 
********************************************************************

Sprites are specified by a .cfg file, which is a simple text file.  Two examples will be gone through below.

There are two types of sprites, type 0 and type 1.  Type 0 means that you simply want to give different properties to an existing sprite.  This is similar to using Tweaker to modify a sprite, but this way you won't overwrite the original.  Type 1 means that the sprite is a true custom sprite.

Type 0 example:

squashable_goomba.cfg:
00
0F
30 00 04 00 00 00

The first line of the .cfg specifies the sprite type.  Here it is 0 because we just want to tweak an existing sprite.  

The next line specifies the "acts like" byte.  This is the value that gets put into $9E.  For type 0 sprites, it should be set to the sprite you wish to use as a base.

The next line specifies the sprite properties (6 bytes separated by spaces) that are put in the main sprite tables (1656, 1662, 166E, 167A, 1686, and 190F).  These are the first 6 bytes of the Tweaker code.


Type 1 example:

venus.cfg:
01
36
81 01 08 00 10 20
00 00
venus.asm

The first line of the .cfg specifies the sprite type.  Here it is 1 becuase we have a true custom sprite.  

The next line specifies the "acts like" byte.  It's the value that gets put into $9E.  For type 1 sprites, it should almost always be set to 36.

The next line specifies the sprite properties (6 bytes separated by spaces) that are put in the main sprite tables (1656, 1662, 166E, 167A, 1686, and 190F).  They are the first 6 bytes of the Tweaker code.

The next line specifies two additional property bytes that can be used by the programmer.  They are put into tables at $7FAB28 and $7FAB34.

The last line is the name of the asm file that contians the sprite code.