Editing XMB

Jump to navigation Jump to search
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

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:
{| class="wikitable" style="margin:auto"
|+ Read [http://manuals.playstation.net/document/en/ps3/current/ manuals.playstation.net/document] and [http://us.playstation.com/support/manuals/ps3/index.htm us.playstation.com/support/manuals]
! {{icon category users}}<BR />[http://manuals.playstation.net/document/en/ps3/current/users/index.html Users] !! {{icon category settings}}<BR />[http://manuals.playstation.net/document/en/ps3/current/settings/index.html Settings] !! {{icon category photo}}<BR />[http://manuals.playstation.net/document/en/ps3/current/photo/index.html Photo] !! {{icon category music}}<BR />[http://manuals.playstation.net/document/en/ps3/current/music/index.html Music] !! {{icon category video}}<BR />[http://manuals.playstation.net/document/en/ps3/current/video/index.html Video] !! {{icon category tv}}<BR />[http://manuals.playstation.net/document/en/ps3/current/tv/tvvideoservices.html TV/Video Services] !! {{icon category game}}<BR />[http://manuals.playstation.net/document/en/ps3/current/game/index.html Game] !! {{icon category network}}<BR />[http://manuals.playstation.net/document/en/ps3/current/network/index.html Network] !! {{icon category psn}}<BR />[http://manuals.playstation.net/document/en/ps3/current/psn/index.html PlayStation Network] !! {{icon category friends}}<BR />[http://manuals.playstation.net/document/en/ps3/current/friends/index.html Friends]
|-
|}
<div style="float:right">[[File:Tex_classic_theme.png|200px|thumb|left|XMB Classic theme]]</div>
=Description=
=Description=
The Xross Media Bar (pronounced "Cross Media Bar") (or [[XMB]]) is the graphical user interface for the PS3
The Xross Media Bar (XMB) is the graphical user interface for the PS3
 
The first Sony product with a XMB interface was the "Sony PSX" in 2003 (A hybrid of a PS2 + DVR player with recorder capabilityes only released in japan, see: [http://www.psx.sony.co.jp/ PSX sony.co.jp] and [http://en.wikipedia.org/wiki/PSX_%28DVR%29 Wikipedia PSX]), later was used by the PSP, then PS3 and some Bravia TV's
 
The word "Xross" (the "X" itself) is a reference to the alignment of the icons in rows and columns, each column is a category
 
[[System_Software| System Software]] can be updated from the XMB settings by using an [[Playstation_Update_Package_%28PUP%29| .PUP file]]
Installable Content (games or apps in [[PKG_files| .pkg]] format, and a few
[[Emulation#PS2_System_Data_.28PSN_HDD_Tool_package.29 | PS2 Discs]]), and contents in [[PS3_DISC.SFB|PS3 Discs]], are "preloaded" by XMB using an small file (see: [[PARAM.SFO]]) this file is indexed in a database for efficiency purposes and fast access (see: [[XMB_database|XMB Database]]) and contains an identifyer that belongs to an specific XMB column (see: [[PARAM.SFO#CATEGORY|CATEGORY]])
 
The dynamic wave on the background [[PlayStation 3 Theme (P3T)|theme]] are more condensed into a 'ribbon' rather than the PSP's large waves, unselected icons shrink slightly and every selectable background color has been made a shade darker.
 
The PS3 includes the ability to store various master and secondary user profiles, manage and explore various photos format([[Talk:Content_Information_Files |.MPO since FW 3.70]]) with Photo Gallery or an ordinary musical/non-musical slideshow, rip audio CDs, rip iTunes AAC protected files, play and copy music and video files from the [[Harddrive| hard disk drive]], an optional USB mass storage or Flash card, or an optical disc ([[Bluray_Drive |Blu-ray Disc]] or DVD-Video).
 
Web browser, also supported with [[Keyboard |USB or BlueTooth keyboard]], can download multiple file types but with some restrictions. [[PARAM.SFO#CATEGORY |Shortcut]] for launching website is also possible from TV/VIDEO collumn.
 
Since FW 4.30, [[Trophy_files |trophies]] have been moved to the PlayStation Network category, in which Online shopping through the PlayStation Store is possible.
 
The Friends menu allows email with emoticons and attached picture features and video chat which requires an optional webcam (although the PlayStation Eye and the EyeToy are official webcams, most USB webcams will work).


The PS3 reserves 48 MB of RAM at all times for XMB functions, multi-task in ways such as listening to stored audio files while surfing the web, looking at pictures or [[PARAM.SFO#ATTRIBUTE_In_Bootable_content |playing games]].
The first Sony product with a XMB interface was the "Sony PSX" in 2003 (an hybrid of a PS2 + DVR player with recorder capabilityes only released in japan, see: [[http://en.wikipedia.org/wiki/PSX_%28DVR%29 Wikipedia PSX]] [[http://www.psx.sony.co.jp/ PSX sony.co.jp]], later was used by the PSP, then PS3 and some Bravia TV's


The word "Xross" (actually the "X" itself) is a reference to the order of the icons aligned in rows and columns, each of this columns in a category: '''Users''', '''Settings''', '''Photo''', '''Music''', '''Video''', '''TV/Video Services''', '''Game''', '''Network''', '''PlayStation Network''', and '''Friends'''.


The XMB by default changes its color depending on the current month of the year and brightness depending on the time of the day (only in original and classic [[PlayStation 3 Theme (P3T)|Themes]]). XMB color can be configured to "default" (changes every month) or one of the 12 color preconfigured for months, in XMB Settings column ---> Theme settings ---> Color
Installable Content (games or apps in .pkg format) can be placed in some of this columns, for this purpose each column has an identifyer made with 2 letters, see [[PARAM.SFO#CATEGORY|CATEGORY]]


This change of color affects background, waves, all the icons, and other images like the "side menu". The color is applyed to the originall images like a "color filter" layer over them (note originall icons are semitransparent white to improve this effect)


The background images changes acordingly with the month. The file '''lines.qrc''' contains 24 '''textures_month_bg_*.dds''' images of 64x32 pixels. Each day has 2 different images for "day" and "night". See [[Qt Resource Container (QRC)]]
The dynamic lines on the background are more condensed into a 'ribbon' rather than the PSP's large waves, unselected icons shrink slightly and every selectable background color has been made a shade darker.  
The PS3 includes the ability to store various master and secondary user profiles, manage and explore photos with Photo Gallery or an ordinary musical/non-musical slideshow, rip audio CDs, rip iTunes AAC protected files, play music and copy tracks to an attached storage device, play movies and video files from the hard disk drive, an optional USB mass storage or Flash card, or an optical disc (Blu-ray Disc or DVD-Video).


The color filter and brignhness values in this tables are not the exact values, is unknown how this filters are applyed, where are stored, and how works, see [[Talk:XMB]] for speculations
It also has compatibility for a USB or BlueTooth keyboard & mouse which can be used for navigate on the xmb or navigate to the web browser. It can be use also for homebrew such as MultiMan (since 1.11.01) or even launch a BD game. Unreal III is the rare example of this feature.
{{XMB colors}}


{{XMB brightness}}
Web browser can download multiple file types but with somes restrictions set by the type of the files or web site.
The Friends menu allows email with emoticons and attached picture features and video chat which requires an optional webcam (although the PlayStation Eye and the EyeToy are official webcams, most USB webcams will work).
The PlayStation Network menu allows online shopping through the PlayStation Store. Also, the PlayStation 3 adds the ability to multitask in ways such as listening to stored audio files while surfing the web or looking at pictures. The PlayStation 3 XMB supports a variety of file formats. The PS3 reserves 48 MB of RAM at all times for XMB functions.


=Virtual Shell (VSH)=
=[[VSH]]=
The [[VSH|Virtual Shell]] encapsulates the XMB interface. It is loaded at: '''/dev_flash/vsh/module/vsh.self'''
The [[VSH|Virtual Shell (VSH]]) encapsulates the XMB interface. It is loaded at:
 
/dev_flash/vsh/module/vsh.self
And has numerous modules and descriptor files. The VSH does not directly load the XMB interface, it loads support modules to do that instead. The modules directly responsible for the XMB interface are in '''/dev_flash/vsh/module/''' and include:
And has numerous modules and descriptor files. The VSH does not directly load the XMB interface, it loads support modules to do that instead. The modules directly responsible for the XMB interface include:
/dev_flash/vsh/module/
  explore_category_friend.sprx
  explore_category_friend.sprx
  explore_category_game.sprx
  explore_category_game.sprx
Line 56: Line 33:
  explore_category_user.sprx
  explore_category_user.sprx
  explore_category_video.sprx
  explore_category_video.sprx
  explore_plugin.sprx
  explore_plugin.sprx
  explore_plugin_ft.sprx
  explore_plugin_ft.sprx
  explore_plugin_game.sprx
  explore_plugin_game.sprx
  explore_plugin_np.sprx
  explore_plugin_np.sprx
Those modules are responsible for processing the XMB descriptor files (.XML format), used to generate the XMB interface. All of the above modules except for the "explore_plugin_game.sprx" and "explore_plugin_np.sprx" contain a full list and location of XMB configuration files and the "root" entry which is to be loaded for the root of the category, for each FW type CEX/SEX/DEX. Exactly which root XML entry is used depends on the FW type (CEX/SEX/DEX) of the VSH.self. It's important to note that the explore_plugin.sprx is capable of managing many of the XMB categories, and thus, not all of these modules might be in use at any one time. (The explore_plugin.sprx is actually kept available to the VSH.self and other modules through the xmb_plugin.sprx and xmb_ingame.sprx see [[XMB XML Coding#Module-Action|Module Action]])


== VSH Modules ==
=XMB Configuration Files=
All the .sprx files inside '''/dev_flash/vsh/module/'''. See: [[Plugin Interfaces]] page


Those modules are responsible for processing the XMB descriptor files (.XML format) used to generate the XMB interface. All of the above modules except for "'''explore_plugin_game.sprx'''" and "'''explore_plugin_np.sprx'''" contains a full list and location of XMB configuration files and the "root" entry which is to be loaded for the root of the category for each firmware type (CEX/CEX-Shop/DEX/ARC/TOOL).
These are .XML files which outline the logic of XMB categories. For information on the structure of the files, see [[XMB XML Coding]]. All of the XMB .XML configuration files are located in path: '''/dev_flash/vsh/resource/explore/xmb/'''


It's important to note that '''explore_plugin.sprx''' is capable of managing most of the XMB categories, and thus, not all of these modules might be in use at any time. The '''explore_plugin.sprx''' is actually available to '''vsh.self''' and other modules through the '''xmb_plugin.sprx''' and '''xmb_ingame.sprx''' See [[XMBML module-action]]
{| class="wikitable"
|-
! rowspan="3" | XMB Category !! colspan="2" | Retail XMB (CEX) !! colspan="2" | Debug XMB (DEX) !! colspan="4" | Shop XMB (SEX)
|-
! rowspan="2" | <filename>.xml !! rowspan="2" | <abbr title="View id (inside .xml file)">View id</abbr> !! rowspan="2" | <filename>.xml !! rowspan="2" | <abbr title="View id (inside .xml file)">View id</abbr> !! colspan="2" style="background-color:#CC5555;" | Demo Mode !! colspan="2" style="background-color:#55CC55;" | Unlocked Mode
|-
! <filename>.xml !! <abbr title="View id (inside .xml file)">View id</abbr> !! <filename>.xml !! <abbr title="View id (inside .xml file)">View id</abbr>
|-
| [[XMB-Users‎|Users]] || category_user.xml || root || category_user.xml || root || category_user_shop.xml || root || category_user.xml || root
|-
| [[XMB-Settings|Settings<sup>1</sup>]] || category_sysconf.xml || root || category_sysconf.xml || root || category_sysconf_shop.xml || root || category_sysconf.xml || root
|-
| [[XMB-Photo|Photo]] || category_photo.xml || root || category_photo.xml || root || category_photo.xml || shop_root || category_photo.xml || root
|-
| [[XMB-Music|Music]] || category_music.xml || root || category_music.xml || root_for_dex || category_music.xml || root || category_music.xml || root
|-
| [[XMB-Video|Video]] || category_video.xml || root || category_video.xml || root_for_dex || category_video.xml || root || category_video.xml || root
|-
| [[XMB-TV|TV/Video Services]] || category_tv.xml || root || category_tv.xml || root || category_tv.xml || root || category_tv.xml || root
|-
| [[XMB-Game|Game]] || category_game.xml || root || category_game_tool2.xml || root_dex || category_game.xml || shop_guest_root || category_game.xml || root
|-
| [[XMB-Network|Network]] || category_network.xml || root || category_network_tool2.xml || root || category_network_shop.xml || root || category_network_shop.xml || shop_staff_root
|-
| [[XMB-PSN|PlayStation Network]] || category_psn.xml || root || category_psn.xml || tool_root || category_psn.xml || shop_guest_root || category_psn.xml || shop_staff_root
|-
| [[XMB-Friends|Friends]] || category_friend.xml || root || category_friend.xml || root || category_friend_shop.xml || root || category_friend.xml || root
|-
|}


== Modules Resources ==
*<sup>1</sup>The VSH heavily regulates the Setting Category and the .XML file is only used by when accessing the XMB "in-game", even then it restricts what parts of the .XML are actually shown. It is not possible to modify the Settings Category to any effect by editing the .XML configuration file
All the .rco files inside '''/dev_flash/vsh/resource/'''. See: [[Resource Container (RCO)]] page


=== RCOXML Configuration Files===
*This table is not inclusive of other PS3 firmwares, but their root entries are present in all PS3 Firmwares. All PS3 Firmwares (CEX/DEX/SEX/...) contain the *same* XML configuration files for any given firmware version.
These are XML files which defines the visual structure of XMB, are embedded inside all .rco files. See: [[RCOXML Coding]] page


There are 2 modes used by XMB: "XMB Main" and "XMB In-game", and other modes that replaces XMB like the "Coldboot", "Gameboot", or "Impose"
==Other XMB Configuration Files==


====XMB Main ([[xmb plugin]])====
These are XMB Configuration Files which are used in the 'behind the scenes' of running the XMB.
The XrossMediaBar after the coldboot, with full functions of all the items/icons displayed


*Managed by: xmb_plugin.sprx / xmb_plugin_normal.rco
{| class="wikitable"
|-
! Configuration File !! Directly Dependent Modules !! Module Use
|-
| category_user_login.xml || Found in all "explore_*.sprx" modules, except "explore_plugin_game.sprx" and "explore_plugin_np.sprx" || XMB Configuration File for the 'Log In' XMB Category, which only shows when no user is logged in.
|-
| category_widget.xml || - || RSS Related
|-
| download_list.xml || data_copy_plugin.sprx, download_plugin.sprx, friendim_plugin.sprx, photolist_plugin.sprx, playlist_plugin.sprx, scenefolder_plugin.sprx, sysconf_plugin.sprx, videodownloader_plugin.sprx, webbrowser_plugin.sprx, webrender_plugin.sprx || Used For the Download of Photos/Music/Video to various external and internal locations.
|-
| null.xml || Found in all "explore_*.sprx" modules || Dummy File/Testing Purposes?
|-
| playlist.xml || filecopy_plugin.sprx, playlist_plugin.sprx || Creating Playlists
|-
| registry.xml || - || Used for the organisation of User Data which is accessible from the XMB
|-
| savedata_list.xml || ps3_savedata_plugin.sprx, ps3_savedata_plugin_game.sprx, ps3_savedata_plugin_psp.sprx || Outlines the XMB entries for creating new saves, for both PSP and PS3 games.
|-
| upload_list.xml || - || Photo/Music/Video Locations for Upload
|-
| videodownloader_list.xml || videodownloader_plugin.sprx || For downloading videos, to both 'secure' and 'not secure' locations. USB Mass Storage devices are not included in either.
|-
|}


====XMB In-Game ([[xmb ingame]])====
=Sony Documentation=
Introduced in firmware 2.40, available inside games by a '''short''' press of {{padps}} button


Is a reduced version of the XrossMediaBar where most of the icons are "dummies" that triggers a message like: "to use this function you need to quit the game and return to Main XMB, want to quit?". <!-- lol, needed to find the exact error message --> The only items that are really enabled are the ones usefull to use inside games, like savegames view, trophies view, gamedata view, friends, chat, etc...
http://us.playstation.com/support/manuals/ps3/index.htm


There are also some icons, options, or settings that only can appear in this mode (never displayed "XMB Main" mode)... like screenshots icon in the photo colum (when enabled), or some settings specific for emulators (in settings column, things like resolution, filters, etc...)
{| class="wikitable" border="0" cellspacing="1" cellpadding="2"
 
|-
*Managed by: xmb_ingame.sprx / xmb_ingame.rco
|[http://manuals.playstation.net/document/en/ps3/current/basicoperations/index.html About the XMB (XrossMediaBar) menu]
 
|-
*Note XMB In-Game is inneficient in concept, because displays items that are dummies not needed and cant be used, in some games the loading of XMB In-Game is laggy (specially the loading of savegames and trophies submenues)
|[http://manuals.playstation.net/document/en/ps3/current/users/index.html Users Category]
 
|-
*http://www.blogcdn.com/www.engadget.com/media/2008/06/ps3-ingame-xmb-2.40-clock.jpg
|[http://manuals.playstation.net/document/en/ps3/current/settings/index.html Settings Category]
*http://www.viddler.com/simple/1ffb1ce3/
|-
 
|[http://manuals.playstation.net/document/en/ps3/current/photo/index.html Photo Category]
====Impose Menu ([[impose plugin]])====
|-
Available in "Main XMB" and inside games by a '''short''' press (under 2.40 firmware) or '''long''' press (over 2.40 firmware) of {{padps}} button
|[http://manuals.playstation.net/document/en/ps3/current/music/index.html Music Category]
 
|-
Allows to asign controllers to players, view battery levels of controllers, quit game, etc... http://www.blogcdn.com/www.joystiq.com/media/2008/01/ps3-in-game-menu.jpg
|[http://manuals.playstation.net/document/en/ps3/current/video/index.html Video Category]
 
|-
*Managed by: impose_plugin.sprx / impose_plugin.rco
|[http://manuals.playstation.net/document/en/ps3/current/tv/tvvideoservices.html TV / Video Services Category]
 
|-
====ColdBoot ([[custom render plugin]])====
|[http://manuals.playstation.net/document/en/ps3/current/game/index.html Game Category]
The old animation when PS3 boots (from 1.00 up to 2.60 firmware)
|-
 
|[http://manuals.playstation.net/document/en/ps3/current/network/index.html Network Category]
*Managed by: custom_render_plugin.sprx / custom_render_plugin.rco
|-
 
|[http://manuals.playstation.net/document/en/ps3/current/psn/index.html PlayStation Network Category]
====ColdBoot2 ([[custom render plugin]])====
|-
The new animation when PS3 boots (from 2.70 up to {{latestPS3}} firmware) , associated with [[coldboot.raf]]
|[http://manuals.playstation.net/document/en/ps3/current/friends/index.html Friends Category]
 
|}
*Managed by: custom_render_plugin.sprx / custom_render_plugin.rco
{{Console}}
 
====GameBoot ([[custom render plugin]])====
The animation when a game boots
 
*Managed by: custom_render_plugin.sprx / custom_render_plugin.rco
 
====OtherBoot ([[custom render plugin]])====
Unknown, seems associated with OtherOS
 
*Managed by: custom_render_plugin.sprx / custom_render_plugin.rco
 
===Languages===
Language files are stored inside [[Resource Container (RCO)]] files, are loaded based on a user setting stored in [[XRegistry.sys]]
 
XMB can be configured to display the texts in several languages, and every language uses a language code internally to identify it, this same language codes are used in contents that contains several languages availabes (like games, trophy installers, themes, etc...).
 
See: [[Languages]] page
{{PlayStation Languages}}
 
==Fonts==
All the .ttf files in '''dev_flash/data/font/ '''
 
The fonts are loaded by the rcoxml files (rcoxml files contains font definitions like color, sizes, type, etc...) and based on a user setting stored in [[XRegistry.sys]]
 
Font can be configured in XMB -> settings -> Theme to "original", "rounded", and "pop". See: [[XMB Fonts]] page
 
==XMBML Configuration Files==
Are the configuration files for the modules responsibles of the contents in the 10 XMB categories, loaded individually by the associated '''dev_flash/vsh/module/explore_category_*.sprx''' module
 
All the XMBML configuration files are included in all firmwares for all PS3 models, and are located in path: '''/dev_flash/vsh/resource/explore/xmb/'''
 
For more information about the structure of this files see: [[XMBML Files]], [[XMBML Coding]], [[XMBML Functions]] and [[XMBML Coding Examples]]
 
<div style="height:525px; width:1300px; margin:auto; overflow:auto">{{PS3 XMBML Configuration Files}}</div>
 
== XMB Layouts ==
This files contains a list of numeric values that defines the positions, sizes, etc of most/all the items displayed in XMB. They're divided into 4 resolution modes, most specifically by these heights: (272, 480, 720, and 1080), and 2 types: (factor, and grid).
 
For more info about this files see: [[XMB Layouts]] page.
 
{{XMB Layout Tables}}
 
{{Firmware}}<noinclude>[[Category:Main]]</noinclude>
Please note that all contributions to PS3 Developer wiki are considered to be released under the GNU Free Documentation License 1.2 (see PS3 Developer wiki:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!

To protect the wiki against automated edit spam, we kindly ask you to solve the following hCaptcha:

Cancel Editing help (opens in new window)

Templates used on this page:

Retrieved from "http://www.psdevwiki.com/ps3/XMB"