RealSprites - Revision history

Peter1138: /* Type */ Note that OpenTTD does not actually require 8bpp first.

2023-12-12T18:22:20Z

Type: Note that OpenTTD does not actually require 8bpp first.

← Older revision		Revision as of 18:22, 12 December 2023
Line 124:		Line 124:
	The graphics filename which the real sprite is found in		The graphics filename which the real sprite is found in
	==== Type ====		==== Type ====
			Sprite 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:~~

		⚫	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.

			Note that OpenTTD does not enforce this requirement and is able to load and display 32bpp-only sprites. However if there is no 8bpp sprite and the player is using an 8bpp mode then the fallback "red question mark" sprite will be used instead.

			Available types are:
	{\|		{\|
	!Name!!Description		!Name!!Description

Frosch: /* zoom level */

2016-08-07T16:22:18Z

zoom level

← Older revision		Revision as of 16:22, 7 August 2016
Line 144:		Line 144:
	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:		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!!Grid size !!Groundsprite with zig-zag border!!Groundsprite with smooth border!!xrel, yrel!!Description		!name !!zoom level!!Grid size !!Groundsprite with zig-zag border!!Groundsprite with smooth border!!xrel, yrel with smooth border!!Description
	\|-		\|-
	\|zo8 \|\| 8x out \|\| 8 x 4 \|\| 8 x 3 \|\| 8 x 3 \|\| -3, 0		\|zo8 \|\| 8x out \|\| 8 x 4 \|\| 8 x 3 \|\| 8 x 3 \|\| -3, 0
Line 166:		Line 166:
	If you have a normal-zoom sprite with (xrel, yel), the 2x zoom-in sprite will have (2xrel, 2yrel-1), and the 4x zoom-in sprite will have (4xrel, 4yrel-2).		If you have a normal-zoom sprite with (xrel, yel), the 2x zoom-in sprite will have (2xrel, 2yrel-1), and the 4x zoom-in sprite will have (4xrel, 4yrel-2).

	These conversions are implied by how OpenTTD draws foundations, in particular half-tile foundations. At 1x zoom the vertical slope edge is between two pixels, and the horizontal slope edge is in the middle of a pixel.		These conversions are implied by how OpenTTD draws foundations, in particular half-tile foundations. At 1x zoom the vertical slope edge is between two pixels, and the horizontal slope edge is in the middle of a pixel. That is: The middle of the tiles (green line) needs to line up, the top of the tiles (red line) then does not line up:
			[[File:Groundsprites_4x.png]]

	==== Flags ====		==== Flags ====

Frosch: /* zoom level */

2016-08-07T14:12:31Z

zoom level

← Older revision		Revision as of 14:12, 7 August 2016
Line 144:		Line 144:
	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:		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		!name !!zoom level!!Grid size !!Groundsprite with zig-zag border!!Groundsprite with smooth border!!xrel, yrel!!Description
	\|-		\|-
			\|zo8 \|\| 8x out \|\| 8 x 4 \|\| 8 x 3 \|\| 8 x 3 \|\| -3, 0
	\|normal\|\| (normal) \|\| 64 x 31 \|\| The standard
			\|rowspan="3"\| zoomed-out
	\|-		\|-
	\|~~zo8~~ \|\| 8x out \|\| 8 x 3 \|\| ~~3rd~~ ~~zoomed-out~~ ~~state~~ ~~(maximum~~ ~~zoomed~~-~~out)~~		\|zo4 \|\| 4x out \|\| 16 x 8 \|\| 16 x 7 \|\| 16 x 7 \|\| -7, 0
	\|-		\|-
	\|~~zo4~~ \|\| 4x out \|\| 16 x 7 \|\| ~~2nd~~ ~~zoomed~~-~~out~~ ~~state~~		\|zo2 \|\| 2x out \|\| 32 x 16 \|\| 32 x 15 \|\| 32 x 15 \|\| -15, 0
			\|- style="background:lightblue"
			\|normal\|\| (normal) \|\| 64 x 32 \|\| 64 x 31 \|\| 64 x 31 \|\| -31, 0 \|\| The standard
	\|-		\|-
	\|~~zo2~~ \|\| 2x ~~out~~ \|\| 32 x 15 \|\| ~~1st~~ ~~zoomed~~-~~out~~ ~~state~~		\|zi2 \|\| 2x in \|\| 128 x 64 \|\| 128 x 62 \|\| 128 x 63 \|\| -62, -1
			\|rowspan="2"\| zoomed-in
	\|-		\|-
	\|~~zi2~~ \|\| 2x in \|\| 128 x 62 \|\| ~~1st~~ ~~zoomed~~-in ~~state~~		\|zi4 \|\| 4x in \|\| 256 x 128 \|\| 256 x 124 \|\| 256 x 127 \|\| -124, -2
	\|-		\|-
	\|~~zi4~~ \|\| 4x in \|\| ~~256~~ x ~~124~~ \|\| ~~2nd~~ ~~zoomed~~-in ~~state~~ (~~fullly~~ ~~zoomed~~-in)		\|zi(X) \|\| (X)x in \|\| (X32) x (X16) \|\| (X32) x floor(X15) \|\| (X32) x (X16-1) \|\| ceil(X-31), ceil(X-1/2) \|\| Generalisation
	\|}		\|}

			Hint:
			If you have a normal-zoom sprite with (xrel, yel), the 2x zoom-in sprite will have (2xrel, 2yrel-1), and the 4x zoom-in sprite will have (4xrel, 4yrel-2).

			These conversions are implied by how OpenTTD draws foundations, in particular half-tile foundations. At 1x zoom the vertical slope edge is between two pixels, and the horizontal slope edge is in the middle of a pixel.

	==== Flags ====		==== Flags ====

Zephyris: /* Type */ 8ppp -> 8bpp

2012-08-15T09:52:59Z

Type: 8ppp -> 8bpp

← Older revision		Revision as of 09:52, 15 August 2012
Line 124:		Line 124:
	The graphics filename which the real sprite is found in		The graphics filename which the real sprite is found in
	==== Type ====		==== Type ====
	Sprite type. The type of the 1st sprite must always be ~~8ppp~~ and of 'normal' zoom level (see below). Subsequent lines for alternative sprites can be of any type and zoom level. Available types are:		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		!Name!!Description
Line 134:		Line 134:
	\|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.		\|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 ====		==== xpos, ypos ====
	The coordinates of the upper left corner of the sprite within the graphics file.		The coordinates of the upper left corner of the sprite within the graphics file.

Frosch: link to version numbers page

2012-04-01T17:20:48Z

link to version numbers page

← Older revision		Revision as of 17:20, 1 April 2012
Line 3:		Line 3:
	Real sprites are the graphical part of .grf files; they are what the user actually sees in-game.		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 info version 7.		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 [[Version_numbers#GRF_container_version\|GRF container version 1]] resp. [[Version_numbers#NFO_version\|info version 7]].

	== Info version 7 ==		== Info version 7 ==

Planetmaker: /* zoom level */ sprite size for zoom-in sprites was given wrongly

2012-03-22T00:36:01Z

zoom level: sprite size for zoom-in sprites was given wrongly

← Older revision		Revision as of 00:36, 22 March 2012
Line 153:		Line 153:
	\|zo2 \|\| 2x out \|\| 32 x 15 \|\| 1st zoomed-out state		\|zo2 \|\| 2x out \|\| 32 x 15 \|\| 1st zoomed-out state
	\|-		\|-
	\|zi2 \|\| 2x in \|\| 128 x 63 \|\| 1st zoomed-in state		\|zi2 \|\| 2x in \|\| 128 x 62 \|\| 1st zoomed-in state
	\|-		\|-
	\|zi4 \|\| 4x in \|\| 256 x ~~127~~ \|\| 2nd zoomed-in state (fullly zoomed-in)		\|zi4 \|\| 4x in \|\| 256 x 124 \|\| 2nd zoomed-in state (fullly zoomed-in)
	\|}		\|}

	==== Flags ====		==== Flags ====
	Flags allow to describe certain special treatment of the sprites:		Flags allow to describe certain special treatment of the sprites:

Frosch: obiwan

2012-02-04T14:35:18Z

obiwan

← Older revision		Revision as of 14:35, 4 February 2012
Line 135:		Line 135:
	\|}		\|}
	==== xpos, ypos ====		==== xpos, ypos ====
	The coordinates of the upper left corner of the sprite within the graphics file. ~~The valid value range is from 0 to 65536~~		The coordinates of the upper left corner of the sprite within the graphics file.
	==== xsize, ysize ====		==== xsize, ysize ====
	The width and height of the sprite within the graphics file. The valid value range is from 0 to ~~65536~~.		The width and height of the sprite within the graphics file. The valid value range is from 1 to 65535 for both.
	==== xrel, yrel ====		==== 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.		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.
Line 185:		Line 185:
	3 sprites/58_8.png 8bpp 0 0 128 64 -63 -23 normal nocrop		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_8.png 8bpp 0 0 256 128 -127 -46 zi2 chunked nocrop // comment
	\| sprites/~~58_x2_8~~.png 32bpp 0 0 256 128 -127 -46 zi2 chunked nocrop		\| sprites/58_x2_32.png 32bpp 0 0 256 128 -127 -46 zi2 chunked nocrop
	\| sprites/~~58_x2_8~~.png mask 0 0		\| sprites/58_x2_32m.png mask 0 0

Planetmaker: new stuff goes after old stuff. Some other small corrections

2012-02-04T14:27:43Z

new stuff goes after old stuff. Some other small corrections

Show changes

Planetmaker: /* Syntax */ 32bpp info version

2012-02-04T14:06:16Z

Syntax: 32bpp info version

← Older revision		Revision as of 14:06, 4 February 2012
Line 4:		Line 4:

	== Syntax ==		== Syntax ==

			=== Info version 32 {{ottdp\|1.2\|ottdrev=r23890}} ===
			<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 8ppp 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
			==== xrel, yrel ====
			The position of the upper-left corner of the sprite, relative to the "center" (usually negative)
			==== 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 63 \|\| 1st zoomed-in state
			\|-
			\|zi4 \|\| 4x in \|\| 256 x 127 \|\| 2nd zoomed-in state (fullly zoomed-in)
			\|}
			==== Flags ====
			Flags allow to describe certain special treatment of the sprites:
			{\|
			!name!!Description
			\|-
			\|cropped \|\| Allow grfcodec to crop transparent pixels off the sprite to the minimum size possible without loosing information
			\|-
			\|chunked \|\| Store the sprite compressed. It saves space for 'diagonal' sprites with lots of transparency like diagonal views of vehicles
			\|}


			===Info version 7 {{ottdp\|1.2\|\|ottdrev=23890}}===

	A real sprite has the following format:		A real sprite has the following format:

Planetmaker: /* Syntax */ also png files are permissible

2011-11-16T09:34:01Z

Syntax: also png files are permissible

← Older revision		Revision as of 09:34, 16 November 2011
Line 14:		Line 14:
	\|<Sprite-number>\|\|dec\|\|A sequential sprite number		\|<Sprite-number>\|\|dec\|\|A sequential sprite number
	\|-		\|-
	\|<filename>\|\|string*\|\|The name of the .pcx file in which the sprite will be found		\|<filename>\|\|string<ref>Unlike strings in pseudo-sprites, this string should not have a terminating "00" and should not be placed in quotes.</ref>\|\|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		\|<xpos>\|\|dec\|\|The x position of the upper-left corner of the sprite in the file
Line 31:		Line 31:
	\|}		\|}

			<references />
	<nowiki>*</nowiki> Unlike strings in pseudo-sprites, this string should not have a terminating "00" and should not be placed in quotes.

	== Description ==		== Description ==