SHP - Revision history

MarkJFox: 22 revisions imported

2025-03-31T19:25:06Z

22 revisions imported

← Older revision	Revision as of 21:25, 31 March 2025
(No difference)

en>Crimsonum at 17:01, 7 September 2018

2018-09-07T17:01:52Z

← Older revision		Revision as of 19:01, 7 September 2018
Line 1:		Line 1:
	~~SHP (TS)~~ files are used on Tiberian Sun, FireStorm, Red Alert 2 and Yuri's Revenge to make buildings, infantry, animations, cameos (sidebar icons), among many other things. They consists on images with several frames using 256 colours from an external palette. Several programs are able to create and edit them like OS SHP Builder, Will's SHP Editor, XCC Mixer, etc. Several modders use XCC Mixer to convert images made with 3rd party programs into this format, while others edit them straight with OS SHP Builder.<br>		Shape files, or SHPs as they are more commonly known, are used on Tiberian Sun, FireStorm, Red Alert 2 and Yuri's Revenge to make buildings, infantry, animations, cameos (sidebar icons), among many other things. They consists on images with several frames using 256 colours from an external palette. Several programs are able to create and edit them like OS SHP Builder, Will's SHP Editor, XCC Mixer, etc. Several modders use XCC Mixer to convert images made with 3rd party programs into this format, while others edit them straight with OS SHP Builder.<br>

	Below, I'll explain the file format and how does it work, so future programmers may also be able to play with these files:<br>		Below, I'll explain the file format and how does it work, so future programmers may also be able to play with these files:<br>

58.109.97.210 at 00:37, 19 June 2007

2007-06-19T00:37:57Z

← Older revision		Revision as of 02:37, 19 June 2007
Line 60:		Line 60:
	07 00 00 09 53 00 9C		07 00 00 09 53 00 9C
	This would be 9 pixels of transparent colour, colour 0x53 in the [[PAL\|pallette]], and then another 0x9C pixels of transparent.		This would be 9 pixels of transparent colour, colour 0x53 in the [[PAL\|pallette]], and then another 0x9C pixels of transparent.
	~~This format repeats until all the lines in the image have been accounted for.~~

	~~Second method:<br>~~
	The second method is used when the flag data of the frame is exactly 0x02. In this format (which I suppose isn't really compression), there are the two bytes to indicate how many bytes in the line, then a byte for each colour of the pixels in that line.
	This format repeats until all the lines in the image have been accounted for.		This format repeats until all the lines in the image have been accounted for.

58.109.97.210 at 12:26, 17 June 2007

2007-06-17T12:26:37Z

← Older revision		Revision as of 14:26, 17 June 2007
Line 56:		Line 56:
	First method:<br>		First method:<br>
	The first two bytes of the frame data indicate how many bytes are in the line (that is, how many bytes of the frame data represent a whole row of pixels). This count includes the two bytes that say how many bytes in the line (for example if the value was 8, there would be 6 bytes of pixel information until the next line).<br>		The first two bytes of the frame data indicate how many bytes are in the line (that is, how many bytes of the frame data represent a whole row of pixels). This count includes the two bytes that say how many bytes in the line (for example if the value was 8, there would be 6 bytes of pixel information until the next line).<br>
	After this, there is a ~~byte~~ indicating which index of the [[PAL]] file the colour is, then a byte ~~indicating~~ how many pixels of ~~this~~ colour are to be written. This ~~format~~ of ~~1 pixel for~~ colour, ~~1 pixel for count continues until~~ the ~~next pixel row is reached (when you reach the number~~ of ~~bytes for this line)~~. ~~<br>~~		After this, there is a series of bytes indicating which index of the [[PAL]] file the colour is. In any case where the colour is 0x00, then the following byte indicates how many pixels of colour 0x00 (transparent) are to be written.
	This format ~~then~~ repeats for ~~each line in Frame_Header.Height~~.		For example, a line might read:
			07 00 00 09 53 00 9C
			This would be 9 pixels of transparent colour, colour 0x53 in the [[PAL\|pallette]], and then another 0x9C pixels of transparent.
			This format repeats until all the lines in the image have been accounted for.

	Second method:<br>		Second method:<br>
	The second method is ~~identical~~ to the ~~first method~~, ~~except only~~ colour ~~0 (transparent colour) is followed by~~ the ~~count of~~ pixels.		The second method is used when the flag data of the frame is exactly 0x02. In this format (which I suppose isn't really compression), there are the two bytes to indicate how many bytes in the line, then a byte for each colour of the pixels in that line.
	~~Therefore for any instance of~~ the ~~colour #0,~~ the ~~next byte will be the ammount of pixels (until 255) to write~~.		This format repeats until all the lines in the image have been accounted for.

	=== Practical Application ===		=== Practical Application ===

58.109.97.210 at 02:32, 17 June 2007

2007-06-17T02:32:14Z

← Older revision		Revision as of 04:32, 17 June 2007
Line 38:		Line 38:
	=== Frame Data ===		=== Frame Data ===
	The frame data is stored in one of two types, determined by the "flags" byte in the frame header.		The frame data is stored in one of two types, determined by the "flags" byte in the frame header.
	If the flag data have second bit clear, the frame data is stored as (FrameHeader.Height * FrameHeader.Width) bytes, each byte being an index of the		If the flag data have second bit clear, the frame data is stored as (FrameHeader.Height * FrameHeader.Width) bytes, each byte being an index of the [[PAL\|palette]]

	If the flag data second bit is set the data is stored using RLE compression. See below for more details.		If the flag data second bit is set the data is stored using RLE compression. See below for more details.

en>VK: VK

2007-06-16T20:46:11Z

← Older revision		Revision as of 22:46, 16 June 2007
Line 30:		Line 30:
	*Width[uint16] (Width of the frame. Note that X + Width < FileHeader.Width)		*Width[uint16] (Width of the frame. Note that X + Width < FileHeader.Width)
	*Height[uint16] (Height of the frame. Note that Y + Height < FileHeader.Height)		*Height[uint16] (Height of the frame. Note that Y + Height < FileHeader.Height)
	*Flags[~~uint32~~] Special flags. It can be any number		*Flags[uint8] Special flags. It can be any number
			*Align[3] 3 bytes align to dword
	*Color[uint32] Some color (Can be Transparent color)		*Color[uint32] Some color (Can be Transparent color)
	*Reserved2[uint32] (A bunch of zero. Unused by Westwood. That's a kind of space you can use to add... things like password for it).		*Reserved2[uint32] (A bunch of zero. Unused by Westwood. That's a kind of space you can use to add... things like password for it).

58.109.97.210 at 13:37, 16 June 2007

2007-06-16T13:37:22Z

← Older revision		Revision as of 15:37, 16 June 2007
Line 44:		Line 44:

	If FrameHeader.Flag have second bit set, compression is used.		If FrameHeader.Flag have second bit set, compression is used.
	if (info->flag & ~~0x1~~)		if (info->flag & 0x2)
	{		{
	// with compression code		// with compression code

en>VK: please stop to change data in this page to incorrect VK

2007-06-16T11:06:47Z

please stop to change data in this page to incorrect VK

← Older revision		Revision as of 13:06, 16 June 2007
Line 1:		Line 1:
	SHP (TS) files are used on Tiberian Sun ~~and~~ Red Alert 2 to make buildings, infantry, animations, cameos (sidebar icons), among many other things. They consists on images with several frames using 256 colours from an external palette. Several programs are able to create and edit them like OS SHP Builder, Will's SHP Editor, XCC Mixer, etc. Several modders use XCC Mixer to convert images made with 3rd party programs into this format, while others edit them straight with OS SHP Builder.<br>		SHP (TS) files are used on Tiberian Sun, FireStorm, Red Alert 2 and Yuri's Revenge to make buildings, infantry, animations, cameos (sidebar icons), among many other things. They consists on images with several frames using 256 colours from an external palette. Several programs are able to create and edit them like OS SHP Builder, Will's SHP Editor, XCC Mixer, etc. Several modders use XCC Mixer to convert images made with 3rd party programs into this format, while others edit them straight with OS SHP Builder.<br>

	Below, I'll explain the file format and how does it work, so future programmers may also be able to play with these files:<br>		Below, I'll explain the file format and how does it work, so future programmers may also be able to play with these files:<br>
Line 19:		Line 19:
	=== File Header ===		=== File Header ===
	The File Header is very simple and consists only of few variables (unsigned 2 bytes integers):<br>		The File Header is very simple and consists only of few variables (unsigned 2 bytes integers):<br>
	*~~Signature~~ (~~always #00000000~~)		*Reserved word (must be zero)
	*Width		*Width
	*Height		*Height
Line 30:		Line 30:
	*Width[uint16] (Width of the frame. Note that X + Width < FileHeader.Width)		*Width[uint16] (Width of the frame. Note that X + Width < FileHeader.Width)
	*Height[uint16] (Height of the frame. Note that Y + Height < FileHeader.Height)		*Height[uint16] (Height of the frame. Note that Y + Height < FileHeader.Height)
	*Flags[~~uint8~~] Special flags. It can be any number		*Flags[uint32] Special flags. It can be any number
	*Align[uint24] Unused
	*Color[uint32] Some color (Can be Transparent color)		*Color[uint32] Some color (Can be Transparent color)
	*Reserved2[uint32] (A bunch of zero. Unused by Westwood. That's a kind of space you can use to add... things like password for it).		*Reserved2[uint32] (A bunch of zero. Unused by Westwood. That's a kind of space you can use to add... things like password for it).
Line 37:		Line 36:

	=== Frame Data ===		=== Frame Data ===
	The frame data is stored in one of ~~three~~ types, determined by the "flags" byte in the frame header.		The frame data is stored in one of two types, determined by the "flags" byte in the frame header.
	If the flag data ~~is 0x01~~, the frame data is stored as (FrameHeader.Height * FrameHeader.Width) bytes, each byte being an index of the ~~[[PAL\|palette]].~~		If the flag data have second bit clear, the frame data is stored as (FrameHeader.Height * FrameHeader.Width) bytes, each byte being an index of the

	If the flag data is ~~0x02 or 0x03,~~ the data is stored using RLE compression. See below for more details.		If the flag data second bit is set the data is stored using RLE compression. See below for more details.

	=== Compression ===		=== Compression ===

	~~There are two methods of compression.~~ If FrameHeader.Flag ~~was 0x02~~, ~~the first method is used. If it was 0x03, then the second method~~ is used.		If FrameHeader.Flag have second bit set, compression is used.
			if (info->flag & 0x1)
	~~Both methods of~~ compression ~~are quite similar.~~		{
			// with compression code
			}
			else
			{
			// without compression code
			}

	First method:<br>		First method:<br>

58.109.97.210 at 07:53, 16 June 2007

2007-06-16T07:53:10Z

← Older revision		Revision as of 09:53, 16 June 2007
Line 36:		Line 36:
	*Offset[uint32] (Location, inside the file, of the frame data. Use this value with Seek to reach the frame data. If offset equal 0 it is NULL "frame"<br>		*Offset[uint32] (Location, inside the file, of the frame data. Use this value with Seek to reach the frame data. If offset equal 0 it is NULL "frame"<br>

	=== ~~Special flags~~ ===		=== Frame Data ===
	If ~~bit 2~~ is ~~set - use compression 3~~, ~~otherwise use~~ compression 1		The frame data is stored in one of three types, determined by the "flags" byte in the frame header.
	~~Example: (b - binary)~~		If the flag data is 0x01, the frame data is stored as (FrameHeader.Height * FrameHeader.Width) bytes, each byte being an index of the [[PAL\|palette]].

			If the flag data is 0x02 or 0x03, the data is stored using RLE compression. See below for more details.

			=== Compression ===

	~~0 = 0'''0'''0b~~		There are two methods of compression. If FrameHeader.Flag was 0x02, the first method is used. If it was 0x03, then the second method is used.
	~~1 = 0'''0'''1b~~
	~~2 = 0'''1'''0b~~
	~~3 = 0'''1'''1b~~
	~~4 = 1'''0'''0b~~

	~~=== Frame Data ===~~		Both methods of compression are quite similar.
	~~If the frame~~ compression ~~is 1, Frame data is composed of a (FrameHeader.Width * FrameHeader.Height) bytes, each byte being a colour of the palette. For Compression 3, you have to decompress it~~.~~<br>~~

	The ~~compression 3~~ is ~~quite easy to be understood~~. ~~The colour #0 repeats~~ many ~~times~~ in ~~a SHP file, since it's~~ the ~~background~~ (~~transparent) colour. Therefore~~ for ~~any instance of~~ the ~~colour #0~~, ~~the next byte will~~ be ~~the ammount~~ of ~~times (~~until ~~255~~) ~~that #0 repeats~~. ~~Another thing that must be considered on~~ the ~~compression 3~~ is ~~that the first 2 bytes~~ of ~~a line~~ are ~~not colours~~. ~~They indicate~~ the ~~size~~ (in bytes) ~~of the line~~.<br>		First method:<br>
			The first two bytes of the frame data indicate how many bytes are in the line (that is, how many bytes of the frame data represent a whole row of pixels). This count includes the two bytes that say how many bytes in the line (for example if the value was 8, there would be 6 bytes of pixel information until the next line).<br>
			After this, there is a byte indicating which index of the [[PAL]] file the colour is, then a byte indicating how many pixels of this colour are to be written. This format of 1 pixel for colour, 1 pixel for count continues until the next pixel row is reached (when you reach the number of bytes for this line). <br>
			This format then repeats for each line in Frame_Header.Height.

	The ~~compression 2 works similarly~~ to ~~compression 3~~, ~~but there~~ is ~~no special treatment~~ for colour #0.~~<br>~~		Second method:<br>
			The second method is identical to the first method, except only colour 0 (transparent colour) is followed by the count of pixels.
			Therefore for any instance of the colour #0, the next byte will be the ammount of pixels (until 255) to write.

	=== Practical Application ===		=== Practical Application ===

71.29.173.163 at 22:28, 1 November 2006

2006-11-01T22:28:56Z

← Older revision		Revision as of 00:28, 2 November 2006
Line 25:		Line 25:

	=== Frame Header ===		=== Frame Header ===
	Each Frame comes with a relevant ~~ammount~~ of data that will help to render it.		Each Frame comes with a relevant amount of data that will help to render it.
	*X[uint16] (Horizontal position of the 0,0)		*X[uint16] (Horizontal position of the 0,0)
	*Y[uint16] (Vertical position of the 0,0)		*Y[uint16] (Vertical position of the 0,0)
Line 53:		Line 53:
	The compression 2 works similarly to compression 3, but there is no special treatment for colour #0.<br>		The compression 2 works similarly to compression 3, but there is no special treatment for colour #0.<br>

	=== ~~Pratical Aplication~~ ===		=== Practical Application ===
	Both XCC Mixer and OS SHP Builder are open source programs that are able to load and save SHP files. XCC Mixer's source code is available at the CVS from XCCU project at SourceForge. It was written using C++ language. OS SHP Builder's source code, written in Delphi, is available with the program downloadable at Project Perfect Mod.<br>		Both XCC Mixer and OS SHP Builder are open source programs that are able to load and save SHP files. XCC Mixer's source code is available at the CVS from XCCU project at SourceForge. It was written using C++ language. OS SHP Builder's source code, written in Delphi, is available with the program downloadable at Project Perfect Mod.<br>