RealSprites

Introduction

Real sprites are the graphical part of .grf files; they are what the user actually sees in-game.

There are two distinctly different ways to write real sprites, depending on the info version you use. TTDPatch and OpenTTD until version 1.2 only understand GRF container version 1 resp. info version 7.

Info version 7

Available in  

Syntax

A real sprite has the following format:

<Sprite-number> <filename> <xpos> <ypos> <compression> <ysize> <xsize> <xrel> <yrel>

Element	Size	Description
<Sprite-number>	dec	A sequential sprite number
<filename>	string	The name of the .pcx or .png file in which the sprite will be found
<xpos>	dec	The x position of the upper-left corner of the sprite in the file
<ypos>	dec	The y position of the upper-left corner of the sprite in the file
<compression>	B	The "compression"; see below
<ysize>	dec	The y size of the sprite
<xsize>	dec	The x size of the sprite
<xrel>	dec	The x position of the upper-left corner of the sprite, relative to the "center" (usually negative)
<yrel>	dec	The y position of the upper-left corner of the sprite, relative to the "center" (usually negative)

filename

This specifies the name and path of the .pcx file. The path may be specified one of two ways:

1. An absolute path. (eg C:\GRF\sprites\filename.pcx)
2. A relative path; these are specified relative to the location of the .grf file. (eg sprites\filename.pcx)

For most purposes, relative paths are preferred, since .nfo files with relative paths are more portable than .nfo files with absolute paths.

xpos, ypos, ysize, and xsize

These are pretty easy to set, as long as you remember that the order is X, Y, Y, X, and not X, Y, X, Y.

Also, no sprite may contain zero pixels; ysize and xsize must both be at least 1.

Note: there is a bug in grfcodec 0.9.7 and earlier that prevents them from properly encoding a sprite with a smaller ypos value than any earlier sprite. The best way to circumvent this bug is to upgrade to the newest version.

compression

Unlike the other numbers, the compression is a hexadecimal bit-field. Currently, the following bits are supported:

bit	value	meaning
0	1	Color index 0 is transparent (should always be set; ignored if bit 3 is set)
1	2	Store compressed sprite in memory
3	8	Sprite is in chunked data format (aka "tile compression")
6	40	Sprite should not be cropped. (obeyed by GRFCodec r1604 and later)

The only valid values for compression are 00, 01, 02, 03 and 09 (except the special flag 0x40 that is only important for grfcodec). Values 00 - 03 are handled the same by OpenTTD. If you don't care about the difference for TTDPatch either use 01 or 09.

The best value depends on which and how many pixels are transparent: If the non-transparent pixels are arranged to bigger blocks along the pixellines (like for ground tiles or diagonal views of vehicles) use 09 (chunked data format). If there are no transparent pixels or transparent pixels and non-transparent alternate a lot along the pixellines use 01.

If you are interested in improving drawing for TTDPatch (does not make a difference for OpenTTD): You can use 00 resp. 02 if there are NO transparent pixels at all. 00 is slightly quicker than 01. 02 is a valid value but does not make a lot of sense.

You can use 02 resp. 03 to store the sprite compressed in memory. Drawing will be slower, but the sprite needs less memory while it is not used. Useful for big sprites which are hardly used (like the newpaper "tycoon of the century" at game end)

It is generally a bad idea to use any other value, as that may cause problems. FF is an especially bad idea.

xrel and yrel

These two numbers will probably become the bane of your existence.

TTD stores a single point for every sprite. xrel and yrel specify how far right and down (respectively) to go from the TTD point to the upper-left hand corner of the sprite.

Halving xsize and ysize and negating the results produces a decent starting point for these values, and further adjustments may be done manually, e.g within OpenTTD by activating the NewGRF developer tools and using the sprite aligner or in TTDPatch 2.0.1 alpha 69 and later with the GRFAuthorHelperWindow.

Ranges

The ranges for the four numbers after the compression are as follows:

ysize: 1..255

xsize: 1..65535

xrel: -32768..32767

yrel: -32768..32767

ysize*xsize may not exceed 65535.

Other notes

It is a common practice, in action 1 blocks, to use the pseudosprite "-1 * 1 00" to take the place of a real sprite that will never be used. The most common use is for vehicle sets that will only be used in the purchase window. This reduces the size of the .grf file when compared to replacing them with one-pixel sprites (but not when compared to splitting the action 1 and making the second one define only one sprite), but does not save real-sprite slots. If TTD ever attempts to draw one of these sprites, it will, at best, crash.

Info version 32

Available in 1.2 

Syntax

<Sprite-number> <filename> 8bpp <xpos> <ypos> <xsize> <ysize> <xrel> <yrel> normal <flags>

 <Sprite-number> <filename> 8bpp  <xpos> <ypos> <xsize> <ysize> <xrel> <yrel> normal      <flags>
 |               <filename> 8bpp  <xpos> <ypos> <xsize> <ysize> <xrel> <yrel> <zoomlevel> <flags>
 |               <filename> 32bpp <xpos> <ypos> <xsize> <ysize> <xrel> <yrel> <zoomlevel> <flags>
 |               <filename> mask  <xpos> <pos>
                 ...

Sprite-number

This is a sequential sprite number, maximum value is 2**32

Filename

The graphics filename which the real sprite is found in

Type

Sprite type. The type of the 1st sprite must always be 8bpp and of 'normal' zoom level (see below). Subsequent lines for alternative sprites can be of any type and zoom level. Available types are:

Name	Description
8bpp	Sprite with 8 bit colour depth in one of the accepted palettes
32bpp	True colour sprite with 32 bit colour depth
mask	If used, this type must follow a '32bpp' entry immediately. Itself it is a 8bpp paletted sprite of the exact same size of the preceeding 32bpp sprite. It defines the colour translation for this preceeding 32bpp sprite: Palette entry 0 means to draw the 32bpp as usual, the other colours define a replacement colour where then the preceeding 32bpp sprite is interpreted as giving intensity and alpha channel information.

xpos, ypos

The coordinates of the upper left corner of the sprite within the graphics file.

xsize, ysize

The width and height of the sprite within the graphics file. The valid value range is from 1 to 65535 for both.

xrel, yrel

The position of the upper-left corner of the sprite, relative to the "center" (usually negative). The valid value range is from -32768 to 32767.

zoom level

OpenTTD supports a number of zoom levels. For 'normal' zoom level a tile has a width of 64 pixels and a height of 31 (see coordinates). Available zoom levels are:

name	zoom level	Tile size	Description
normal	(normal)	64 x 31	The standard
zo8	8x out	8 x 3	3rd zoomed-out state (maximum zoomed-out)
zo4	4x out	16 x 7	2nd zoomed-out state
zo2	2x out	32 x 15	1st zoomed-out state
zi2	2x in	128 x 62	1st zoomed-in state
zi4	4x in	256 x 124	2nd zoomed-in state (fullly zoomed-in)

Flags

Flags allow to describe certain special treatment of the sprites:

name	Description
nocrop	Disallow grfcodec to crop transparent pixels off the sprite to the minimum size possible without loosing information. Use this when the actual sprite size matters (i.e. when child sprites rely on it).
chunked	Store the sprite compressed. It saves space for 'diagonal' sprites with lots of transparency like diagonal views of vehicles.

Transparency and glass effect

Transparency and glass effects can be achieved by means of RecolorSprites

Example

The best way to see real sprites is to decode one of TTD's standard .grf files. With very few exceptions, all sprites in those files are real sprites; the few that are not are RecolorSprites.

Example real sprites can also be found at the bottom of Action1 or ActionA.

Those sprites use absolute paths. Removing the C:\TTD\ part of each filename would work just as well, assuming you want the .grf file to appear in C:\TTD.

Info version 32:

   3 sprites/58_8.png 8bpp 0 0 128 64 -63 -23 normal nocrop
   | sprites/58_x2_8.png 8bpp 0 0 256 128 -127 -46 zi2 chunked nocrop // comment
   | sprites/58_x2_32.png 32bpp 0 0 256 128 -127 -46 zi2 chunked nocrop 
   | sprites/58_x2_32m.png mask 0 0