XMBML Coding: Difference between revisions

From PS3 Developer wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
 
(123 intermediate revisions by 5 users not shown)
Line 1: Line 1:
This page will outline the logic behind XMB .xml configuration files.  
== Basic XMBML Structure ==
This page outlines the logic behind [[XMB]] XML configuration files. For some practise usage see: [[XMBML Coding Examples]]


This is a reduced version of [[XMB-Network | category_network.xml]] with only one icon (tex_browser) that launches the webbrowser (type:x-xmb/xmlwebbrowser). The .xml is loaded starting from <View id="root">, then inside the <Items> table there is a <Query> linking to #seg_browser (the character "#" links to a <View id> in the same file, so is linked to <View id="seg_browser">). When <View id="seg_browser"> is loaded first starts reading the table of <Items> that contains an <Item> that is linked using attr="browser" to a table of attributes <Table key="browser"


== Basic Structure ==
{{Boxcode|code=<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>


Every XMB .xml configuration file starts with this header:
<XMBML version="1.0">
<View id="root">
<Items>
<Query class="type:x-xmb/folder-pixmap" key="seg_browser" src="#seg_browser"/>
</Items>
</View>
<View id="seg_browser">
<Attributes>
<Table key="browser">
<Pair key="icon_rsc"><String>tex_browser</String></Pair>
<Pair key="icon_notation"><String>WNT_XmbItemBrowser</String></Pair>
<Pair key="title_rsc"><String>msg_browser</String></Pair>
</Table>
</Attributes>
<Items>
<Item class="type:x-xmb/xmlwebbrowser" key="browser" attr="browser"/>
</Items>
</View>
</XMBML>
</syntaxhighlight>}}


<pre><?xml version="1.0" encoding="UTF-8"?>
*The contents of the .xml file can be identifyed by the &lt;View id&gt; and &lt;key&gt; this way:
<XMBML version="1.0"></pre>
**&lt;View id="root"&gt; contains 1 &lt;Items&gt; with the key="seg_browser"
**&lt;View id="seg_browser"&gt; contains 1 &lt;Items&gt; with the key="browser"


And has at least one 'entry' which follows this format:
{{Boxcode|code=<syntaxhighlight lang="xml">
 
<View id="root">
<pre> <View id="Entry_1">
<Items>
<Query key="seg_browser"/>
</Items>
</View>
<View id="seg_browser">
<Attributes>
<Attributes>
<Table key="item_1">
<Table key="browser">
<Pair key="pair_key1"><String>a valid entry for this pair key</String></Pair>
</Table>
<Pair key="pair_key2"><String>a valid entry for this pair key</String></Pair>
<Pair key="pair_key3"><String>a valid entry for this pair key</String></Pair>
<Pair key="pair_key4"><String>a valid entry for this pair key</String></Pair>
</Table>
</Attributes>
</Attributes>
<Items>
<Items>
<Query class="item_1_class" key="item_1" attr="item_1" src="#Entry_1_contents" />
<Item key="browser"/>
</Items>
</Items>
</View></pre>
</View>
</syntaxhighlight>}}
*Note the "Pair key"'s inside "attributes tables" are not considered identifyers of the xml tag


<View id=""> - this is so the entry can be identified from within the .xml by the PS3. The id must consist of UTF-8 characters and have no spaces. There must be no other entries with the same View id.
=== View ID's (Enviroment ID's, and Segment ID's) ===
Identifyers made of UTF-8 characters and without spaces. There are two types: Enviroments, and Segments


Within a entry there are two sub groups "<Attributes>" and "<Items>".
*'''Enviroments''' are reserved names (hardcoded in VSH?): '''"root", "root_info", "root_for_dex", "root_dex", "root_for_BDU", "root_power_only", "root_hide_friend", "tool_root", "shop_root", "shop_guest_root", "shop_staff_root", "root_arcade"''' and obsolete: '''"stage_demo_root", "xai_test_root", "store_root"'''
**Used to load specific XMB items for different PS3 types (retail, debug, etc...), or to load items in specific boot modes (e.g: in shop PS3's "locked" or "unlocked" modes), can be considered the [[XMB]] enviroments used by the [[XMB#XMB_Configuration_Files|XMB Configuration Files]]
**Usually inside the .XML files there are several '''&lt;View id&gt;''' of this type starting with '''"root"''' (retail XMB) at the top, only one of them is loaded by [[VSH]] when the PS3 boots


<Items> - the contents of this sub group dictates what exists on the XMB when this entry is used. There can be more than one entry.
*'''Segments''' are all the others with names starting with '''"seg_"''' (e.g: '''seg_'''gamedata, '''seg_'''gameexit, '''seg'''_manual, etc...). There must be no other segments with the same name in the same .XML file, but some segments used for common functions are repeated in different .XML files and uses the same segment name and key identifyer (e.g. the segment "seg_gameexit" containing an item with the key "gamexit" is repeated in 8 .XML files)
**Segments are loaded by some '''query classes''' (inside '''&lt;items&gt;''' tables)  by making his '''"src"''' to point to the target segment. When the segment is in the same .XML file it works simply by "jumping" to another line of the same file. When the segment is in another .XML file first is needed to locate the target .XML file, and then the "jump" to the target segment
***Links to a segment in the same .XML file uses the character "'''#'''", and the name of the target segment (e.g: '''src="#seg_poweroff"''')
***Links to a segment in another .XML file uses the '''xmb://localhost/''' function with the path of the target file, the character "'''#'''", and the name of the target segment (e.g: '''src="xmb://localhost/dev_flash/vsh/resource/explore/xmb/category_user.xml#seg_poweroff"'''), or alternativelly the short path form replacing '''"dev_flash/vsh/resource/explore/"''' by '''"%flash/"''' (e.g: '''src="xmb://localhost/%flash/xmb/category_user.xml#seg_poweroff"''')
**Is posible to load the "root" view IDs of other file (e.g: '''src="xmb://localhost/%flash/xmb/category_user.xml#root"''')


<Attributes> - this provides additional information about the <Items> sub-entries. For each <Items> sub-entry there '''can'''(not all <Items> sub-entries requires attributes) be attributes assigned, each in its own table with an 'key' matching the <Items> sub-entry. The number of attribute sub-entries within a table varies depending on the <Items> sub-entry.
=== Items (Query classes, and Item classes) ===
The contents of this sub group dictates what exists on the XMB when this entry is used. There can be more than one.


When creating a XMB entry, you must tell vsh.self and its modules what you want to do. And the first part of a &lt;Items&gt; sub-entry does just this by telling the PS3 the "class" of the entry in the form of either  "''&lt;Item class=""''" or "''&lt;Query class=""''" (in the case of "''&lt;Query class=""''" can be used several times under the same &lt;items&gt; to perform group of actions). There are many acceptable values possible, here are some examples:


== Creating XMB .xml Entries ==
{| class="wikitable"
 
|+Tags used by class/subclass
 
! Query classes x-xmb !! <key> !! <attr> !! <src> !! Remarks
=== <Items> sub-entries ===
|-
 
| <Query class="type:x-xmb/'''category'''" || {{Yes}} || {{Yes}} || {{Yes}} || Main/Root XMB
When creating an XMB entries, you must tell the PS3 vsh.self and its modules what you want to do. And the first part of a <Items> sub-entry does just this by telling the PS3 what kind of entry this XMB entry is in the form of either "''<Query class=""''" or "''<Item class=""''". There are many acceptable values possible here but only 3 have more than one theoretical use:
|-
 
| <Query class="type:x-xmb/'''folder-pixmap'''" || {{Yes}} || {{Yes}} || {{Yes}} || Has many uses see [[XMBML Functions|here]]
* <Query class="type:x-xmb/folder-pixmap"
|-
* <Item class="type:x-xmb/module-action"
| <Query class="type:x-xmb/'''xmlmcutility'''" || {{Yes}} || {{Yes}} || {{Yes}} || PS1 and PS2 virtual memory card utility
* <Query class="type:x-xmb/xmlpackagefolder"
|-
 
| <Query class="type:x-xmb/'''xmlnpsignup'''" || {{Yes}} || {{Yes}} || {{No}} ||
A table of the above types of <Items> sub-entries and what sections of a <Items> sub-entry they can/must use:
|-
{| class="wikitable sortable"
| <Query class="type:x-xmb/'''xmlpackagefolder'''" || {{Yes}} || {{Yes}} || {{Yes}} || Used for installing package files
|-
| <Query class="type:x-xmb/'''xmlpsp2appdata'''" || {{Yes}} || {{Yes}} || {{No}} || PSVita application utility
|-
| <Query class="type:x-xmb/'''xmlsavedata-plus'''" || {{Yes}} || {{Yes}} || {{No}} || Online storage
|-
| <Query class="type:x-xmb/'''xmlsavedata-ps2'''" || {{Yes}} || {{Yes}} || {{No}} || Savedata utility PS2
|-
| <Query class="type:x-xmb/'''xmlsavedata-ps3'''" || {{Yes}} || {{Yes}} || {{No}} || Savedata utility PS3
|-
| <Query class="type:x-xmb/'''xmlsavedata-psp'''" || {{Yes}} || {{Yes}} || {{No}} || Savedata utility PSP
|-
! Query classes x-xcb !! <key> !! <attr> !! <src> !! Remarks
|-
| <Query class="type:x-xcb/'''game-debug'''" || {{Yes}} || {{Yes}} || {{No}} || /app_home/PS3_GAME/ link
|-
| <Query class="type:x-xcb/'''savedata-ps3'''" || {{Yes}} || {{Yes}} || {{No}} || PS3 new savedata
|-
| <Query class="type:x-xcb/'''savedata-psp'''" || {{Yes}} || {{Yes}} || {{No}} || PSP new savedata
|-
! Item classes x-xmb !! <key> !! <attr> !! <src> !! Remarks
|-
| <Item class="type:x-xmb/'''module-action'''" || {{Yes}} || {{Yes}} || {{No}} || Uses a particular module to support the XMB item. See [[XMBML module-action]] page
|-
| <Item class="type:x-xmb/'''vmc-new'''" || {{Yes}} || {{Yes}} || {{No}} ||
|-
| <Item class="type:x-xmb/'''xmlbddatamgmt'''" || {{Yes}} || {{Yes}} || {{No}} ||
|-
| <Item class="type:x-xmb/'''xmleditingvideo'''" || {{Yes}} || {{Yes}} || {{No}} ||
|-
| <Item class="type:x-xmb/'''xmlflashplayer'''" || {{Yes}} || {{Yes}} || {{No}} ||
|-
| <Item class="type:x-xmb/'''xmlgameexit'''" || {{Yes}} || {{No}} || {{No}} ||
|-
| <Item class="type:x-xmb/'''xmlhakoniwa'''" || {{Yes}} || {{Yes}} || {{No}} ||
|-
| <Item class="type:x-xmb/'''xmliboard'''" || {{Yes}} || {{Yes}} || {{No}} || [[Widgets]] control (class not used over firmware 3.00)
|-
| <Item class="type:x-xmb/'''xmlmessagelist'''" || {{Yes}} || {{Yes}} || {{No}} ||
|-
| <Item class="type:x-xmb/'''xmlnowplaying'''" || {{Yes}} || {{Yes}} || {{No}} ||
|-
| <Item class="type:x-xmb/'''xmlnpsignup'''" || {{Yes}} || {{Yes}} || {{No}} ||
|-
| <Item class="type:x-xmb/'''xmlplaylist'''" || {{Yes}} || {{Yes}} || {{No}} ||
|-
| <Item class="type:x-xmb/'''xmlplus'''" || {{Yes}} || {{No}} || {{No}} ||
|-
| <Item class="type:x-xmb/'''xmlpoweroff'''" || {{Yes}} || {{No}} || {{No}} ||
|-
| <Item class="type:x-xmb/'''xmlpremo'''" || {{Yes}} || {{No}} || {{No}} ||
|-
| <Item class="type:x-xmb/'''xmlpsp2appdata-cont'''" || {{Yes}} || {{Yes}} || {{No}} || PSVita Applications (PSVita, PSP, PS1, PSMobile)
|-
| <Item class="type:x-xmb/'''xmlscreenshot'''" || {{Yes}} || {{No}} || {{No}} ||
|-
| <Item class="type:x-xmb/'''xmlsysconf'''" || {{Yes}} || {{Yes}} || {{No}} ||
|-
| <Item class="type:x-xmb/'''xmltrophy'''" || {{Yes}} || {{Yes}} || {{No}} ||
|-
|-
! Entry Identification !! "''key=""''" required ? !! "''attr=""''" required ? !! "''src=""''" required ? !! Attributes Required ? !! Remarks
| <Item class="type:x-xmb/'''xmlwebbrowser'''" || {{Yes}} || {{Yes}} || {{No}} ||
|-
|-
| <Query class="type:x-xmb/folder-pixmap" || Yes || Opt || Yes || Opt || Has many uses see [[XMB modding|here]]
| <Item class="type:x-xmb/'''xmlwelcome'''" || {{Yes}} || {{Yes}} || {{No}} ||  
|-
|-
| <Item class="type:x-xmb/module-action" || Yes || Yes || No || Yes || Uses a particular module to support the XMB item, see the [[XMB XML Coding#Module-Action|Module-Action list]]
! Item classes x-chat !! <key> !! <attr> !! <src> !! Remarks
|-
|-
| <Query class="type:x-xmb/xmlpackagefolder" || Yes || Opt || Yes || Yes || Used for installing package files
| <Item class="type:x-chat/'''xmlchatroom-manager'''" || {{Yes}} || {{Yes}} || {{No}} ||  
|-
|-
|}
|}


A table explaining the possible 'sections' to <Items> sub-entries and some acceptable uses of such:
<div style="height:200px; overflow:auto">
{| class="wikitable sortable"
{| class="wikitable"
|+Unknown usage
! Unknown classes !! <key> !! <attr> !! <src> !! Remarks
|-
| x-xcb/'''achbase''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''achievtitle''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''achievgroup''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''achievflag''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''friendachievtitle''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''friendachievgroup''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''friendachievflag''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''blockedplayer''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''directory''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''directory-bddata''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''directory-generic''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''directory-photo''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''directory-music''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''directory-video''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''unknown''' || ? || ? || ? || found inside explore_category_game.sprx
|-
| x-xcb/'''message''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''person''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''playedplayer''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''psv''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''savedata-ps1''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''savedata-ps2''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''savedata-ps3delegate''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''savedata-plus''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''savedata-pspdir''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''segment''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''storage-media''' || ? || ? || ? || found inside explore_category_game.sprx
|-
| x-xcb/'''storagemedia-cdda''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''storagemedia-sacd''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''storagemedia-psmc''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''storagemedia-psv''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''storagemedia-sdps3''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''storagemedia-sdpsp''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''storagemedia-sdpsp2''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''storagemedia-dlna''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''storagemedia-avchd''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''storagemedia-bdc''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''storagemedia-generic''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''storagemedia-videodisc''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''game-disc''' || ? || ? || ? || found inside explore_category_game.sprx
|-
| x-xcb/'''game''' || ? || ? || ? || found inside explore_category_game.sprx
|-
| x-xcb/'''game-list''' || ? || ? || ? || found inside explore_category_game.sprx
|-
| x-xcb/'''content-disc''' || ? || ? || ? || found inside explore_category_game.sprx
|-
| x-xcb/'''music''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''music-list''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''photo''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''photo-list''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''query-condition''' || ? || ? || ? || found inside explore_category_game.sprx
|-
| x-xcb/'''video''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''video-content''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''video-list''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''video-file''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''video-disctitle''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''vmc''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''vmc-new''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xmb/'''xmlchannel''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xmb/'''xmlpsp2appdata-cont''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xmb/'''xmlscenefolder''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xmb/'''xmlvideodownloader''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xmb/'''unknown''' || ? || ? || ? || found inside explore_category_game.sprx
|-
| x-xil/'''xilitem''' || ? || ? || ? || found inside explore_category_game.sprx
|-
| x-ese/'''task''' || ? || ? || ? || found inside explore_category_game.sprx
|-
|-
! <Items> sub-entry 'section' !! Use !! Example(s) !! Remarks
| x-ese/'''dlctl''' || ? || ? || ? || found inside explore_plugin.sprx
|-
|-
| key || Used to identify the sub-entry which can also be used link attributes(see below) || "gamedata" || -
| x-sel/'''registory-accessor''' || ? || ? || ? || found inside explore_category_game.sprx
|-
|-
| attr || ? || "gamedata" || generally the same value as 'key'
| x-user/'''user''' || ? || ? || ? || found inside explore_plugin.sprx
|-
|-
| src || Used to link to other xml files or utilise a XMB database functions (see [[XMB database]]) || * Refer to another XMB entry inside the current xml file :"#seg_package_files".<br /> * Refer to another XMB entry inside another xml file :"xmb://localhost/dev_flash/vsh/resource/explore/xmb/category_game_tool2.xml#seg_package_files".<br /> * Utilise a XMB database function:"xcb://localhost/query?sort=+Game:Common.titleForSort&cond=AGL+Game:Game.titleId BC0000000 BCZZZZZZZ+OGL+Game:Game.titleId BL0000000 BLZZZZZZZ+OGL+Game:Game.titleId NP0000000 NPZZZZZZZ+OGL+Game:Game.titleId SC0000000 SCZZZZZZZ+An+Game:Game.titleId BLES01337+An+Game:Game.titleId BLES80608+An+Game:Game.titleId BLES80610+An+Game:Game.titleId BLES80611+An+Game:Game.titleId BLES80607+An+Game:Game.titleId NPXS00006+An+Game:Game.titleId BLES01059+An+Game:Game.category 2D+An+Game:Game.category BV+An+Game:Game.category GD+An+Game:Game.category HM+An+Game:Game.category SD+An+Game:Game.category VF+An+Game:Game.category WT" || XMB database function was taken from the XMBM+.
| x-host/'''unknown''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-host/'''mount-info''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-host/'''directory''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-host/'''file''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-host/'''package''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-host/'''theme-content''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-host/'''ps2_newsavedata''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-chat/'''room''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-chat/'''player''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-chat/'''xmlchatroom-manager''' || ? || ? || ? || found inside explore_plugin.sprx
|-
|-
|}
|}
</div>


*'''&lt;key&gt;'''
**Used to identify the sub-entry inside '''&lt;Items&gt;''' tables (usually the same value as '''&lt;attr&gt;''' and the '''&lt;Table key&gt;''' associated if present)
**Example: '''key="my_icon"'''


*'''&lt;attr&gt;'''
**Used to link &lt;Items&gt; to a table of attributes with the same name '''&lt;Table key&gt;''' inside '''&lt;Attributes&gt;'''
**Example: '''attr="my_icon_metadata"'''


*'''&lt;src&gt;'''
**Used to link to other xml files or utilise a XMB database functions (see [[XMB database]])
**Refer to another XMB entry inside the current xml file. Example: '''src="#seg_package_files"'''
**Refer to another XMB entry inside another xml file. Example: '''src="xmb://localhost/dev_flash/vsh/resource/explore/xmb/category_game_tool2.xml#seg_package_files"'''
**Use a XMB database function. Example: '''src="xcb://localhost/query?table=MMS_MEDIA_TYPE_SYSTEM&genre=Music&sort=+StorageMedia:Common.titleForSort&cond=Ae+StorageMedia:StorageMedia.type %xCB_MEDIA_TYPE_DLNA"'''


=== <Attributes> ===
=== Attributes (Pairs) ===
This provides additional information about '''&lt;Items&gt;''' sub-entries by linking them to a table with attributes associated (is optionall, not all &lt;Items&gt; requires attributes), this tables uses a '''&lt;Table key&gt;''' matching the '''&lt;attr&gt;''' sub-entry asociated and contains one or more attributes separated in lines starting with '''&lt;Pair key&gt;'''.


A table of usable attributes and what <Items> sub-entries they '''can''' be used with:
{| class="wikitable" style="font-size:x-small;"
{| class="wikitable sortable"
|+Attributes used in official XMB, ordered by classes
! &lt;Attributes&gt; !! colspan="28" | &lt;Items&gt; !! rowspan="4" | Examples
|-
! &lt;Table !! colspan="12" | &lt;Query class="type: !! colspan="16" | &lt;Item class="type:
|-
! rowspan="2" | &lt;Pair key= !! colspan="9" | x-xmb/ !! colspan="3" | x-xcb/ !! colspan="15" | x-xmb/ !! x-chat/
|-
! <abbr title="folder-pixmap">folder<BR />pixmap</abbr> !! <abbr title="xmlmcutility">mc<BR />utility</abbr> !! <abbr title="xmlnpsignup">np<BR />signup</abbr> !! <abbr title="xmlpackagefolder">pkg<BR />folder</abbr> !! <abbr title="xmlpsp2appdata">vita<BR />apps</abbr> !! <abbr title="xmlsavedata-plus">save<BR />plus</abbr> !! <abbr title="xmlsavedata-ps2">save<BR />ps2</abbr> !! <abbr title="xmlsavedata-ps3">save<BR />ps3</abbr> !! <abbr title="xmlsavedata-psp">save<BR />psp</abbr> !! <abbr title="game-debug">game<BR />debug</abbr> !! <abbr title="savedata-ps3">save<BR />ps3</abbr> !! <abbr title="savedata-psp">save<BR />psp</abbr> !! <abbr title="module-action">module<BR />action</abbr> !! <abbr title="vmc-new">vmc<BR />new</abbr> !! <abbr title="xmlbddatamgmt">bddata<BR />mgmt</abbr> !! <abbr title="xmleditingvideo">edit<BR />video</abbr> !! <abbr title="xmlhakoniwa">hako<BR />niwa</abbr> !! <abbr title="xmliboard">info<BR />board</abbr> !! <abbr title="xmlmessagelist">msg<BR />list</abbr> !! <abbr title="xmlnowplaying">now<BR />playing</abbr> !! <abbr title="xmlnpsignup">np<BR />signup</abbr> !! <abbr title="xmlplaylist">play<BR />list</abbr> !! <abbr title="xmlpsp2appdata-cont">vita<BR />apps</abbr> !! <abbr title="xmlsysconf">sys<BR />conf</abbr> !! <abbr title="xmltrophy">trophy</abbr> !! <abbr title="xmlwebbrowser">browser</abbr> !! <abbr title="xmlwelcome">welcome</abbr> !! <abbr title="xmlchatroom-manager">chat<BR />room</abbr>
|-
| action
| {{Yes}} || {{Yes}} || ? || ? || ? || ? || ? || {{Yes}} || {{Yes}}
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "exec_game", etc... (see table below)
|-
| bar_action
| {{No}} || ? || ? || {{No}} || ? || ? || ? || ? || ?
| ? || ? || ?
| {{Yes}} || ? || ? || ? || ? || ? || ? || {{Yes}} || ? || ? || ? || {{Yes}} || ? || ? || ?
| ?
| "none", "hide", "game_pspemu_viewmode", "game_pspemu_3d", "game_psemu_upcon", "game_psemu_smooth", "pad_assign", "pad_vibration", "bt_device_utility", "audio_setting", "voice_changer", "net_netlist"
|-
| connection
| ? || ? || ? || ? || ? || ? || ? || {{Yes}} || {{Yes}}
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "xcb://localhost/query?..."
|-
| cf_connection
| ? || ? || ? || ? || ? || ? || ? || {{Yes}} || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "xcb://localhost/query?..."
|-
| ch_pos
| {{Yes}} || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "1"
|-
| child
| {{Yes}} || ? || ? || {{Yes}} || ? || ? || ? || ? || ?
| ? || ? || ?
| {{No}} || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "segment", "grid", "Video"
|-
| content_id
| ? || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || {{Yes}} || ? || ? || ? || ? || ? || ?
| ?
| "IP9100-NPIA00002_00-0000111122223333"
|-
| content_info_pict
| ? || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "/dev_flash/vsh/resource/explore/icon/pstex01.png"
|-
| content_info_pict_sd
| ? || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "/dev_flash/vsh/resource/explore/icon/pstex-sd.png"
|-
|-
! Attribute !! Use !! Used by type:x-xmb/folder-pixmap !! Used by type:x-xmb/module-action !! Used by type:x-xmb/xmlpackagefolder !! Example(s)
| content_info_tex
| ? || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "msg_ps3_portal"
|-
|-
| icon_rsc || displays a .rco referable image as XMB icon. Cannot be used at the same time as 'icon'. || Yes || Yes || Yes || "tex_album_icon"
| content_info_title
| ? || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "msg_psstore_explanation_hd"
|-
|-
| icon || displays a .png image from an absolute path as XMB icon. Cannot be used at the same time as 'icon_rsc'. || Yes || Yes || Yes || "/dev_hdd0/game/XMBMANPLS/USRDIR/IMAGES/filemanager.png"
| content_info_title_sd
| ? || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "msg_psstore_explanation_sd"
|-
|-
| icon_notation || tells the XMB how to treat the icon (transparency etc.) by refering to the relevant .rco. Can in some cases override 'icon' or 'icon_rsc' || Yes || Yes || Yes || "WNT_XmbItemSavePS3"
| content_name
| ? || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || {{Yes}} || ? || ? || {{Yes}} || ? || ? || ? || ? || ? || ?
| ?
| "msg_title_lwp", "msg_information_board"  
|-
|-
| title_rsc || displays XMB main title text referred from relevant .rco. Cannot be used at the same time as 'title'. || Yes || Yes || Yes || "msg_tool_app_home_ps3_game"
| content_type
| ? || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || {{Yes}}
| ?
| "game", "video", "tv"
|-
|-
| title || displays XMB main title from plain text input. Cannot be used at the same time as 'title_rsc'. || Yes || Yes || Yes || "Debug Settings"
| custom_priority
| {{Yes}} || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "game=-80", "video=-80", "tv=-80"
|-
|-
| info_rsc || displays XMB title information from relevant .rco. This is shown below the 'title' or 'title_rsc' entry ins a smaller font. Cannot be used at the same time as 'info'. || Yes || Yes || Yes || "item_tex_cam_icon"
| data_connection
| ? || ? || ? || ? || ? || ? || ? || {{Yes}} || {{Yes}}
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || {{Yes}} || ? || ?
| ?
| "xcb://localhost/query?..."
|-
|-
| info || displays XMB title information from plain text input. This is shown below the 'title' or 'title_rsc' entry ins a smaller font. Cannot be used at the same time as 'info_rsc'. || Yes || Yes || Yes || "This is a cool plain text info string"
| device_path
| {{yes}} || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "/dev_hdd0"
|-
|-
| child || tells the PS3 what action should be taken when the XMB item is selected. || Yes || No || Yes || "segment"  
| fo_lbl_alpha
| {{Yes}} || {{Yes}} || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "0" - float number
|-
|-
| ingame || tells the PS3 if the item can be accessed ingame. || Yes || No || Yes || "enable"/"disable"
| fo_lbl2_alpha
| {{Yes}} || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "0" - float number
|-
|-
| str_noitem || displays information from relevant .rco when no data/XMB items are found from then search function of the current XMB item. || Yes || No || No || "msg_error_no_gamedata"
| focus
| ? || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || {{Yes}} || ? || ? || {{Yes}} || ? || ? || ? || ? || ? || ?
| ?
| "last"
|-
|-
| module_name || the name of the module to be used from this [[XMB XML Coding#Module-Action|list]] || No || Yes || No || "webbrowser_plugin"/"explore_plugin"
| focus_detect
| {{Yes}} || ? || ? || {{Yes}} || ? || ? || ? || ? || ?
| ? || ? || ?
| {{Yes}} || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "enable"  
|-
|-
| module_action || what the module is commanded to use. The example commands are in respect the above modules || No || Yes || No || "http://m.facebook.com"/"NotifyErrorNoExecute"
| focus_priority
| {{Yes}} || ? || ? || {{Yes}} || ? || ? || ? || ? || ?
| ? || ? || ?
| {{Yes}} || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "-5", "-4", "-3", "-2", "-1", "0", "1", "2", "3", "4", "5", "6". "-50", "-49", "-48", "-47", "-46". "-80"
|-
|-
| bar_action || ? || No || Yes || No || "none"
| fs_path
| ? || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || {{Yes}} || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "/dev_hdd0/widget/npdrm/informationboard"  
|-
|-
| lbl_half || ? || No|| Yes || No || "1"
| genre
| ? || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || {{yes}} || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "BdData"
|-
|-
| focus_detect || tells the PS3 to focus on the item if it is activated/utilised (like inserting a PS3 game disc). Of course the vsh.self has the final say on whether it is used (turning off auto boot) || Yes || Yes || Yes || "enable"
| icon
| {{Yes}} || ? || ? || {{Yes}} || ? || ? || ? || ? || ?
| ? || ? || ?
| {{Yes}} || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "/dev_hdd0/myicon.png"  
|-
|-
| focus_priority || tells the PS3 the order in which the XMB items are loaded. This is use more by XMB items on the root of the XMB. || Yes || Yes || Yes || any integer
| icon_fixed_height
| {{Yes}} || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "181"
|-
|-
|}
| icon_fixed_width
 
| {{Yes}} || ? || ? || ? || ? || ? || ? || ? || ?
 
| ? || ? || ?
=== Module-Action ===
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
 
| ?
This is acts like a module (SPRX) intercom, allowing XML files to use/send commands to a select list modules, so it can perform functions outside the limits of the module managing that XMB Category. The list of 'useable' modules is indexed in the xmb_plugin.sprx and contains a Module Reference and the path to the module .sprx file and associated .rco file for each module. The the list of 'useable' modules for [[3.55 CEX]]:
| "181"
{| class="wikitable sortable"
|-
| icon_notation
| {{Yes}} || ? || ? || {{Yes}} || ? || ? || ? || ? || ?
| ? || ? || ?
| {{Yes}} || ? || ? || ? || ? || ? || {{Yes}} || ? || ? || ? || ? || ? || ? || {{Yes}} || ?
| {{Yes}}
| "WNT_XmbItemAlbum", etc... (see table below)
|-
| icon_rsc
| {{Yes}} || ? || ? || {{Yes}} || ? || ? || ? || ? || ?
| ? || ? || ?
| {{Yes}} || ? || ? || ? || ? || ? || {{Yes}} || {{Yes}} || ? || ? || ? || ? || {{Yes}} || {{Yes}} || ?
| {{Yes}}
| "tex_album_icon"
|-
| id
| ? || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || {{Yes}} || ? || ? || ? || ? || ?
| ?
| ?
|-
| info
| {{Yes}} || ? || ? || {{Yes}} || ? || ? || ? || ? || ?
| ? || ? || ?
| {{Yes}} || ? || ? || ? || ? || ? || {{Yes}} || ? || {{Yes}} || ? || ? ||  ? || ? || ? || ?
| ?
| "This is a cool plain text info string"
|-
| info_rsc
| {{Yes}} || ? || ? || {{Yes}} || ? || ? || ? || ? || ?
| ? || ? || ?
| {{Yes}} || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "item_tex_cam_icon"
|-
|-
! Module Reference !! Associated .rco Filepath !! Module Filepath !! Known Use
| ingame
| {{Yes}} || ? || ? || {{Yes}} || ? || ? || ? || ? || ?
| ? || ? || ?
| {{No}} || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "enable", "disable"
|-
|-
| playlist_plugin || /dev_flash/vsh/resource/playlist_plugin.rco || /dev_flash/vsh/module/playlist_plugin.sprx ||
| instruction_rsc
| ? || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || {{Yes}} || ? || ? || ? || ? || ? || ?
| ?
| "msg_lwp_explanation"
|-
|-
| scenefolder_plugin || /dev_flash/vsh/resource/scenefolder_plugin.rco || /dev_flash/vsh/module/scenefolder_plugin.sprx ||
| item_type
| {{Yes}} || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "systop"
|-
|-
| system_plugin || N/A || N/A ||
| lbl_half
| {{No}} || ? || ? || {{No}} || ? || ? || ? || ? || ?
| ? || ? || ?
| {{Yes}} || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "1"
|-
|-
| xmb_plugin || N/A || N/A ||
| logical_sceme
| {{yes}} || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "Music", "Photo", "Video"
|-
|-
| explore_plugin || /dev_flash/vsh/resource/explore_plugin_full.rco || /dev_flash/vsh/module/explore_plugin.sprx || Used to stub XMB items in Kiosk(SEX/Shop) Firmware
| mass_connection
| ? || ? || ? || ? || ? || ? || ? || {{Yes}} || {{Yes}}
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "xcb://localhost/query?..."
|-
|-
| game_plugin || /dev_flash/vsh/resource/game_plugin.rco  || /dev_flash/vsh/module/basic_plugins.sprx ||
| mode
| ? || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || {{yes}} || {{yes}} || ? || ? || ? || ? || ? || {{Yes}} || ? || ? || ? || ? || ?
| ?
| "common", "mgmt", "playlistmgmt", "playlistmgmtpsp", "playlistempty"
|-
|-
| np_trophy_ingame || /dev_flash/vsh/resource/np_trophy_ingame.rco || /dev_flash/vsh/module/np_trophy_ingame.sprx ||
| module_action
| {{No}} || ? || ? || {{No}} || ? || ? || ? || ? || ?
| ? || ? || ?
| {{Yes}} || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "NotifyErrorNoExecute", "http://m.facebook.com", 0, 1
|-
|-
| gamedata_plugin || /dev_flash/vsh/resource/gamedata_plugin.rco || /dev_flash/vsh/module/gamedata_plugin.sprx ||
| module_name
| {{No}} || ? || ? || {{No}} || ? || ? || ? || ? || ?
| ? || ? || ?
| {{Yes}} || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "explore_plugin", "webbrowser_plugin"
|-
|-
| game_ext_plugin || /dev_flash/vsh/resource/gamedata_plugin.rco || /dev_flash/vsh/module/game_ext_plugin.sprx ||
| ms_connection
| ? || ? || ? || ? || ? || ? || ? || {{Yes}} || {{Yes}}
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "xcb://localhost/query?..."
|-
|-
| premo_plugin || /dev_flash/vsh/resource/premo_plugin.rco || /dev_flash/vsh/module/premo_plugin.sprx ||
| name
| ? || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "Flash Player[test.swf]"
|-
|-
| micon_lock_plugin || N/A || /dev_flash/vsh/module/micon_lock_plugin.sprx ||
| path
| ? || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || {{Yes}} || ? || ? || ? || ? || ?
| ?
| "flash0/vsh/resource/flash/test.swf"
|-
|-
| category_setting_plugin || /dev_flash/vsh/resource/category_setting_plugin.rco || /dev_flash/vsh/module/category_setting_plugin.sprx ||
| pkg_src
| ? || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || {{Yes}} || ? || ? || ? || ? || ? || ?
| ?
| "http://dL-REGION01.ps3.download.playstation.net/.../lwp.pkg"
|-
|-
| sysconf_plugin || /dev_flash/vsh/resource/sysconf_plugin.rco || /dev_flash/vsh/module/sysconf_plugin.sprx ||
| pkg_src_qa
| ? || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || {{Yes}} || ? || ? || ? || ? || ? || ?
| ?
| ?
|-
|-
| netconf_plugin || /dev_flash/vsh/resource/netconf_plugin.rco || /dev_flash/vsh/module/netconf_plugin.sprx ||
| prod_pic_path
| ? || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || {{Yes}} || ? || ? || {{Yes}} || ? || ? || ? || ? || ? || ?
| ?
| "/dev_flash/vsh/resource/explore/icon/fah-xmb.png"
|-
|-
| software_update_plugin || /dev_flash/vsh/resource/software_update_plugin.rco || /dev_flash/vsh/module/software_update_plugin.sprx ||
| sd_connection
| ? || ? || ? || ? || ? || ? || ? || {{Yes}} || {{Yes}}
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "xcb://localhost/query?..."
|-
|-
| bdp_plugin || /dev_flash/vsh/resource/bdp_plugin.rco || /dev_flash/vsh/module/bdp_plugin.sprx ||
| start_factory_play
| ? || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| {{Yes}} || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "disable"
|-
|-
| bdp_disccheck_plugin || /dev_flash/vsh/resource/bdp_disccheck_plugin.rco || /dev_flash/vsh/module/bdp_disccheck_plugin.sprx ||
| str_noitem
| {{Yes}} || ? || ? || {{No}} || ? || ? || ? || ? || ?
| ? || ? || ?
| {{No}} || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "msg_error_no_file", any message text from explore_plugin rco works
|-
|-
| bdp_storage_plugin || /dev_flash/vsh/resource/bdp_storage_plugin.rco || /dev_flash/vsh/module/bdp_storage_plugin.sprx ||
| title
| {{Yes}} || ? || ? || {{Yes}} || ? || ? || ? || ? || ?
| ? || ? || ?
| {{Yes}} || ? || ? || ? || ? || ? || ? || {{Yes}} || ? || ? || ? || ? || ? || ? || ?
| ?
| "Debug Settings"
|-
|-
| user_plugin || /dev_flash/vsh/resource/user_plugin.rco || /dev_flash/vsh/module/user_plugin.sprx ||
| title_fo
| {{Yes}} || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "1"
|-
|-
| friendim_plugin || N/A || /dev_flash/vsh/module/friendim_plugin.sprx ||
| title_rsc
| {{Yes}} || ? || ? || {{Yes}} || ? || ? || ? || ? || ?
| ? || ? || ?
| {{Yes}} || ? || ? || ? || ? || ? || {{Yes}} || ? || ? || ? || {{Yes}} || ? || {{Yes}} || {{Yes}} || ?
| {{Yes}}
| "msg_tool_app_home_ps3_game"
|-
|-
| friendml_plugin || /dev_flash/vsh/resource/friendml_plugin.rco || /dev_flash/vsh/module/friendml_plugin.sprx ||
| type
| ? || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || {{yes}} || ? || ? || ? || ? || ? || {{Yes}} || {{Yes}} || ? || ? || ? || ?
| ?
| "photo", "music", "video"
|-
|-
| friendtrophy_plugin || /dev_flash/vsh/resource/friendtrophy_plugin.rco || /dev_flash/vsh/module/friendtrophy_plugin.sprx ||
| vmc
| ? || {{Yes}} || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "promote"
|-
|-
| profile_plugin || /dev_flash/vsh/resource/profile_plugin.rco || /dev_flash/vsh/module/profile_plugin.sprx ||
|}
 
*Official are marked as "Yes"
*Unnofficial and working are marked as "Opt"
*Unnofficial and not working are marked as "No"
 
----
 
'''action'''.
{| class="wikitable"
|+action
! action !! usage
|-
|-
| photoviewer_plugin || /dev_flash/vsh/resource/photoviewer_plugin.rco || /dev_flash/vsh/module/photoviewer_plugin.sprx ||
| exec_game || ps3 gamedata
|-
|-
| videoplayer_plugin || /dev_flash/vsh/resource/videoplayer_plugin.rco || /dev_flash/vsh/module/videoplayer_plugin.sprx ||
| exec_vmcsavedata || ps1/ps2 savedata
|-
|-
| webbrowser_plugin || /dev_flash/vsh/resource/webbrowser_plugin.rco || /dev_flash/vsh/module/webbrowser_plugin.sprx || Can be used to link to webpages
| exec_ps3savedata || ps3 savedata
|-
|-
| webrender_plugin || /dev_flash/vsh/resource/webrender_plugin.rco || /dev_flash/vsh/module/webrender_plugin.sprx ||
| exec_pspsavedata || psp savedata
|-
|-
| xai_plugin || /dev_flash/vsh/resource/xai_plugin.rco || /dev_flash/vsh/module/xai_plugin.sprx ||
| exec_psp2appdata || psvita utility
|-
|-
| audioplayer_plugin || /dev_flash/vsh/resource/audioplayer_plugin.rco || /dev_flash/vsh/module/audioplayer_plugin.sprx ||
| exec_sdps2 || ps2 savedata
|}
 
'''child'''. Tells the PS3 what action should be taken when the XMB item is selected.
 
'''focus_detect'''. Tells the PS3 to focus on the item if it is activated/used(like inserting a PS3 game disc). Of course the vsh.self has the final say on whether it is used (turning off auto boot)
 
'''focus_priority'''. Tells the PS3 the order in which the XMB items are loaded. This is used more by XMB items on the root of the XMB.
 
'''icon'''. Displays a .png image from an absolute path as XMB icon. Cannot be used at the same time as 'icon_rsc'
 
'''icon_notation'''. Tells the XMB how to display the icon layout (transparency etc). Can in some cases override 'icon' or 'icon_rsc'
 
{| class="wikitable"
|+icon_notation
! icon_notation !! Use !! Notes
|-
|-
| videodownloader_plugin || /dev_flash/vsh/resource/videodownloader_plugin.rco || /dev_flash/vsh/module/videodownloader_plugin.sprx ||
| WNT_XmbItemAlbum || || overrides 'icon_rsc'
|-
|-
| nas_plugin || /dev_flash/vsh/resource/nas_plugin.rco || /dev_flash/vsh/module/nas_plugin.sprx ||
| WNT_XmbItemBrowser || || overrides 'icon_rsc'
|-
|-
| download_plugin || /dev_flash/vsh/resource/download_plugin.rco || /dev_flash/vsh/module/download_plugin.sprx ||
| WNT_XmbItemChat || ||  
|-
|-
| ps3_savedata_plugin || /dev_flash/vsh/resource/ps3_savedata_plugin.rco || /dev_flash/vsh/module/ps3_savedata_plugin.sprx ||
| WNT_XmbItemChatRoomText || ||  
|-
|-
| vmc_savedata_plugin || /dev_flash/vsh/resource/vmc_savedata_plugin.rco. || /dev_flash/vsh/module/vmc_savedata_plugin.sprx ||
| WNT_XmbItemFriendAccountManagement || ||  
|-
|-
| thumthum_plugin || /dev_flash/vsh/resource/thumthum_plugin.rco || /dev_flash/vsh/module/thumthum_plugin.sprx ||
| WNT_XmbItemFriendAdd || ||  
|-
|-
| npsignin_plugin || /dev_flash/vsh/resource/npsignin_plugin.rco || /dev_flash/vsh/module/npsignin_plugin.sprx ||
| WNT_XmbItemFriendBlock || ||  
|-
|-
| avc_plugin || /dev_flash/vsh/resource/avc_plugin.rco ||/dev_flash/vsh/module/avc_plugin.sprx ||
| WNT_XmbItemFriendMessageBox || ||  
|-
|-
| avc2_text_plugin || /dev_flash/vsh/resource/avc2_text_plugin.rco || /dev_flash/vsh/module/avc2_text_plugin.sprx ||
| WNT_XmbItemFriendMessageBoxReceived || ||  
|-
|-
| sacd_plugin || /dev_flash/vsh/resource/sacd_plugin.rco || /dev_flash/vsh/module/sacd_plugin.sprx ||
| WNT_XmbItemFriendMessageBoxSent || ||  
|-
|-
| eula_cddb_plugin || /dev_flash/vsh/resource/eula_cddb_plugin.rco || /dev_flash/vsh/module/eula_cddb_plugin.sprx ||
| WNT_XmbItemFriendMessageCreate || ||  
|-
|-
| strviewer_plugin || /dev_flash/vsh/resource/strviewer_plugin.rco. || /dev_flash/vsh/module/strviewer_plugin.sprx ||
| WNT_XmbItemFriendPlayer || ||  
|-
|-
| edy_plugin || /dev_flash/vsh/resource/edy_plugin.rco || /dev_flash/vsh/module/edy_plugin.sprx ||
| WNT_XmbItemInetSearch || ||  
|-
|-
| print_plugin || /dev_flash/vsh/resource/print_plugin.rco || /dev_flash/vsh/module/print_plugin.sprx ||
| WNT_XmbItemMediaServerSearch || ||  
|-
|-
| newstore_plugin || /dev_flash/vsh/resource/newstore_plugin.rco || /dev_flash/vsh/module/newstore_plugin.sprx ||
| WNT_XmbItemOnlineManual || ||  
|-
|-
| deviceconf_plugin || /dev_flash/vsh/resource/deviceconf_plugin.rco || /dev_flash/vsh/module/deviceconf_plugin.sprx ||
| WNT_XmbItemPRemo || ||  
|-
|-
| dlna_plugin || /dev_flash/vsh/resource/dlna_plugin.rco || /dev_flash/vsh/module/dlna_plugin.sprx ||
| WNT_XmbItemPlaylist || || overrides 'icon_rsc'
|-
|-
| np_trophy_plugin || /dev_flash/vsh/resource/np_trophy_plugin.rco || /dev_flash/vsh/module/np_trophy_plugin.sprx ||
| WNT_XmbItemPlaylistAdd || ||  
|-
|-
| kensaku_plugin || /dev_flash/vsh/resource/kensaku_plugin.rco || /dev_flash/vsh/module/kensaku_plugin.sprx ||
| WNT_XmbItemPowerOff || ||  
|-
|-
| regcam_plugin || /dev_flash/vsh/resource/regcam_plugin.rco || /dev_flash/vsh/module/regcam_plugin.sprx ||
| WNT_XmbItemSavePS12 || ||  
|-
|-
| idle_plugin || /dev_flash/vsh/resource/idle_plugin.rco || /dev_flash/vsh/module/idle_plugin.sprx ||
| WNT_XmbItemSavePS3 || ||  
|-
|-
| filecopy_plugin || /dev_flash/vsh/resource/filecopy_plugin.rco || /dev_flash/vsh/module/filecopy_plugin.sprx ||
| WNT_XmbItemSavedataMinis || ||  
|-
|-
| wboard_plugin || /dev_flash/vsh/resource/wboard_plugin.rco || /dev_flash/vsh/module/wboard_plugin.sprx ||
| WNT_XmbItemTrophy || ||  
|-
|-
| checker_plugin || /dev_flash/vsh/resource/checker_plugin.rco || /dev_flash/vsh/module/checker_plugin.sprx ||
| WNT_XmbItemUser || ||  
|-
|-
| hknw_plugin || /dev_flash/vsh/resource/hknw_plugin.rco || /dev_flash/vsh/module/hknw_plugin.sprx ||
| WNT_XmbItemVideoNew || ||  
|-
|-
| poweroff_plugin || /dev_flash/vsh/resource/poweroff_plugin.rco || /dev_flash/vsh/module/poweroff_plugin.sprx ||
| WNT_XmbListMusic || || overrides 'icon_rsc'
|-
|-
| eula_hcopy_plugin || /dev_flash/vsh/resource/eula_hcopy_plugin.rco || /dev_flash/vsh/module/eula_hcopy_plugin.sprx ||
| WNT_XmbListPhoto || || overrides 'icon_rsc'
|-
|-
| videoeditor_plugin || /dev_flash/vsh/resource/videoeditor_plugin.rco || /dev_flash/vsh/module/videoeditor_plugin.sprx ||
| WNT_XmbListVideo || || overrides 'icon_rsc'
|-
|-
|}
|}


'''icon_rsc'''. Displays an image from a .rco as XMB icon. Cannot be used at the same time as 'icon'


== Worked Examples ==
'''info'''. Displays XMB title information from plain text input. This is shown below the 'title' or 'title_rsc' entry in a smaller font


=== An XMB item tree ===
'''info_rsc'''. Displays XMB title information from relevant .rco. This is shown below the 'title' or 'title_rsc' entry in a smaller font


For this we will make a XMB item which will act as a folder opening up into 3 other XMB items.
'''ingame''' Use: tells the PS3 if the item can be accessed ingame


1/ First create the root XMB item which acts as a folder
'''mode'''.
<pre><View id="XMB_Folder_1">
{| class="wikitable"
<Attributes>
|+mode
<Table key="xmb_folder">
! mode !! usage
<Pair key="icon_rsc"><String>tex_album_icon</String></Pair>
|-
<Pair key="title"><String>XMB Menu Item</String></Pair>
| common ||
<Pair key="info"><String>This will subdivide into 3 items :)</String></Pair>
|-
<Pair key="child"><String>segment</String></Pair>
| mgmt ||
</Table>
|-
</Attributes>
| playlistmgmt ||
<Items>
|-
<Query class="type:x-xmb/folder-pixmap"  key="xmb_folder" attr="xmb_folder" src="#XMB_Folder_1_items" />
| playlistmgmtpsp ||
</Items>
|-
</View></pre> 
| playlistempty ||
Important Notes:
|}
* I've used "''<Query class="type:x-xmb/folder-pixmap"''" for <Items> sub-entry type as it is good for displaying menus.
 
* The 'key' in the <Items> sub-entry (xmb_folder) is the same as the table key in Attibutes, so those attributes are assigned to the xmb_folder <Items> sub-entry.
'''module_action'''. Is the commanded to be used by the module
* the 'src' is pointing to 'XMB_Folder_1_items' - the another XMB .xml entry in the current .xml
 
* the icon is from a .rco file and is a basic folder icon, like what the 'Game Data' XMB item uses
'''module_name''' Use: the name of the module to be used from the [[XMBML module-action]] list
* 'title' and 'info' are in plain text
* 'child' is set as 'segment' so the XMB knows this item will subdivide into other XMB items


In order to create a working XMB sub menu the root xmb item (in this "XMB_Folder_1") must have its 'src' linking to a contents linker(its the best way to think about it) and not directly linking to XMB items in the sub menu.( If you do not do this when you select your root XMB item to display a sub menu, the 'output' or 'action' of the XMB items of the sub menu will be shown rather than the actual XMB items):
'''str_noitem'''. Displays information from relevant .rco when no data/XMB items are found


<pre><View id="XMB_Folder_1_items">
'''title'''. Displays XMB main title from plain text input. Cannot be used at the same time as 'title_rsc'
<Items>
<Query class="type:x-xmb/folder-pixmap"  key="xmb_folder" attr="xmb_folder" src="#XMB_Folder_1_contents" />
</Items>
</View></pre> 
Important Notes:
* This has no attributes as it simply acts as a contents container/linker


Now to create the XMB .xml entry which holds the sub menu items:
'''title_rsc'''. Displays XMB main title text referred from relevant .rco. Cannot be used at the same time as 'title'


<pre><View id="XMB_Folder_1_contents">
==Loading resource files from the associated .rco==
<Attributes>
The attributes with names containing '''rsc''' (resource), '''str''' (string), or '''msg''' (message), as '''icon_rsc''', '''title_rsc''', '''info_rsc''', and '''instruction_rsc''' can load images or texts from the .rco associated with the XMB column (the variants of explore_category_****.rco, and explore_plugin_full.rco that is common for all XMB categories, also some others that are specific for a category as gamelib_plugin.rco or gamedata_plugin.rco)
<Table key="xmb_subitem_1">
{{RCO TOC reference types}}
<Pair key="icon_rsc"><String>tex_album_icon</String></Pair>
<Pair key="title"><String>XMB Sub Menu Item</String></Pair>
<Pair key="info"><String>Dummy Sub item 1</String></Pair>
<Pair key="str_noitem"><String>msg_error_no_gamedata</String></Pair>
</Table>
<Table key="xmb_subitem_2">
<Pair key="icon_rsc"><String>tex_album_icon</String></Pair>
<Pair key="title"><String>XMB Sub Menu Item</String></Pair>
<Pair key="info"><String>Dummy Sub item 2</String></Pair>
<Pair key="str_noitem"><String>msg_error_no_gamedata</String></Pair>
</Table>
<Table key="xmb_subitem_3">
<Pair key="icon_rsc"><String>tex_album_icon</String></Pair>
<Pair key="title"><String>XMB Sub Menu Item</String></Pair>
<Pair key="info"><String>Dummy Sub item 3</String></Pair>
<Pair key="str_noitem"><String>msg_error_no_gamedata</String></Pair>
</Table>
</Attributes>
<Items>
<Query class="type:x-xmb/folder-pixmap"  key="xmb_subitem_1" attr="xmb_subitem_1" />
<Query class="type:x-xmb/folder-pixmap"  key="xmb_subitem_2" attr="xmb_subitem_2" />
<Query class="type:x-xmb/folder-pixmap"  key="xmb_subitem_3" attr="xmb_subitem_3" />
</Items>
</View></pre> 
Important Notes:
* These are dummy items, they do not 'go anywhere' or perform any function. They will just print the str_noitem message when clicked because they have no function
* notice how the keys from the <Items> sub entries match the Table keys from the <Attributes> sub entries
* The <Attributes> and the <Items> sub entries do not have to be in the same order to work, they just have to have their 'key' in common


=== A web link ===


This type of entry could be placed on the root of the XMB category, or in an XMB Item Tree. This is also an application of the 'module-action'. It's quite self-explanatory.
{{File Formats}}<noinclude>[[Category:Main]]</noinclude>
Example:
<pre> <View id="seg_links_ps3scene">
<Attributes>
<Table key="google">
<Pair key="icon_rsc"><String>google_icon</String></Pair>
<Pair key="title"><String>Google</String></Pair>
<Pair key="info"><String>A really cool webpage</String></Pair>
<Pair key="module_name"><String>webbrowser_plugin</String></Pair>
<Pair key="module_action"><String>http://www.google.com/</String></Pair>
  </Table>
</Attributes>
<Items>
<Item class="type:x-xmb/module-action" key="google" attr="google"/>
</Items>
</View>
</pre>

Latest revision as of 04:57, 30 August 2021

Basic XMBML Structure[edit | edit source]

This page outlines the logic behind XMB XML configuration files. For some practise usage see: XMBML Coding Examples

This is a reduced version of category_network.xml with only one icon (tex_browser) that launches the webbrowser (type:x-xmb/xmlwebbrowser). The .xml is loaded starting from <View id="root">, then inside the <Items> table there is a <Query> linking to #seg_browser (the character "#" links to a <View id> in the same file, so is linked to <View id="seg_browser">). When <View id="seg_browser"> is loaded first starts reading the table of <Items> that contains an <Item> that is linked using attr="browser" to a table of attributes <Table key="browser" 

<?xml version="1.0" encoding="UTF-8"?>

<XMBML version="1.0">
	<View id="root">
		<Items>
			<Query class="type:x-xmb/folder-pixmap" key="seg_browser" src="#seg_browser"/>
		</Items>
	</View>
	<View id="seg_browser">
		<Attributes>
			<Table key="browser">
				<Pair key="icon_rsc"><String>tex_browser</String></Pair>
				<Pair key="icon_notation"><String>WNT_XmbItemBrowser</String></Pair>
				<Pair key="title_rsc"><String>msg_browser</String></Pair>
 			</Table>
		</Attributes>
		<Items>
			<Item class="type:x-xmb/xmlwebbrowser" key="browser" attr="browser"/>
		</Items>
	</View>
</XMBML>
  • The contents of the .xml file can be identifyed by the <View id> and <key> this way:
    • <View id="root"> contains 1 <Items> with the key="seg_browser"
    • <View id="seg_browser"> contains 1 <Items> with the key="browser"
	<View id="root">
		<Items>
			<Query key="seg_browser"/>
		</Items>
	</View>
	<View id="seg_browser">
		<Attributes>
			<Table key="browser">
 			</Table>
		</Attributes>
		<Items>
			<Item key="browser"/>
		</Items>
	</View>
  • Note the "Pair key"'s inside "attributes tables" are not considered identifyers of the xml tag

View ID's (Enviroment ID's, and Segment ID's)[edit | edit source]

Identifyers made of UTF-8 characters and without spaces. There are two types: Enviroments, and Segments

  • Enviroments are reserved names (hardcoded in VSH?): "root", "root_info", "root_for_dex", "root_dex", "root_for_BDU", "root_power_only", "root_hide_friend", "tool_root", "shop_root", "shop_guest_root", "shop_staff_root", "root_arcade" and obsolete: "stage_demo_root", "xai_test_root", "store_root"
    • Used to load specific XMB items for different PS3 types (retail, debug, etc...), or to load items in specific boot modes (e.g: in shop PS3's "locked" or "unlocked" modes), can be considered the XMB enviroments used by the XMB Configuration Files
    • Usually inside the .XML files there are several <View id> of this type starting with "root" (retail XMB) at the top, only one of them is loaded by VSH when the PS3 boots
  • Segments are all the others with names starting with "seg_" (e.g: seg_gamedata, seg_gameexit, seg_manual, etc...). There must be no other segments with the same name in the same .XML file, but some segments used for common functions are repeated in different .XML files and uses the same segment name and key identifyer (e.g. the segment "seg_gameexit" containing an item with the key "gamexit" is repeated in 8 .XML files)
    • Segments are loaded by some query classes (inside <items> tables) by making his "src" to point to the target segment. When the segment is in the same .XML file it works simply by "jumping" to another line of the same file. When the segment is in another .XML file first is needed to locate the target .XML file, and then the "jump" to the target segment
      • Links to a segment in the same .XML file uses the character "#", and the name of the target segment (e.g: src="#seg_poweroff")
      • Links to a segment in another .XML file uses the xmb://localhost/ function with the path of the target file, the character "#", and the name of the target segment (e.g: src="xmb://localhost/dev_flash/vsh/resource/explore/xmb/category_user.xml#seg_poweroff"), or alternativelly the short path form replacing "dev_flash/vsh/resource/explore/" by "%flash/" (e.g: src="xmb://localhost/%flash/xmb/category_user.xml#seg_poweroff")
    • Is posible to load the "root" view IDs of other file (e.g: src="xmb://localhost/%flash/xmb/category_user.xml#root")

Items (Query classes, and Item classes)[edit | edit source]

The contents of this sub group dictates what exists on the XMB when this entry is used. There can be more than one.

When creating a XMB entry, you must tell vsh.self and its modules what you want to do. And the first part of a <Items> sub-entry does just this by telling the PS3 the "class" of the entry in the form of either "<Item class=""" or "<Query class=""" (in the case of "<Query class=""" can be used several times under the same <items> to perform group of actions). There are many acceptable values possible, here are some examples:

Tags used by class/subclass
Query classes x-xmb <key> <attr> <src> Remarks
<Query class="type:x-xmb/category" Yes Yes Yes Main/Root XMB
<Query class="type:x-xmb/folder-pixmap" Yes Yes Yes Has many uses see here
<Query class="type:x-xmb/xmlmcutility" Yes Yes Yes PS1 and PS2 virtual memory card utility
<Query class="type:x-xmb/xmlnpsignup" Yes Yes No
<Query class="type:x-xmb/xmlpackagefolder" Yes Yes Yes Used for installing package files
<Query class="type:x-xmb/xmlpsp2appdata" Yes Yes No PSVita application utility
<Query class="type:x-xmb/xmlsavedata-plus" Yes Yes No Online storage
<Query class="type:x-xmb/xmlsavedata-ps2" Yes Yes No Savedata utility PS2
<Query class="type:x-xmb/xmlsavedata-ps3" Yes Yes No Savedata utility PS3
<Query class="type:x-xmb/xmlsavedata-psp" Yes Yes No Savedata utility PSP
Query classes x-xcb <key> <attr> <src> Remarks
<Query class="type:x-xcb/game-debug" Yes Yes No /app_home/PS3_GAME/ link
<Query class="type:x-xcb/savedata-ps3" Yes Yes No PS3 new savedata
<Query class="type:x-xcb/savedata-psp" Yes Yes No PSP new savedata
Item classes x-xmb <key> <attr> <src> Remarks
<Item class="type:x-xmb/module-action" Yes Yes No Uses a particular module to support the XMB item. See XMBML module-action page
<Item class="type:x-xmb/vmc-new" Yes Yes No
<Item class="type:x-xmb/xmlbddatamgmt" Yes Yes No
<Item class="type:x-xmb/xmleditingvideo" Yes Yes No
<Item class="type:x-xmb/xmlflashplayer" Yes Yes No
<Item class="type:x-xmb/xmlgameexit" Yes No No
<Item class="type:x-xmb/xmlhakoniwa" Yes Yes No
<Item class="type:x-xmb/xmliboard" Yes Yes No Widgets control (class not used over firmware 3.00)
<Item class="type:x-xmb/xmlmessagelist" Yes Yes No
<Item class="type:x-xmb/xmlnowplaying" Yes Yes No
<Item class="type:x-xmb/xmlnpsignup" Yes Yes No
<Item class="type:x-xmb/xmlplaylist" Yes Yes No
<Item class="type:x-xmb/xmlplus" Yes No No
<Item class="type:x-xmb/xmlpoweroff" Yes No No
<Item class="type:x-xmb/xmlpremo" Yes No No
<Item class="type:x-xmb/xmlpsp2appdata-cont" Yes Yes No PSVita Applications (PSVita, PSP, PS1, PSMobile)
<Item class="type:x-xmb/xmlscreenshot" Yes No No
<Item class="type:x-xmb/xmlsysconf" Yes Yes No
<Item class="type:x-xmb/xmltrophy" Yes Yes No
<Item class="type:x-xmb/xmlwebbrowser" Yes Yes No
<Item class="type:x-xmb/xmlwelcome" Yes Yes No
Item classes x-chat <key> <attr> <src> Remarks
<Item class="type:x-chat/xmlchatroom-manager" Yes Yes No
Unknown usage
Unknown classes <key> <attr> <src> Remarks
x-xcb/achbase ? ? ? found inside explore_plugin.sprx
x-xcb/achievtitle ? ? ? found inside explore_plugin.sprx
x-xcb/achievgroup ? ? ? found inside explore_plugin.sprx
x-xcb/achievflag ? ? ? found inside explore_plugin.sprx
x-xcb/friendachievtitle ? ? ? found inside explore_plugin.sprx
x-xcb/friendachievgroup ? ? ? found inside explore_plugin.sprx
x-xcb/friendachievflag ? ? ? found inside explore_plugin.sprx
x-xcb/blockedplayer ? ? ? found inside explore_plugin.sprx
x-xcb/directory ? ? ? found inside explore_plugin.sprx
x-xcb/directory-bddata ? ? ? found inside explore_plugin.sprx
x-xcb/directory-generic ? ? ? found inside explore_plugin.sprx
x-xcb/directory-photo ? ? ? found inside explore_plugin.sprx
x-xcb/directory-music ? ? ? found inside explore_plugin.sprx
x-xcb/directory-video ? ? ? found inside explore_plugin.sprx
x-xcb/unknown ? ? ? found inside explore_category_game.sprx
x-xcb/message ? ? ? found inside explore_plugin.sprx
x-xcb/person ? ? ? found inside explore_plugin.sprx
x-xcb/playedplayer ? ? ? found inside explore_plugin.sprx
x-xcb/psv ? ? ? found inside explore_plugin.sprx
x-xcb/savedata-ps1 ? ? ? found inside explore_plugin.sprx
x-xcb/savedata-ps2 ? ? ? found inside explore_plugin.sprx
x-xcb/savedata-ps3delegate ? ? ? found inside explore_plugin.sprx
x-xcb/savedata-plus ? ? ? found inside explore_plugin.sprx
x-xcb/savedata-pspdir ? ? ? found inside explore_plugin.sprx
x-xcb/segment ? ? ? found inside explore_plugin.sprx
x-xcb/storage-media ? ? ? found inside explore_category_game.sprx
x-xcb/storagemedia-cdda ? ? ? found inside explore_plugin.sprx
x-xcb/storagemedia-sacd ? ? ? found inside explore_plugin.sprx
x-xcb/storagemedia-psmc ? ? ? found inside explore_plugin.sprx
x-xcb/storagemedia-psv ? ? ? found inside explore_plugin.sprx
x-xcb/storagemedia-sdps3 ? ? ? found inside explore_plugin.sprx
x-xcb/storagemedia-sdpsp ? ? ? found inside explore_plugin.sprx
x-xcb/storagemedia-sdpsp2 ? ? ? found inside explore_plugin.sprx
x-xcb/storagemedia-dlna ? ? ? found inside explore_plugin.sprx
x-xcb/storagemedia-avchd ? ? ? found inside explore_plugin.sprx
x-xcb/storagemedia-bdc ? ? ? found inside explore_plugin.sprx
x-xcb/storagemedia-generic ? ? ? found inside explore_plugin.sprx
x-xcb/storagemedia-videodisc ? ? ? found inside explore_plugin.sprx
x-xcb/game-disc ? ? ? found inside explore_category_game.sprx
x-xcb/game ? ? ? found inside explore_category_game.sprx
x-xcb/game-list ? ? ? found inside explore_category_game.sprx
x-xcb/content-disc ? ? ? found inside explore_category_game.sprx
x-xcb/music ? ? ? found inside explore_plugin.sprx
x-xcb/music-list ? ? ? found inside explore_plugin.sprx
x-xcb/photo ? ? ? found inside explore_plugin.sprx
x-xcb/photo-list ? ? ? found inside explore_plugin.sprx
x-xcb/query-condition ? ? ? found inside explore_category_game.sprx
x-xcb/video ? ? ? found inside explore_plugin.sprx
x-xcb/video-content ? ? ? found inside explore_plugin.sprx
x-xcb/video-list ? ? ? found inside explore_plugin.sprx
x-xcb/video-file ? ? ? found inside explore_plugin.sprx
x-xcb/video-disctitle ? ? ? found inside explore_plugin.sprx
x-xcb/vmc ? ? ? found inside explore_plugin.sprx
x-xcb/vmc-new ? ? ? found inside explore_plugin.sprx
x-xmb/xmlchannel ? ? ? found inside explore_plugin.sprx
x-xmb/xmlpsp2appdata-cont ? ? ? found inside explore_plugin.sprx
x-xmb/xmlscenefolder ? ? ? found inside explore_plugin.sprx
x-xmb/xmlvideodownloader ? ? ? found inside explore_plugin.sprx
x-xmb/unknown ? ? ? found inside explore_category_game.sprx
x-xil/xilitem ? ? ? found inside explore_category_game.sprx
x-ese/task ? ? ? found inside explore_category_game.sprx
x-ese/dlctl ? ? ? found inside explore_plugin.sprx
x-sel/registory-accessor ? ? ? found inside explore_category_game.sprx
x-user/user ? ? ? found inside explore_plugin.sprx
x-host/unknown ? ? ? found inside explore_plugin.sprx
x-host/mount-info ? ? ? found inside explore_plugin.sprx
x-host/directory ? ? ? found inside explore_plugin.sprx
x-host/file ? ? ? found inside explore_plugin.sprx
x-host/package ? ? ? found inside explore_plugin.sprx
x-host/theme-content ? ? ? found inside explore_plugin.sprx
x-host/ps2_newsavedata ? ? ? found inside explore_plugin.sprx
x-chat/room ? ? ? found inside explore_plugin.sprx
x-chat/player ? ? ? found inside explore_plugin.sprx
x-chat/xmlchatroom-manager ? ? ? found inside explore_plugin.sprx
  • <key>
    • Used to identify the sub-entry inside <Items> tables (usually the same value as <attr> and the <Table key> associated if present)
    • Example: key="my_icon"
  • <attr>
    • Used to link <Items> to a table of attributes with the same name <Table key> inside <Attributes>
    • Example: attr="my_icon_metadata"
  • <src>
    • Used to link to other xml files or utilise a XMB database functions (see XMB database)
    • Refer to another XMB entry inside the current xml file. Example: src="#seg_package_files"
    • Refer to another XMB entry inside another xml file. Example: src="xmb://localhost/dev_flash/vsh/resource/explore/xmb/category_game_tool2.xml#seg_package_files"
    • Use a XMB database function. Example: src="xcb://localhost/query?table=MMS_MEDIA_TYPE_SYSTEM&genre=Music&sort=+StorageMedia:Common.titleForSort&cond=Ae+StorageMedia:StorageMedia.type %xCB_MEDIA_TYPE_DLNA"

Attributes (Pairs)[edit | edit source]

This provides additional information about <Items> sub-entries by linking them to a table with attributes associated (is optionall, not all <Items> requires attributes), this tables uses a <Table key> matching the <attr> sub-entry asociated and contains one or more attributes separated in lines starting with <Pair key>.

Attributes used in official XMB, ordered by classes
<Attributes> <Items> Examples
<Table <Query class="type: <Item class="type:
<Pair key= x-xmb/ x-xcb/ x-xmb/ x-chat/
folder
pixmap		 mc
utility		 np
signup		 pkg
folder		 vita
apps		 save
plus		 save
ps2		 save
ps3		 save
psp		 game
debug		 save
ps3		 save
psp		 module
action		 vmc
new		 bddata
mgmt		 edit
video		 hako
niwa		 info
board		 msg
list		 now
playing		 np
signup		 play
list		 vita
apps		 sys
conf		 trophy browser welcome chat
room
action Yes Yes ? ? ? ? ? Yes Yes ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? "exec_game", etc... (see table below)
bar_action No ? ? No ? ? ? ? ? ? ? ? Yes ? ? ? ? ? ? Yes ? ? ? Yes ? ? ? ? "none", "hide", "game_pspemu_viewmode", "game_pspemu_3d", "game_psemu_upcon", "game_psemu_smooth", "pad_assign", "pad_vibration", "bt_device_utility", "audio_setting", "voice_changer", "net_netlist"
connection ? ? ? ? ? ? ? Yes Yes ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? "xcb://localhost/query?..."
cf_connection ? ? ? ? ? ? ? Yes ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? "xcb://localhost/query?..."
ch_pos Yes ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? "1"
child Yes ? ? Yes ? ? ? ? ? ? ? ? No ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? "segment", "grid", "Video"
content_id ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? Yes ? ? ? ? ? ? ? "IP9100-NPIA00002_00-0000111122223333"
content_info_pict ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? "/dev_flash/vsh/resource/explore/icon/pstex01.png"
content_info_pict_sd ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? "/dev_flash/vsh/resource/explore/icon/pstex-sd.png"
content_info_tex ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? "msg_ps3_portal"
content_info_title ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? "msg_psstore_explanation_hd"
content_info_title_sd ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? "msg_psstore_explanation_sd"
content_name ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? Yes ? ? Yes ? ? ? ? ? ? ? "msg_title_lwp", "msg_information_board"
content_type ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? Yes ? "game", "video", "tv"
custom_priority Yes ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? "game=-80", "video=-80", "tv=-80"
data_connection ? ? ? ? ? ? ? Yes Yes ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? Yes ? ? ? "xcb://localhost/query?..."
device_path Yes ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? "/dev_hdd0"
fo_lbl_alpha Yes Yes ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? "0" - float number
fo_lbl2_alpha Yes ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? "0" - float number
focus ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? Yes ? ? Yes ? ? ? ? ? ? ? "last"
focus_detect Yes ? ? Yes ? ? ? ? ? ? ? ? Yes ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? "enable"
focus_priority Yes ? ? Yes ? ? ? ? ? ? ? ? Yes ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? "-5", "-4", "-3", "-2", "-1", "0", "1", "2", "3", "4", "5", "6". "-50", "-49", "-48", "-47", "-46". "-80"
fs_path ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? Yes ? ? ? ? ? ? ? ? ? ? "/dev_hdd0/widget/npdrm/informationboard"
genre ? ? ? ? ? ? ? ? ? ? ? ? ? ? Yes ? ? ? ? ? ? ? ? ? ? ? ? ? "BdData"
icon Yes ? ? Yes ? ? ? ? ? ? ? ? Yes ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? "/dev_hdd0/myicon.png"
icon_fixed_height Yes ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? "181"
icon_fixed_width Yes ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? "181"
icon_notation Yes ? ? Yes ? ? ? ? ? ? ? ? Yes ? ? ? ? ? Yes ? ? ? ? ? ? Yes ? Yes "WNT_XmbItemAlbum", etc... (see table below)
icon_rsc Yes ? ? Yes ? ? ? ? ? ? ? ? Yes ? ? ? ? ? Yes Yes ? ? ? ? Yes Yes ? Yes "tex_album_icon"
id ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? Yes ? ? ? ? ? ? ?
info Yes ? ? Yes ? ? ? ? ? ? ? ? Yes ? ? ? ? ? Yes ? Yes ? ? ? ? ? ? ? "This is a cool plain text info string"
info_rsc Yes ? ? Yes ? ? ? ? ? ? ? ? Yes ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? "item_tex_cam_icon"
ingame Yes ? ? Yes ? ? ? ? ? ? ? ? No ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? "enable", "disable"
instruction_rsc ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? Yes ? ? ? ? ? ? ? "msg_lwp_explanation"
item_type Yes ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? "systop"
lbl_half No ? ? No ? ? ? ? ? ? ? ? Yes ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? "1"
logical_sceme Yes ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? "Music", "Photo", "Video"
mass_connection ? ? ? ? ? ? ? Yes Yes ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? "xcb://localhost/query?..."
mode ? ? ? ? ? ? ? ? ? ? ? ? ? ? Yes Yes ? ? ? ? ? Yes ? ? ? ? ? ? "common", "mgmt", "playlistmgmt", "playlistmgmtpsp", "playlistempty"
module_action No ? ? No ? ? ? ? ? ? ? ? Yes ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? "NotifyErrorNoExecute", "http://m.facebook.com", 0, 1
module_name No ? ? No ? ? ? ? ? ? ? ? Yes ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? "explore_plugin", "webbrowser_plugin"
ms_connection ? ? ? ? ? ? ? Yes Yes ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? "xcb://localhost/query?..."
name ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? "Flash Player[test.swf]"
path ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? Yes ? ? ? ? ? ? "flash0/vsh/resource/flash/test.swf"
pkg_src ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? Yes ? ? ? ? ? ? ? "http://dL-REGION01.ps3.download.playstation.net/.../lwp.pkg"
pkg_src_qa ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? Yes ? ? ? ? ? ? ? ?
prod_pic_path ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? Yes ? ? Yes ? ? ? ? ? ? ? "/dev_flash/vsh/resource/explore/icon/fah-xmb.png"
sd_connection ? ? ? ? ? ? ? Yes Yes ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? "xcb://localhost/query?..."
start_factory_play ? ? ? ? ? ? ? ? ? ? ? ? Yes ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? "disable"
str_noitem Yes ? ? No ? ? ? ? ? ? ? ? No ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? "msg_error_no_file", any message text from explore_plugin rco works
title Yes ? ? Yes ? ? ? ? ? ? ? ? Yes ? ? ? ? ? ? Yes ? ? ? ? ? ? ? ? "Debug Settings"
title_fo Yes ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? "1"
title_rsc Yes ? ? Yes ? ? ? ? ? ? ? ? Yes ? ? ? ? ? Yes ? ? ? Yes ? Yes Yes ? Yes "msg_tool_app_home_ps3_game"
type ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? Yes ? ? ? ? ? Yes Yes ? ? ? ? ? "photo", "music", "video"
vmc ? Yes ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? "promote"
  • Official are marked as "Yes"
  • Unnofficial and working are marked as "Opt"
  • Unnofficial and not working are marked as "No"

action.

action
action usage
exec_game ps3 gamedata
exec_vmcsavedata ps1/ps2 savedata
exec_ps3savedata ps3 savedata
exec_pspsavedata psp savedata
exec_psp2appdata psvita utility
exec_sdps2 ps2 savedata

child. Tells the PS3 what action should be taken when the XMB item is selected.

focus_detect. Tells the PS3 to focus on the item if it is activated/used(like inserting a PS3 game disc). Of course the vsh.self has the final say on whether it is used (turning off auto boot)

focus_priority. Tells the PS3 the order in which the XMB items are loaded. This is used more by XMB items on the root of the XMB.

icon. Displays a .png image from an absolute path as XMB icon. Cannot be used at the same time as 'icon_rsc'

icon_notation. Tells the XMB how to display the icon layout (transparency etc). Can in some cases override 'icon' or 'icon_rsc'

icon_notation
icon_notation Use Notes
WNT_XmbItemAlbum overrides 'icon_rsc'
WNT_XmbItemBrowser overrides 'icon_rsc'
WNT_XmbItemChat
WNT_XmbItemChatRoomText
WNT_XmbItemFriendAccountManagement
WNT_XmbItemFriendAdd
WNT_XmbItemFriendBlock
WNT_XmbItemFriendMessageBox
WNT_XmbItemFriendMessageBoxReceived
WNT_XmbItemFriendMessageBoxSent
WNT_XmbItemFriendMessageCreate
WNT_XmbItemFriendPlayer
WNT_XmbItemInetSearch
WNT_XmbItemMediaServerSearch
WNT_XmbItemOnlineManual
WNT_XmbItemPRemo
WNT_XmbItemPlaylist overrides 'icon_rsc'
WNT_XmbItemPlaylistAdd
WNT_XmbItemPowerOff
WNT_XmbItemSavePS12
WNT_XmbItemSavePS3
WNT_XmbItemSavedataMinis
WNT_XmbItemTrophy
WNT_XmbItemUser
WNT_XmbItemVideoNew
WNT_XmbListMusic overrides 'icon_rsc'
WNT_XmbListPhoto overrides 'icon_rsc'
WNT_XmbListVideo overrides 'icon_rsc'

icon_rsc. Displays an image from a .rco as XMB icon. Cannot be used at the same time as 'icon'

info. Displays XMB title information from plain text input. This is shown below the 'title' or 'title_rsc' entry in a smaller font

info_rsc. Displays XMB title information from relevant .rco. This is shown below the 'title' or 'title_rsc' entry in a smaller font

ingame Use: tells the PS3 if the item can be accessed ingame

mode.

mode
mode usage
common
mgmt
playlistmgmt
playlistmgmtpsp
playlistempty

module_action. Is the commanded to be used by the module

module_name Use: the name of the module to be used from the XMBML module-action list

str_noitem. Displays information from relevant .rco when no data/XMB items are found

title. Displays XMB main title from plain text input. Cannot be used at the same time as 'title_rsc'

title_rsc. Displays XMB main title text referred from relevant .rco. Cannot be used at the same time as 'title'

Loading resource files from the associated .rco[edit | edit source]

The attributes with names containing rsc (resource), str (string), or msg (message), as icon_rsc, title_rsc, info_rsc, and instruction_rsc can load images or texts from the .rco associated with the XMB column (the variants of explore_category_****.rco, and explore_plugin_full.rco that is common for all XMB categories, also some others that are specific for a category as gamelib_plugin.rco or gamedata_plugin.rco)

RCO TOC reference types
[edit]
reference_type pointer Method Loader Loads From Example (XML) Notes
0xFFFF0000 0xFFFFFFFF n/a All Nothing None <Entry reference="nothing"/>
0x04000000 relative event: RCOXML Objects
RCOXML Animations		 Code function Associated .SPRX <Entry event="event:native:/runFuctionX"/>
ScriptTree/Script File inside RCO <Entry event="event:script:/main/runFuctionX"/>
0x04010000 # (0-based) text: RCOXML Objects
XMBML Code		 TextTree/Text Strings inside RCO <Entry text="text:msg_mytext"/>
0x04020000 absolute image: RCOXML Objects
XMBML Code		 ImageTree/Image File inside RCO <Entry image="image:tex_mytexture"/>
0x04030000 absolute model: RCOXML Objects ModelTree/Model File inside RCO <Entry model="model:mymodel"/>
0x04040000 absolute ? sound: ? associated .SPRX SoundTree/Sound File inside RCO <Entry sound="sound:mysound"/> ? speculation
0x04050000 absolute font: RCOXML Objects FontTree/Font File inside RCO ? <Entry font="font:fontstyle_sanserif"/>
0x04060000 absolute ? anim2: ? RCOXML Objects ? AnimTree/Animation ? RCOXML code ? <Entry anim2="anim2:myanimation"/> ? speculation
0x04070000 absolute object2: RCOXML Objects ObjectTree/Object RCOXML code <Entry object2="object2:plane_myplane"/>
0x04080000 absolute anim: RCOXML Animations AnimTree/Animation RCOXML code <Entry anim="anim:myanimation"/>
0x04090000 absolute object: RCOXML Animations ObjectTree/Object RCOXML code <Entry object="object:plane_myplane"/>
  • A reference attribute is composed by two values, the first is the reference_type that indicates the "tree" of the entry that is going to be loaded, and the second is a pointer to a text string with the label of the entry that is going to be loaded
  • The reference_type event doesnt loads an entry from a "tree" though, it runs a code function from either a .sprx (by storing the text native:/ as part of the text string inside the RCO) or from a VSMX script (by storing the text script:/ as part of the text string inside the RCO)
  • First two bytes are swapped based on architecture (PSP in little endian, PS3 in big endian). The table shows the values in big endian


SCE File Types
Certified File
NPDRM
NPDRM · App Types · ACT.DAT · RIF
PKG
EDAT
RCOXML
CXML
XMBML
XMB Config
DB Config
Databases
System Data
XMB Preload
Licences
 ·
Games/Apps
PS3
Emulators
Web
Unsorted
Retrieved from "http://www.psdevwiki.com/ps3/index.php?title=XMBML_Coding&oldid=61561"