XMBML Coding

This page will outline the logic behind XMB .xml configuration files.

Basic Structure

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"

Code Sample

• 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="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_for_dex", "root_for_BDU", "tool_root", "shop_root", "shop_guest_root", "shop_staff_root", "root_arcade"
  • 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
  • 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")

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.

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/folder-pixmap"	Yes	Opt	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/xmlpackagefolder"	Yes	No	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
<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 VSH 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/xmlgameexit"	Yes	No	No
<Item class="type:x-xmb/xmlhakoniwa"	Yes	Yes	No
<Item class="type:x-xmb/xmliboard"	Yes	Yes	No	Used in Widgets (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

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

Usable attributes by classes

<Pair key>	Query class												Item class
	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	game exit	hako niwa	info board	msg list	now playing	np signup	play list	plus	power off	psp remote	vita apps	screen shot	sys conf	trophy	browser	welcome	chat room
action	Yes	Yes	?	?	?	?	?	Yes	Yes	?	?	?	?	?	?	?	?	?	?	?	?	?	?	No	No	No	?	No	?	?	?	?	?
bar_action	No	?	?	No	?	?	?	?	?	?	?	?	Yes	?	?	?	?	?	?	?	Yes	?	?	No	No	No	?	No	?	?	?	?	?
cf_connection	?	?	?	?	?	?	?	Yes	Yes	?	?	?	?	?	?	?	?	?	?	?	?	?	?	No	No	No	?	No	?	?	?	?	?
ch_pos	Yes	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	No	No	No	?	No	?	?	?	?	?
child	Yes	?	?	Yes	?	?	?	?	?	?	?	?	No	?	?	?	?	?	?	?	?	?	?	No	No	No	?	No	?	?	?	?	?
content_id	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	Yes	?	No	No	No	?	No	?	?	?	?	?
content_info_pict	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	No	No	No	?	No	?	?	?	?	?
content_info_pict_sd	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	No	No	No	?	No	?	?	?	?	?
content_info_tex	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	No	No	No	?	No	?	?	?	?	?
content_info_title	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	No	No	No	?	No	?	?	?	?	?
content_info_title_sd	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	No	No	No	?	No	?	?	?	?	?
content_name	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	Yes	?	?	Yes	?	No	No	No	?	No	?	?	?	?	?
content_type	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	No	No	No	?	No	?	?	?	Yes	?
custom_priority	Yes	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	No	No	No	?	No	?	?	?	?	?
data_connection	?	?	?	?	?	?	?	Yes	Yes	?	?	?	?	?	?	?	?	?	?	?	?	?	?	No	No	No	?	No	?	Yes	?	?	?
fo_lbl2_alpha	Yes	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	No	No	No	?	No	?	?	?	?	?
focus	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	Yes	?	?	Yes	?	No	No	No	?	No	?	?	?	?	?
focus_detect	Yes	?	?	Yes	?	?	?	?	?	?	?	?	Yes	?	?	?	?	?	?	?	?	?	?	No	No	No	?	No	?	?	?	?	?
focus_priority	Yes	?	?	Yes	?	?	?	?	?	?	?	?	Yes	?	?	?	?	?	?	?	?	?	?	No	No	No	?	No	?	?	?	?	?
fs_path	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	Yes	?	?	?	?	No	No	No	?	No	?	?	?	?	?
icon	Yes	?	?	Yes	?	?	?	?	?	?	?	?	Yes	?	?	?	?	?	?	?	?	?	?	No	No	No	?	No	?	?	?	?	?
icon_notation	Yes	?	?	Yes	?	?	?	?	?	?	?	?	Yes	?	?	?	?	?	?	Yes	?	?	?	No	No	No	?	No	?	?	Yes	?	Yes
icon_rsc	Yes	?	?	Yes	?	?	?	?	?	?	?	?	Yes	?	?	?	?	?	?	Yes	Yes	?	?	No	No	No	?	No	?	Yes	Yes	?	Yes
id	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	Yes	No	No	No	?	No	?	?	?	?	?
info	Yes	?	?	Yes	?	?	?	?	?	?	?	?	Yes	?	?	?	?	?	?	Yes	?	Yes	?	No	No	No	?	No	?	?	?	?	?
info_rsc	Yes	?	?	Yes	?	?	?	?	?	?	?	?	Yes	?	?	?	?	?	?	?	?	?	?	No	No	No	?	No	?	?	?	?	?
ingame	Yes	?	?	Yes	?	?	?	?	?	?	?	?	No	?	?	?	?	?	?	?	?	?	?	No	No	No	?	No	?	?	?	?	?
instruction_rsc	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	Yes	?	No	No	No	?	No	?	?	?	?	?
item_type	Yes	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	No	No	No	?	No	?	?	?	?	?
lbl_half	No	?	?	No	?	?	?	?	?	?	?	?	Yes	?	?	?	?	?	?	?	?	?	?	No	No	No	?	No	?	?	?	?	?
mass_connection	?	?	?	?	?	?	?	Yes	Yes	?	?	?	?	?	?	?	?	?	?	?	?	?	?	No	No	No	?	No	?	?	?	?	?
mode	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	Yes	No	No	No	?	No	?	?	?	?	?
module_action	No	?	?	No	?	?	?	?	?	?	?	?	Yes	?	?	?	?	?	?	?	?	?	?	No	No	No	?	No	?	?	?	?	?
module_name	No	?	?	No	?	?	?	?	?	?	?	?	Yes	?	?	?	?	?	?	?	?	?	?	No	No	No	?	No	?	?	?	?	?
ms_connection	?	?	?	?	?	?	?	Yes	Yes	?	?	?	?	?	?	?	?	?	?	?	?	?	?	No	No	No	?	No	?	?	?	?	?
path	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	Yes	No	No	No	?	No	?	?	?	?	?
pkg_src	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	Yes	?	No	No	No	?	No	?	?	?	?	?
pkg_src_qa	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	Yes	?	No	No	No	?	No	?	?	?	?	?
prod_pic_path	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	Yes	?	?	Yes	?	No	No	No	?	No	?	?	?	?	?
sd_connection	?	?	?	?	?	?	?	Yes	Yes	?	?	?	?	?	?	?	?	?	?	?	?	?	?	No	No	No	?	No	?	?	?	?	?
start_factory_play	?	?	?	?	?	?	?	?	?	?	?	?	Yes	?	?	?	?	?	?	?	?	?	?	No	No	No	?	No	?	?	?	?	?
str_noitem	Yes	?	?	No	?	?	?	?	?	?	?	?	No	?	?	?	?	?	?	?	?	?	?	No	No	No	?	No	?	?	?	?	?
title	Yes	?	?	Yes	?	?	?	?	?	?	?	?	Yes	?	?	?	?	?	?	?	Yes	?	?	No	No	No	?	No	?	?	?	?	?
title_fo	Yes	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	No	No	No	?	No	?	?	?	?	?
title_rsc	Yes	?	?	Yes	?	?	?	?	?	?	?	?	Yes	?	?	?	?	?	?	Yes	?	?	?	No	No	No	Yes	No	?	Yes	Yes	?	Yes
type	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	Yes	No	No	No	Yes	No	?	?	?	?	?
vmc	?	Yes	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	?	No	No	No	?	No	?	?	?	?	?

action. Example: "exec_game", "exec_vmcsavedata", "exec_ps3savedata", "exec_pspsavedata"

bar_action Example: "none"

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)

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

fs_path. Example: "/dev_hdd0/widget/npdrm/informationboard"

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 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"

icon_notation	Use	Notes
WNT_XmbItemAlbum
WNT_XmbItemBrowser
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
WNT_XmbItemPlaylistAdd
WNT_XmbItemPowerOff
WNT_XmbItemSavePS12
WNT_XmbItemSavePS3
WNT_XmbItemSavedataMinis
WNT_XmbItemTrophy
WNT_XmbItemUser
WNT_XmbItemVideoNew
WNT_XmbListMusic
WNT_XmbListPhoto
WNT_XmbListVideo

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"

mass_connection. Example: xcb://localhost/query?... (too long for wiki)

mode. Example: playlistmgmt

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 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"

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

Code Sample

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):

Code Sample

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:

Code Sample

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 'module-action' function. Example:

Code Sample

• Important Notes:
  • 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.