RCOXML Animations

Description

RCOXML animations are defined in the XML code embedded inside .rco files. See Resource Container (RCO) and RCOXML Coding

• External links
  • RCOXML animations basic ---> http://endlessparadigm.com/forum/showthread.php?tid=19501&pid=255053#pid255053
  • RCOXML animations cube sample ---> http://endlessparadigm.com/forum/showthread.php?tid=19501&pid=326948#pid326948

RCOXML contents PS3

RCOXML contents PS3 firmware 4.76 (122 .rco files)  · 

filename	name	VSMXFile	ImageTree	FontTree	TextTree	ModelTree	SoundTree	ObjectTree	AnimTree	Notes
ap_plugin.rco	ap_plugin	No	No	No	No	No	No	Yes	No
audioplayer_plugin.rco	sample	No	Yes (gim)	No	Yes	No	No	Yes	No
audioplayer_plugin_dummy.rco	sample	No	No	No	Yes	No	No	No	No
audioplayer_plugin_mini.rco	sample	No	No	No	Yes	No	No	Yes	No
audioplayer_plugin_util.rco	sample	No	No	No	Yes	No	No	Yes	No	Associated .sprx has a different name.
auth_plugin.rco	auth_plugin	No	Yes (gim)	No	Yes	No	No	Yes	No
autodownload_plugin.rco	autodownload_plugin	No	Yes (gim)	No	Yes	No	No	Yes	No
autoupdateconf_plugin.rco	autoupdateconff_plugin	No	Yes (gim)	No	Yes	No	No	Yes	No
avc2_game_plugin.rco	sample	No	No	No	Yes	No	No	No	No
avc2_game_video_plugin.rco	sample	No	Yes (gim)	No	No	No	No	Yes	No
avc2_text_plugin.rco	tcgui	No	Yes (gim)	No	Yes	No	No	Yes	No
avc_game_plugin.rco	sample	No	Yes (gim)	No	Yes	No	No	Yes	No	Associated .sprx has a different name.
avc_plugin.rco	sample	No	Yes (gim)	No	Yes	No	No	Yes	No
bdp_disccheck_plugin.rco	bdp_disccheck_plugin	No	No	No	Yes	No	No	Yes	No
bdp_plugin.rco	bdp_plugin	No	Yes (gim)	No	Yes	No	No	Yes	Yes
bdp_storage_plugin.rco	bdp_storage_plugin	No	No	No	Yes	No	No	Yes	No
campaign_plugin.rco	campaign_plugin	No	Yes (gim, png)	No	Yes	No	No	Yes	No
category_setting_plugin.rco	category_setting_plugin	No	Yes (gim)	No	Yes	No	No	No	No
checker_plugin.rco	checker	No	No	No	No	No	No	Yes	No	Associated .sprx has a different name.
closedcaption_config_plugin.rco	closedcaption_config_plugin	No	Yes (gim)	No	Yes	No	No	Yes	No
comboplay_plugin.rco	comboplay_plugin	No	Yes (gim)	No	Yes	No	No	Yes	No
custom_render_plugin.rco	custom_render_plugin	No	Yes (gim)	No	No	No	No	Yes	Yes
data_copy_plugin.rco	sample	No	No	No	Yes	No	No	Yes	No
deviceconf_plugin.rco	deviceconf_plugin	No	Yes (gim)	No	Yes	No	No	Yes	No
dlna_plugin.rco	dlna	No	Yes (gim)	No	Yes	No	No	Yes	No
download_plugin.rco	download	No	Yes (gim)	No	Yes	No	No	Yes	No
dtcpip_util.rco	dtcpip_util	No	No	No	Yes	No	No	Yes	No
edy_plugin.rco	edy_plugin	No	Yes (gim)	No	Yes	No	Yes	Yes	No
eula_cddb_plugin.rco	eula_cddb_plugin	No	Yes (gim)	No	Yes	No	No	Yes	No
eula_hcopy_plugin.rco	eula_hcopy	No	Yes (gim)	No	Yes	No	No	Yes	No
eula_net_plugin.rco	regcam_plugin	No	Yes (gim, png, jpg)	No	Yes	No	Yes	Yes	No
explore_category_friend.rco	explore_plugin	No	Yes (gim)	No	Yes	No	No	Yes	No
explore_category_game.rco	explore_plugin	No	Yes (gim)	No	Yes	No	No	Yes	No
explore_category_music.rco	explore_plugin	No	Yes (gim)	No	Yes	No	No	Yes	No
explore_category_network.rco	explore_plugin	No	Yes (gim)	No	Yes	No	No	Yes	No
explore_category_photo.rco	explore_plugin	No	Yes (gim)	No	Yes	No	No	Yes	No
explore_category_psn.rco	explore_plugin	No	Yes (gim)	No	Yes	No	No	Yes	No
explore_category_sysconf.rco	explore_plugin	No	Yes (gim)	No	Yes	No	No	Yes	No
explore_category_tv.rco	explore_plugin	No	Yes (gim)	No	Yes	No	No	Yes	No
explore_category_user.rco	explore_plugin	No	Yes (gim)	No	Yes	No	No	Yes	No
explore_category_video.rco	explore_plugin	No	Yes (gim)	No	Yes	No	No	Yes	No
explore_plugin_ft.rco	explore_plugin	No	Yes (gim)	No	Yes	No	No	Yes	No
explore_plugin_full.rco	explore_plugin	No	Yes (gim)	No	Yes	No	No	Yes	No	Associated .sprx has a different name.
explore_plugin_game.rco	explore_plugin	No	Yes (gim)	No	Yes	No	No	Yes	No
explore_plugin_np.rco	explore_plugin	No	Yes (gim)	No	Yes	No	No	Yes	No
filecopy_plugin.rco	sample	No	Yes (gim)	No	Yes	No	No	Yes	No
friendim_plugin.rco	friendim	No	Yes (gim)	No	Yes	No	No	Yes	Yes
friendim_plugin_game.rco	friendim	No	Yes (gim)	No	Yes	No	No	Yes	Yes	Associated .sprx has a different name.
friendml_plugin.rco	friendml_plugin	No	Yes (gim)	No	Yes	No	No	Yes	No
friendml_plugin_game.rco	friendml_plugin	No	Yes (gim)	No	Yes	No	No	Yes	No	Associated .sprx has a different name.
friendtrophy_plugin.rco	friendtrophy_plugin	No	Yes (gim)	No	Yes	No	No	Yes	No
friendtrophy_plugin_game.rco	friendtrophy_plugin	No	Yes (gim)	No	Yes	No	No	Yes	No	Associated .sprx has a different name.
game_ext_plugin.rco	game_ext_plugin	No	Yes (gim, png)	No	Yes	No	No	Yes	No
game_indicator_plugin.rco	user_info_plugin	No	Yes (gim)	No	No	No	No	Yes	No
game_plugin.rco	game_plugin	No	No	No	Yes	No	No	Yes	No	Associated .sprx has a different name.
gamedata_plugin.rco	gamedata_plugin	No	No	No	Yes	No	No	Yes	No
gamelib_plugin.rco	gamelib_plugin	No	Yes (gim)	No	No	No	No	Yes	Yes
gameupdate_plugin.rco	sample	No	No	No	Yes	No	No	Yes	No
hknw_plugin.rco	hknw_plugin	No	Yes (gim)	Yes	Yes	No	No	Yes	No
idle_plugin.rco	idle	No	No	No	No	No	No	Yes	No
impose_plugin.rco	impose_plugin	No	Yes (gim)	No	Yes	No	No	Yes	Yes	Associated .sprx has a different name.
ingame_manual_plugin.rco	ingame_manual	No	No	No	Yes	No	No	Yes	No
kensaku_plugin.rco	kensaku	No	Yes (gim)	No	Yes	No	No	Yes	No
msgdialog_plugin.rco	msgdialog_plugin	No	No	No	Yes	No	No	Yes	No	Associated .sprx has a different name.
mtpinitiator_plugin.rco	sample	No	Yes (gim)	No	Yes	No	No	Yes	No
musicbrowser_plugin.rco	sample	No	No	No	No	No	No	Yes	No
nas_plugin.rco	nas_plugin	No	Yes (gim)	No	Yes	No	No	Yes	No
netconf_plugin.rco	sample	No	Yes (gim)	No	Yes	No	No	Yes	No
newstore_effect.rco	skeleton_plugin	No	No	No	No	No	No	No	No	Empty file.
newstore_plugin.rco	newstore_plugin	No	Yes (gim, png, jpg)	No	Yes	No	No	Yes	No
np_eula_plugin.rco	npeula	No	Yes (gim)	No	Yes	No	No	Yes	No
np_matching_plugin.rco	np_matching_plugin	No	Yes (gim)	No	Yes	No	No	Yes	No
np_multisignin_plugin.rco	np_multisignin_plugin	No	Yes (gim)	No	Yes	No	No	Yes	No
np_sns_plugin.rco	npsns	No	Yes (gim)	No	Yes	No	No	Yes	No
np_trophy_ingame.rco	np_achiev	No	Yes (gim)	No	Yes	No	No	Yes	No
np_trophy_plugin.rco	np_achiev	No	Yes (gim)	No	Yes	No	No	Yes	No
npsignin_plugin.rco	npsignin_plugin	No	Yes (gim)	No	Yes	No	No	Yes	Yes
osk_plugin.rco	sample	No	Yes (gim)	No	No	No	Yes	Yes	No
oskfullkeypanel_plugin.rco	ime_osk_base_resouce	No	Yes (gim)	No	Yes	No	No	Yes	No
oskpanel_plugin.rco	ime_osk_base_resouce	No	Yes (gim)	No	Yes	No	No	Yes	No
pesm_plugin.rco	pesm	No	No	No	No	No	No	Yes	No
photo_network_sharing_plugin.rco	pesm	No	Yes (gim)	No	Yes	No	No	Yes	No
photolist_plugin.rco	sample	No	No	No	No	No	No	Yes	No
photoupload_plugin.rco	dlna	No	Yes (gim)	No	Yes	No	No	Yes	No
photoviewer_plugin.rco	photoviewer_plugin	No	Yes (gim, png)	No	Yes	No	No	Yes	No
playlist_plugin.rco	sample	No	Yes (gim)	No	Yes	No	No	Yes	No
podl_plugin.rco	podl_plugin	No	No	No	No	No	No	Yes	No
poweroff_plugin.rco	poweroff	No	No	No	Yes	No	No	Yes	No
premo_plugin.rco	premo_plugin	No	Yes (gim)	No	Yes	No	No	Yes	Yes
print_plugin.rco	print_plugin	No	Yes (gim)	No	Yes	No	No	Yes	No
profile_plugin.rco	profile_plugin	No	Yes (gim)	No	Yes	No	No	Yes	No
profile_plugin_mini.rco	profile_plugin_mini	No	Yes (gim)	No	Yes	No	No	Yes	No	Associated .sprx has a different name.
ps3_savedata_plugin.rco	sample	No	Yes (gim)	No	Yes	No	No	Yes	No
ps3_savedata_plugin_game_mini.rco	sample	No	No	No	Yes	No	No	Yes	No
rec_plugin.rco	rec_plugin	No	No	No	No	No	No	Yes	No
regcam_plugin.rco	regcam_plugin	No	Yes (gim, png, jpg)	No	Yes	No	Yes	Yes	No
remotedownload_plugin.rco	remotedownload	No	No	No	Yes	No	No	Yes	No
sacd_plugin.rco	sample	No	Yes (gim)	No	Yes	No	No	Yes	Yes
scenefolder_plugin.rco	sample	No	No	No	No	No	No	Yes	No
screenshot_plugin.rco	screenshot_plugin	No	No	No	Yes	No	No	Yes	No
search_service.rco	search_service	No	No	No	Yes	No	No	No	No	Associated .sprx has a different name.
software_update_plugin.rco	software_update_plugin	No	Yes (gim)	No	Yes	No	No	Yes	No
soundvisualizer_plugin.rco	soundvisualizer	No	Yes (gim)	No	Yes	No	No	Yes	No
strviewer_plugin.rco	strviewer	No	No	No	Yes	No	No	Yes	No
subdisplay_plugin.rco	ap_plugin	No	No	No	No	No	No	Yes	No	Associated .sprx has a different name.
sv_pseudoaudioplayer_plugin.rco	sv_pseudoaudioplayer	No	Yes (gim)	No	Yes	No	No	Yes	No	Associated .sprx has a different name.
sysconf_plugin.rco	sysconf_plugin	No	Yes (gim)	Yes	Yes	No	No	Yes	No
system_plugin.rco	system_plugin	No	Yes (gim)	No	Yes	No	Yes	Yes	Yes	Associated .sprx has a different name.
thumthum_plugin.rco	sample	No	No	No	Yes	No	No	Yes	No
upload_util.rco	upload_util	No	Yes (gim)	No	Yes	No	No	Yes	No
user_info_plugin.rco	user_info_plugin	No	No	No	Yes	No	No	Yes	No
user_plugin.rco	user	No	Yes (gim)	No	Yes	No	No	Yes	No
videoeditor_plugin.rco	skeleton_plugin	No	Yes (gim, png, jpg)	No	Yes	No	Yes	Yes	No
videoplayer_plugin.rco	videoplayer	No	Yes (gim)	No	Yes	No	No	Yes	No
videoplayer_util.rco	videoplayer	No	No	No	Yes	No	No	Yes	No
vmc_savedata_plugin.rco	sample	No	Yes (gim)	No	Yes	No	No	Yes	No
wboard_plugin.rco	sample	No	Yes (gim)	No	Yes	No	No	Yes	No
webbrowser_plugin.rco	sample	No	Yes (gim)	No	Yes	No	No	Yes	No
webrender_plugin.rco	sample	No	Yes (gim)	No	Yes	No	No	Yes	No
xmb_ingame.rco	xmb_plugin	No	Yes (gim)	No	Yes	No	No	Yes	No
xmb_plugin_normal.rco	xmb_plugin	No	Yes (gim)	No	Yes	No	No	Yes	No	Associated .sprx has a different name.
ycon_manual_plugin.rco	ycon_plugin	No	Yes (gim)	No	Yes	No	No	Yes	No

General concepts

Delays and execution timeline

RCOXML animations delays ---> http://endlessparadigm.com/forum/showthread.php?tid=19501&pid=262236#pid262236

Standard attributes

RCO TOC Animations standard attributes

Offset	Length	Data type	Name			Example (TOC)	Example (XML)	Notes
0x28	0x08	ref	object	Yes	Yes	04 09 / 00 00 / 12 34 56 78	<Element object="object:label"/>	links the animation to an object (ref_type[2], padding[2], label_string_table_offset[4])
0x30	0x04	float	time	Yes	Yes	44 7A 00 00	<Element time="1000"/>
0x34	0x04	int	accelMode	Yes	Yes	00 00 00 03	<Element accelMode="0x3"/>

• accelMode. Used to accelerate or decelerate an animation effect, used by most of the animations, posible values are:
  • 0x0 - no accelaration
  • 0x1 - starts fast, ends slow
  • 0x2 -
  • 0x3 -
  • 0x4 - starts slow, ends fast

Measure units and conversions

Measure units used in RCOXML code

• XYZ Position, in pixels
• RGBA Color Scale in percentage in a scale from 0 up to 1, where 1 represents the max value posible of 255 (decimal value divided by 255 to get into this scale)
• XYZ Size, in pixels, negative numbers mirrors the image
• XYZ Size Scale, in percentage in a scale from 0 up to 1, negative numbers mirrors the image
• Time, in miliseconds, where 1000 is one second
• XYZ Angle, in radians with right-handed rule coordinates, where radians=(π*degrees)/180, and degrees=(180*radians)/π, as example for one turn of 360º degrees: radians=(3.141*360)/180=6.283 ...so... 360º degrees = 6.283 radians

RCOXML Animations example

Code Sample

RCO TOC entry types

RCO TOC entry types

		Second byte
		0x00	0x01	0x02	0x03	0x04	0x05	0x06	0x07	0x08	0x09	0x0A	0x0B	0x0C	0x0D	0x0E	0x0F	0x10	0x11	0x12	0x13	0x14	0x15	0x16	0x17	0x18	0x19	0x1A	0x1B	0x1C	0x1D	0x1E	0x1F
First byte	0x01	unk	MainTree
	0x02	ScriptTree
	0x03	TextTree	Text
	0x04	ImageTree	Image
	0x05	ModelTree	Model
	0x06	SoundTree	Sound
	0x07	FontTree	Font
	0x08	ObjectTree	Page	Plane	Button	XMenu	XMList	XList	Progress	Scroll	MList	MItem	unk	XItem	Text	ModelObject	Spin	Action	ItemSpin	Group	LList	LItem	Edit	Clock	IList	IItem	Icon	UButton	unk	CheckboxGroup	CheckboxItem	Meter	EditBox
	0x09	AnimTree	Anim	MoveTo	Recolour	Rotate	Resize	Fade	Delay	FireEvent	Lock	Unlock	SlideOut
		Supported by and																											Supported by only

• The entry_types with the suffix Tree (as example MainTree) are special and doesnt uses attributes, MainTree is always located as the first entry, doesn't have a parent, and doesn't have any previous or next "sibling", the maximun number posible of childrens for MainTree is 8 (containing all the other "trees"). The other "trees" (as example imageTree or soundTree) are siblings and are the childrens of "MainTree", Every one of those "trees" contains a variable number of entry_types that are its childrens
• The attributes of the RCOXML Objects (entry_types starting with 0x08) and RCOXML Animations (entry_types starting with 0x09) can be grouped in standard attributes (used by most entryes of this type) and specific attributes (different for every entry_type). The standard attributes are always located before the specific attributes
• First two bytes are swapped based on architecture (PSP in little endian, PS3 in big endian). The table shows the values in big endian

(0x09 0x00) AnimTree

(0x09 0x01) Animation

The AnimTree can have one or more Animation childrens, and every Animation can have a list of the childrens listed below

(0x09 0x02) MoveTo

Attribute					How it works
Name	Type			Examples
object	ref	Yes	Yes	object:ps3logo	links the animation to an object
duration	float	Yes	Yes	1000
accelMode	int	Yes	Yes	0x0
x	float	Yes	Yes		updates the value of attribute PositionX from the animated object
y	float	Yes	Yes		updates the value of attribute PositionY from the animated object
z	float	Yes	Yes		updates the value of attribute PositionZ from the animated object
unknownInt5	int	No	Yes		either updates SizeX, or is an override ?
unknownInt6	int	No	Yes		either updates SizeY, or is an override ?
unknown7	unk	No	Yes		either updates SizeZ, or is an override ?

(0x09 0x03) Recolour

Attribute					How it works
Name	Type			Examples
object	ref	Yes	Yes	object:ps3logo	links the animation to an object
duration	float	Yes	Yes	1000
accelMode	int	Yes	Yes	0x0
red	float	Yes	Yes		updates the value of attribute ColorScaleR from the animated object
green	float	Yes	Yes		updates the value of attribute ColorScaleG from the animated object
blue	float	Yes	Yes		updates the value of attribute ColorScaleB from the animated object
alpha	float	Yes	Yes		updates the value of attribute ColorScaleA from the animated object

(0x09 0x04) Rotate

Attribute					How it works
Name	Type			Examples
object	ref	Yes	Yes	object:ps3logo	links the animation to an object
duration	float	Yes	Yes	1000
accelMode	int	Yes	Yes	0x0
x	float	Yes	Yes
y	float	Yes	Yes
z	float	Yes	Yes

(0x09 0x05) Resize

Attribute					How it works
Name	Type			Examples
object	ref	Yes	Yes	object:ps3logo	links the animation to an object
duration	float	Yes	Yes	1000
accelMode	int	Yes	Yes	0x0
width	float	Yes	Yes		updates the value of attribute SizeScaleX from the animated object
height	float	Yes	Yes		updates the value of attribute SizeScaleY from the animated object
depth	float	Yes	Yes		updates the value of attribute SizeScaleZ from the animated object

(0x09 0x06) Fade

Attribute					How it works
Name	Type			Examples
object	ref	Yes	Yes	object:ps3logo	links the animation to an object
duration	float	Yes	Yes	1000
accelMode	int	Yes	Yes	0x0
transparency	float	Yes	Yes		updates the value of attribute ColorScaleA from the animated object

(0x09 0x07) Delay

Attribute					How it works
Name	Type			Examples
time	float	Yes	Yes

(0x09 0x08) FireEvent

Triggers (or "fires") an event, there are different types of events (see RCOXML Coding). The most used inside animations are "native events" and "animation events" itself

By triggering an animation event from inside an animation... both animations are played consecutivelly. Also is posible to reload the animation by triggering itself to create an infinite animation loop

Attribute					How it works
Name	Type			Examples
event	ref	Yes	Yes

(0x09 0x09) Lock

Disables XMB. Note in Talk:Custom_render_plugin how anim_coldboot, anim_coldboot2, anim_gameboot, and anim_otherboot animations starts by locking the XMB to dont interfere

• In latest firmwares (where is used coldboot.raf animation) if XMB is not locked + having a dynamic theme applyed the PS3 crashes. Is because inside dynamic themes the background is a .raf animation. Is not posible to play 2 .raf animations together overlapped (from coldboot.raf and from inside a dynamic theme)

Attribute					How it works
Name	Type			Examples
unknownInt0	int	Yes	Yes

(0x09 0x0A) Unlock

Enables XMB. Note in Talk:Custom_render_plugin how anim_gameboot, and anim_otherboot animations doesnt unlocks XMB at the ending because when the animation is completed a game/app boots (doesnt returns to XMB)

Attribute					How it works
Name	Type			Examples
unknownInt0	int	Yes	Yes

(0x09 0x0B) SlideOut

Attribute					How it works
Name	Type			Examples
object	ref	Yes	Yes	object:ps3logo	links the animation to an object
duration	float	Yes	Yes	1000
accelMode	int	Yes	Yes	0x0
xspeed	float	Yes	Yes
yspeed	float	Yes	Yes
xcompress	float	Yes	Yes
ycompress	float	Yes	Yes

example