Editing XMBML Coding
Jump to navigation
Jump to search
The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.
Latest revision | Your text | ||
Line 1: | Line 1: | ||
This page will outline the logic behind [[XMB]] .xml configuration files. | |||
This page | |||
== Basic Structure == | |||
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" | 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" | ||
{{Boxcode| | {{Boxcode|content=<syntaxhighlight lang="xml"> | ||
<?xml version="1.0" encoding="UTF-8"?> | <?xml version="1.0" encoding="UTF-8"?> | ||
Line 10: | Line 10: | ||
<View id="root"> | <View id="root"> | ||
<Items> | <Items> | ||
<Query class="type:x-xmb/folder-pixmap" key="seg_browser" src="#seg_browser"/> | <Query class="type:x-xmb/folder-pixmap" key="seg_browser" src="#seg_browser" /> | ||
</Items> | </Items> | ||
</View> | </View> | ||
Line 22: | Line 22: | ||
</Attributes> | </Attributes> | ||
<Items> | <Items> | ||
<Item class="type:x-xmb/xmlwebbrowser" key="browser" attr="browser"/> | <Item class="type:x-xmb/xmlwebbrowser" key="browser" attr="browser" /> | ||
</Items> | </Items> | ||
</View> | </View> | ||
Line 28: | Line 28: | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
*The contents of the .xml file can be identifyed by the <View id> and <key> this way: | *The whole 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="root"> contains 1 <Items> with the key="seg_browser" | ||
**<View id="seg_browser"> contains 1 <Items> with the key="browser" | **<View id="seg_browser"> contains 1 <Items> with the key="browser" | ||
=== View id types (Target ID's, and segment ID's) === | |||
Identifyers made of UTF-8 characters and without spaces. There are two types: Target ID's, and segment ID's | |||
*[[Target ID]]'s 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]] | **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 '''<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 | **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 | ||
Line 63: | Line 45: | ||
**Is posible to load the "root" view IDs of other file (e.g: '''src="xmb://localhost/%flash/xmb/category_user.xml#root"''') | **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) === | ==== Items tables contents (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. | The contents of this sub group dictates what exists on the XMB when this entry is used. There can be more than one. | ||
Line 72: | Line 54: | ||
! Query classes x-xmb !! <key> !! <attr> !! <src> !! Remarks | ! Query classes x-xmb !! <key> !! <attr> !! <src> !! Remarks | ||
|- | |- | ||
| <Query class="type:x-xmb/'''folder-pixmap'''" || {{Yes}} || {{Yes}} || {{Yes}} || Has many uses see [[XMB modding|here]] | |||
| <Query class="type:x-xmb/'''folder-pixmap'''" || {{Yes}} || {{Yes}} || {{Yes}} || Has many uses see [[ | |||
|- | |- | ||
| <Query class="type:x-xmb/'''xmlmcutility'''" || {{Yes}} || {{Yes}} || {{Yes}} || PS1 and PS2 virtual memory card utility | | <Query class="type:x-xmb/'''xmlmcutility'''" || {{Yes}} || {{Yes}} || {{Yes}} || PS1 and PS2 virtual memory card utility | ||
Line 102: | Line 82: | ||
! Item classes x-xmb !! <key> !! <attr> !! <src> !! Remarks | ! 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 [[ | | <Item class="type:x-xmb/'''module-action'''" || {{Yes}} || {{Yes}} || {{No}} || Uses a particular module to support the XMB item. See [[VSH_module-action|VSH module-action]] page | ||
|- | |- | ||
| <Item class="type:x-xmb/'''vmc-new'''" || {{Yes}} || {{Yes}} || {{No}} || | | <Item class="type:x-xmb/'''vmc-new'''" || {{Yes}} || {{Yes}} || {{No}} || | ||
Line 109: | Line 89: | ||
|- | |- | ||
| <Item class="type:x-xmb/'''xmleditingvideo'''" || {{Yes}} || {{Yes}} || {{No}} || | | <Item class="type:x-xmb/'''xmleditingvideo'''" || {{Yes}} || {{Yes}} || {{No}} || | ||
|- | |- | ||
| <Item class="type:x-xmb/'''xmlgameexit'''" || {{Yes}} || {{No}} || {{No}} || | | <Item class="type:x-xmb/'''xmlgameexit'''" || {{Yes}} || {{No}} || {{No}} || | ||
Line 148: | Line 126: | ||
| <Item class="type:x-chat/'''xmlchatroom-manager'''" || {{Yes}} || {{Yes}} || {{No}} || | | <Item class="type:x-chat/'''xmlchatroom-manager'''" || {{Yes}} || {{Yes}} || {{No}} || | ||
|- | |- | ||
! Unkown usage classes !! <key> !! <attr> !! <src> !! Remarks | |||
|- | |- | ||
| x-xcb/'''unknown''' || ? || ? || ? || found inside explore_category_game.sprx | | x-xcb/'''unknown''' || ? || ? || ? || found inside explore_category_game.sprx | ||
|- | |- | ||
| x-xcb/'''storage-media''' || ? || ? || ? || found inside explore_category_game.sprx | | x-xcb/'''storage-media''' || ? || ? || ? || found inside explore_category_game.sprx | ||
|- | |- | ||
| x-xcb/'''game-disc''' || ? || ? || ? || found inside explore_category_game.sprx | | x-xcb/'''game-disc''' || ? || ? || ? || found inside explore_category_game.sprx | ||
Line 238: | Line 139: | ||
|- | |- | ||
| x-xcb/'''content-disc''' || ? || ? || ? || found inside explore_category_game.sprx | | x-xcb/'''content-disc''' || ? || ? || ? || found inside explore_category_game.sprx | ||
|- | |- | ||
| x-xmb/'''unknown''' || ? || ? || ? || found inside explore_category_game.sprx | | x-xmb/'''unknown''' || ? || ? || ? || found inside explore_category_game.sprx | ||
Line 276: | Line 145: | ||
|- | |- | ||
| x-ese/'''task''' || ? || ? || ? || found inside explore_category_game.sprx | | x-ese/'''task''' || ? || ? || ? || found inside explore_category_game.sprx | ||
|- | |- | ||
|} | |} | ||
*'''<key>''' | *'''<key>''' | ||
Line 320: | Line 162: | ||
**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"''' | **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 tables contents (Pair keys) ==== | ||
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>'''. | 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>'''. | ||
{| class="wikitable" style="font-size:x-small;" | {| class="wikitable" style="font-size:x-small;" | ||
|+Attributes used in official XMB, ordered by classes | |+Attributes used in official XMB, ordered by classes | ||
! <Attributes> !! colspan="28" | <Items> | ! <Attributes> !! colspan="28" | <Items> | ||
|- | |- | ||
! <Table !! colspan="12" | <Query class="type: !! colspan="16" | <Item class="type: | ! <Table !! colspan="12" | <Query class="type: !! colspan="16" | <Item class="type: | ||
Line 338: | Line 180: | ||
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | | ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | ||
| ? | | ? | ||
|- | |- | ||
| bar_action | | bar_action | ||
| {{No}} || ? || ? || {{No}} || ? || ? || ? || ? || ? | | {{No}} || ? || ? || {{No}} || ? || ? || ? || ? || ? | ||
| ? || ? || ? | | ? || ? || ? | ||
| {{Yes}} || ? || ? || ? || ? || ? || ? || {{Yes}} || ? || ? || ? || | | {{Yes}} || ? || ? || ? || ? || ? || ? || {{Yes}} || ? || ? || ? || ? || ? || ? || ? | ||
| ? | | ? | ||
|- | |- | ||
| | | cf_connection | ||
| ? || ? || ? || ? || ? || ? || ? || {{Yes}} || {{Yes}} | | ? || ? || ? || ? || ? || ? || ? || {{Yes}} || {{Yes}} | ||
| ? || ? || ? | | ? || ? || ? | ||
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | | ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | ||
| ? | | ? | ||
|- | |- | ||
| ch_pos | | ch_pos | ||
Line 366: | Line 198: | ||
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | | ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | ||
| ? | | ? | ||
|- | |- | ||
| child | | child | ||
Line 373: | Line 204: | ||
| {{No}} || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | | {{No}} || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | ||
| ? | | ? | ||
|- | |- | ||
| content_id | | content_id | ||
Line 380: | Line 210: | ||
| ? || ? || ? || ? || ? || ? || ? || ? || {{Yes}} || ? || ? || ? || ? || ? || ? | | ? || ? || ? || ? || ? || ? || ? || ? || {{Yes}} || ? || ? || ? || ? || ? || ? | ||
| ? | | ? | ||
|- | |- | ||
| content_info_pict | | content_info_pict | ||
Line 387: | Line 216: | ||
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | | ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | ||
| ? | | ? | ||
|- | |- | ||
| content_info_pict_sd | | content_info_pict_sd | ||
Line 394: | Line 222: | ||
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | | ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | ||
| ? | | ? | ||
|- | |- | ||
| content_info_tex | | content_info_tex | ||
Line 401: | Line 228: | ||
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | | ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | ||
| ? | | ? | ||
|- | |- | ||
| content_info_title | | content_info_title | ||
Line 408: | Line 234: | ||
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | | ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | ||
| ? | | ? | ||
|- | |- | ||
| content_info_title_sd | | content_info_title_sd | ||
Line 415: | Line 240: | ||
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | | ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | ||
| ? | | ? | ||
|- | |- | ||
| content_name | | content_name | ||
Line 422: | Line 246: | ||
| ? || ? || ? || ? || ? || {{Yes}} || ? || ? || {{Yes}} || ? || ? || ? || ? || ? || ? | | ? || ? || ? || ? || ? || {{Yes}} || ? || ? || {{Yes}} || ? || ? || ? || ? || ? || ? | ||
| ? | | ? | ||
|- | |- | ||
| content_type | | content_type | ||
Line 429: | Line 252: | ||
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || {{Yes}} | | ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || {{Yes}} | ||
| ? | | ? | ||
|- | |- | ||
| custom_priority | | custom_priority | ||
Line 436: | Line 258: | ||
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | | ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | ||
| ? | | ? | ||
|- | |- | ||
| data_connection | | data_connection | ||
Line 443: | Line 264: | ||
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || {{Yes}} || ? || ? | | ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || {{Yes}} || ? || ? | ||
| ? | | ? | ||
|- | |- | ||
| device_path | | device_path | ||
Line 450: | Line 270: | ||
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | | ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | ||
| ? | | ? | ||
|- | |- | ||
| fo_lbl_alpha | | fo_lbl_alpha | ||
| | | ? || ? || ? || ? || ? || ? || ? || ? || ? | ||
| ? || ? || ? | | ? || ? || ? | ||
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | | ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | ||
| ? | | ? | ||
|- | |- | ||
| fo_lbl2_alpha | | fo_lbl2_alpha | ||
Line 464: | Line 282: | ||
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | | ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | ||
| ? | | ? | ||
|- | |- | ||
| focus | | focus | ||
Line 471: | Line 288: | ||
| ? || ? || ? || ? || ? || {{Yes}} || ? || ? || {{Yes}} || ? || ? || ? || ? || ? || ? | | ? || ? || ? || ? || ? || {{Yes}} || ? || ? || {{Yes}} || ? || ? || ? || ? || ? || ? | ||
| ? | | ? | ||
|- | |- | ||
| focus_detect | | focus_detect | ||
Line 478: | Line 294: | ||
| {{Yes}} || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | | {{Yes}} || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | ||
| ? | | ? | ||
|- | |- | ||
| focus_priority | | focus_priority | ||
Line 485: | Line 300: | ||
| {{Yes}} || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | | {{Yes}} || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | ||
| ? | | ? | ||
|- | |- | ||
| fs_path | | fs_path | ||
Line 492: | Line 306: | ||
| ? || ? || ? || ? || ? || {{Yes}} || ? || ? || ? || ? || ? || ? || ? || ? || ? | | ? || ? || ? || ? || ? || {{Yes}} || ? || ? || ? || ? || ? || ? || ? || ? || ? | ||
| ? | | ? | ||
|- | |- | ||
| genre | | genre | ||
Line 499: | Line 312: | ||
| ? || ? || {{yes}} || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | | ? || ? || {{yes}} || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | ||
| ? | | ? | ||
|- | |- | ||
| icon | | icon | ||
Line 506: | Line 318: | ||
| {{Yes}} || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | | {{Yes}} || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | ||
| ? | | ? | ||
|- | |- | ||
| icon_notation | | icon_notation | ||
Line 527: | Line 324: | ||
| {{Yes}} || ? || ? || ? || ? || ? || {{Yes}} || ? || ? || ? || ? || ? || ? || {{Yes}} || ? | | {{Yes}} || ? || ? || ? || ? || ? || {{Yes}} || ? || ? || ? || ? || ? || ? || {{Yes}} || ? | ||
| {{Yes}} | | {{Yes}} | ||
|- | |- | ||
| icon_rsc | | icon_rsc | ||
Line 534: | Line 330: | ||
| {{Yes}} || ? || ? || ? || ? || ? || {{Yes}} || {{Yes}} || ? || ? || ? || ? || {{Yes}} || {{Yes}} || ? | | {{Yes}} || ? || ? || ? || ? || ? || {{Yes}} || {{Yes}} || ? || ? || ? || ? || {{Yes}} || {{Yes}} || ? | ||
| {{Yes}} | | {{Yes}} | ||
|- | |- | ||
| id | | id | ||
Line 540: | Line 335: | ||
| ? || ? || ? | | ? || ? || ? | ||
| ? || ? || ? || ? || ? || ? || ? || ? || ? || {{Yes}} || ? || ? || ? || ? || ? | | ? || ? || ? || ? || ? || ? || ? || ? || ? || {{Yes}} || ? || ? || ? || ? || ? | ||
| ? | | ? | ||
|- | |- | ||
Line 548: | Line 342: | ||
| {{Yes}} || ? || ? || ? || ? || ? || {{Yes}} || ? || {{Yes}} || ? || ? || ? || ? || ? || ? | | {{Yes}} || ? || ? || ? || ? || ? || {{Yes}} || ? || {{Yes}} || ? || ? || ? || ? || ? || ? | ||
| ? | | ? | ||
|- | |- | ||
| info_rsc | | info_rsc | ||
Line 555: | Line 348: | ||
| {{Yes}} || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | | {{Yes}} || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | ||
| ? | | ? | ||
|- | |- | ||
| ingame | | ingame | ||
Line 562: | Line 354: | ||
| {{No}} || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | | {{No}} || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | ||
| ? | | ? | ||
|- | |- | ||
| instruction_rsc | | instruction_rsc | ||
Line 569: | Line 360: | ||
| ? || ? || ? || ? || ? || ? || ? || ? || {{Yes}} || ? || ? || ? || ? || ? || ? | | ? || ? || ? || ? || ? || ? || ? || ? || {{Yes}} || ? || ? || ? || ? || ? || ? | ||
| ? | | ? | ||
|- | |- | ||
| item_type | | item_type | ||
Line 576: | Line 366: | ||
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | | ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | ||
| ? | | ? | ||
|- | |- | ||
| lbl_half | | lbl_half | ||
Line 583: | Line 372: | ||
| {{Yes}} || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | | {{Yes}} || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | ||
| ? | | ? | ||
|- | |- | ||
| logical_sceme | | logical_sceme | ||
Line 590: | Line 378: | ||
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | | ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | ||
| ? | | ? | ||
|- | |- | ||
| mass_connection | | mass_connection | ||
Line 597: | Line 384: | ||
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | | ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | ||
| ? | | ? | ||
|- | |- | ||
| mode | | mode | ||
Line 604: | Line 390: | ||
| ? || ? || {{yes}} || {{yes}} || ? || ? || ? || ? || ? || {{Yes}} || ? || ? || ? || ? || ? | | ? || ? || {{yes}} || {{yes}} || ? || ? || ? || ? || ? || {{Yes}} || ? || ? || ? || ? || ? | ||
| ? | | ? | ||
|- | |- | ||
| module_action | | module_action | ||
Line 611: | Line 396: | ||
| {{Yes}} || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | | {{Yes}} || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | ||
| ? | | ? | ||
|- | |- | ||
| module_name | | module_name | ||
Line 618: | Line 402: | ||
| {{Yes}} || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | | {{Yes}} || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | ||
| ? | | ? | ||
|- | |- | ||
| ms_connection | | ms_connection | ||
Line 625: | Line 408: | ||
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | | ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | ||
| ? | | ? | ||
|- | |- | ||
| path | | path | ||
Line 639: | Line 414: | ||
| ? || ? || ? || ? || ? || ? || ? || ? || ? || {{Yes}} || ? || ? || ? || ? || ? | | ? || ? || ? || ? || ? || ? || ? || ? || ? || {{Yes}} || ? || ? || ? || ? || ? | ||
| ? | | ? | ||
|- | |- | ||
| pkg_src | | pkg_src | ||
Line 646: | Line 420: | ||
| ? || ? || ? || ? || ? || ? || ? || ? || {{Yes}} || ? || ? || ? || ? || ? || ? | | ? || ? || ? || ? || ? || ? || ? || ? || {{Yes}} || ? || ? || ? || ? || ? || ? | ||
| ? | | ? | ||
|- | |- | ||
| pkg_src_qa | | pkg_src_qa | ||
Line 652: | Line 425: | ||
| ? || ? || ? | | ? || ? || ? | ||
| ? || ? || ? || ? || ? || ? || ? || ? || {{Yes}} || ? || ? || ? || ? || ? || ? | | ? || ? || ? || ? || ? || ? || ? || ? || {{Yes}} || ? || ? || ? || ? || ? || ? | ||
| ? | | ? | ||
|- | |- | ||
Line 660: | Line 432: | ||
| ? || ? || ? || ? || ? || {{Yes}} || ? || ? || {{Yes}} || ? || ? || ? || ? || ? || ? | | ? || ? || ? || ? || ? || {{Yes}} || ? || ? || {{Yes}} || ? || ? || ? || ? || ? || ? | ||
| ? | | ? | ||
|- | |- | ||
| sd_connection | | sd_connection | ||
Line 667: | Line 438: | ||
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | | ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | ||
| ? | | ? | ||
|- | |- | ||
| start_factory_play | | start_factory_play | ||
Line 674: | Line 444: | ||
| {{Yes}} || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | | {{Yes}} || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | ||
| ? | | ? | ||
|- | |- | ||
| str_noitem | | str_noitem | ||
Line 681: | Line 450: | ||
| {{No}} || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | | {{No}} || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | ||
| ? | | ? | ||
|- | |- | ||
| title | | title | ||
Line 688: | Line 456: | ||
| {{Yes}} || ? || ? || ? || ? || ? || ? || {{Yes}} || ? || ? || ? || ? || ? || ? || ? | | {{Yes}} || ? || ? || ? || ? || ? || ? || {{Yes}} || ? || ? || ? || ? || ? || ? || ? | ||
| ? | | ? | ||
|- | |- | ||
| title_fo | | title_fo | ||
Line 695: | Line 462: | ||
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | | ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | ||
| ? | | ? | ||
|- | |- | ||
| title_rsc | | title_rsc | ||
Line 702: | Line 468: | ||
| {{Yes}} || ? || ? || ? || ? || ? || {{Yes}} || ? || ? || ? || {{Yes}} || ? || {{Yes}} || {{Yes}} || ? | | {{Yes}} || ? || ? || ? || ? || ? || {{Yes}} || ? || ? || ? || {{Yes}} || ? || {{Yes}} || {{Yes}} || ? | ||
| {{Yes}} | | {{Yes}} | ||
|- | |- | ||
| type | | type | ||
Line 709: | Line 474: | ||
| ? || ? || ? || {{yes}} || ? || ? || ? || ? || ? || {{Yes}} || {{Yes}} || ? || ? || ? || ? | | ? || ? || ? || {{yes}} || ? || ? || ? || ? || ? || {{Yes}} || {{Yes}} || ? || ? || ? || ? | ||
| ? | | ? | ||
|- | |- | ||
| vmc | | vmc | ||
Line 716: | Line 480: | ||
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | | ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? | ||
| ? | | ? | ||
|- | |- | ||
|} | |} | ||
Line 726: | Line 489: | ||
---- | ---- | ||
'''action'''. | '''action'''. Example: "exec_game", "exec_vmcsavedata", "exec_ps3savedata", "exec_pspsavedata" | ||
'''bar_action''' Example: "none", "hide" | |||
'''cf_connection'''. Example: xcb://localhost/query?... (too long for wiki) | |||
'''ch_pos'''. Example: "1" | |||
'''child''' Use: tells the PS3 what action should be taken when the XMB item is selected. Example: "segment" | |||
'''content_id'''. Example: IP9100-NPIA00002_00-0000111122223333 | |||
'''content_info_pict'''. Example: /dev_flash/vsh/resource/explore/icon/pstex01.png | |||
'''content_info_pict_sd'''. Example: /dev_flash/vsh/resource/explore/icon/pstex-sd.png | |||
'''content_info_text'''. Example: msg_ps3_portal | |||
'''content_info_title'''. Example: msg_psstore_explanation_hd | |||
'''content_info_title_sd'''. Example: msg_psstore_explanation_sd | |||
'''content_name'''. Example: "msg_title_lwp", "msg_information_board" | |||
'''content_type'''. Example: game | |||
'''custom_priority'''. Example: "game=-80", "video=-80" | |||
'''data_connection'''. Example: xcb://localhost/query?... (too long for wiki) | |||
'''device_path'''. Example: /dev_hdd0 | |||
'''fo_lbl2_alpha'''. Example: "0" | |||
'''focus'''. Example: last | |||
'''focus_detect''' Use: 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). Example: "enable" | |||
''' | '''focus_priority''' Use: 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. Example: any integer, 0, 1, 2, 3, 4, 5, 6, -46, -47. -48, -49, -50 | ||
''' | '''fs_path'''. Example: "/dev_hdd0/widget/npdrm/informationboard" | ||
''' | '''genre'''. Example: BdData | ||
'''icon''' | '''icon''' Use: displays a .png image from an absolute path as XMB icon. Cannot be used at the same time as 'icon_rsc'. Example: "/dev_hdd0/myicon.png" | ||
'''icon_notation''' | '''icon_notation''' Use: 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'. Example: "WNT_XmbItemSavePS3" <!--// doesnt seems correct, the transparency effect and the override of other "pair keys" values looks a consequence of the load of some specific settings associated with every "icon notation" //--> | ||
{| class="wikitable" | {| class="wikitable" | ||
| | |- | ||
! icon_notation !! Use !! Notes | ! icon_notation !! Use !! Notes | ||
|- | |- | ||
Line 816: | Line 599: | ||
|} | |} | ||
'''icon_rsc'''. | '''icon_rsc''' Use: displays a .rco referable image as XMB icon. Cannot be used at the same time as 'icon'. Example: "tex_album_icon" | ||
'''id'''. Example: | |||
'''info''' Use: 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'. Example: "This is a cool plain text info string", "net_package_install_with_eula" | |||
'''info_rsc''' Use: 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'. Example: "item_tex_cam_icon" | |||
'''ingame''' Use: tells the PS3 if the item can be accessed ingame. Example: "enable"/"disable" | |||
'''instruction_rsc'''. Example: msg_lwp_explanation | |||
'''item_type'''. Example: "systop" | |||
'''lbl_half''' Example: "1" | |||
'''logical_sceme'''. Example: Music, Photo, Video | |||
'''mass_connection'''. Example: xcb://localhost/query?... (too long for wiki) | |||
'''mode'''. Example: mgmt, playlistmgmt, playlistmgmtpsp, playlistempty | |||
'''module_action''' Use: what the module is commanded to use. The example commands are in respect the above modules. Example: "http://m.facebook.com"/"NotifyErrorNoExecute" | |||
'''module_name''' Use: the name of the module to be used from this [[VSH Module-Action|list]]. Example: "webbrowser_plugin"/"explore_plugin" | |||
'''ms_connection'''. Example: xcb://localhost/query?... (too long for wiki) | |||
''' | '''path'''. Example: | ||
''' | '''pkg_src'''. Example: http://dL-REGION01.ps3.download.playstation.net/download/ps3/L-REGION/lwp/lwp.pkg | ||
'''prod_pict_path'''. Example: "/dev_flash/vsh/resource/explore/icon/fah-xmb.png", "/dev_hdd0/widget/npdrm/informationboard/Icon.png" | |||
'''sd_connection'''. Example: xcb://localhost/query?... (too long for wiki) | |||
'''start_factor_play'''. Example: disable | |||
'''str_noitem''' Use: displays information from relevant .rco when no data/XMB items are found from then search function of the current XMB item. Example: "msg_error_no_gamedata" | |||
'''title''' Use: displays XMB main title from plain text input. Cannot be used at the same time as 'title_rsc'. Example: "Debug Settings" | |||
'''title_fo'''. Example: 1 | |||
'''title_rsc''' Use: displays XMB main title text referred from relevant .rco. Cannot be used at the same time as 'title'. Example: "msg_tool_app_home_ps3_game" | |||
'''type'''. Example: photo, music, video | |||
'''vmc'''. Example: promote | |||
== Examples == | |||
=== An XMB item tree === | |||
For this we will make a XMB item which will act as a folder opening up into 3 other XMB items. | |||
1/ First create the root XMB item which acts as a folder | |||
{{Boxcode|content=<syntaxhighlight lang="xml"> | |||
<View id="XMB_Folder_1"> | |||
<Attributes> | |||
<Table key="xmb_folder"> | |||
<Pair key="icon_rsc"><String>tex_album_icon</String></Pair> | |||
<Pair key="title"><String>XMB Menu Item</String></Pair> | |||
<Pair key="info"><String>This will subdivide into 3 items :)</String></Pair> | |||
<Pair key="child"><String>segment</String></Pair> | |||
</Table> | |||
</Attributes> | |||
<Items> | |||
<Query class="type:x-xmb/folder-pixmap" key="xmb_folder" attr="xmb_folder" src="#XMB_Folder_1_container" /> | |||
</Items> | |||
</View> | |||
</syntaxhighlight>}} | |||
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 'attr' 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. | |||
* the 'src' is pointing to 'XMB_Folder_1_container' - 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 | |||
* '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 "container" (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): | ||
{{Boxcode|content=<syntaxhighlight lang="xml"> | |||
{| | <View id="XMB_Folder_1_container"> | ||
<Items> | |||
<Query class="type:x-xmb/folder-pixmap" key="xmb_folder_container" src="#XMB_Folder_1_contents" /> | |||
</Items> | |||
</View> | |||
</syntaxhighlight>}} | |||
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: | |||
{{Boxcode|content=<syntaxhighlight lang="xml"> | |||
<View id="XMB_Folder_1_contents"> | |||
<Attributes> | |||
<Table key="xmb_subitem_1"> | |||
<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> | |||
</syntaxhighlight>}} | |||
'' | 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 <attr> from the <Items> sub entries matches 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 | |||
=== A Web-Site 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 '[[VSH:Module-Action|module-action]]' function. Example: | |||
{{Boxcode|content=<syntaxhighlight lang="xml"> | |||
<View id="seg_xmb_weblink"> | |||
<Attributes> | |||
<Table key="link_1"> | |||
<Pair key="icon_rsc"><String>dev_wiki_icon</String></Pair> | |||
<Pair key="title"><String>PS3 Dev Wiki</String></Pair> | |||
<Pair key="info"><String>Some info here</String></Pair> | |||
<Pair key="module_name"><String>webbrowser_plugin</String></Pair> | |||
<Pair key="module_action"><String>http://www.ps3devwiki.com/</String></Pair> | |||
</Table> | |||
</Attributes> | |||
<Items> | |||
<Item class="type:x-xmb/module-action" key="link_1" attr="link_1"/> | |||
</Items> | |||
</View> | |||
</syntaxhighlight>}} | |||
*Important Notes: | |||
The | **The 'Attributes' for this Web-Link follows the Attribute rules for a 'module-action' entry. | ||
**The 'webbrowser_plugin' module has been used to handle the request in the 'module_action' pair key, which is a web address | |||
**The 'attr' in the Items sub-entry is the same as the table key in the 'Attributes' sub-entry. | |||
**Remember that the icon_rsc string will search the rco file(used by the module running the category which this web link is on) for the icon 'dev_wiki_icon'. Whereas the title and info strings will just print the contents of the string. | |||
{{ | {{System Firmware}}<noinclude>[[Category:Main]]</noinclude> |