XMBML module-action: Difference between revisions

From PS3 Developer wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
 
(27 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[[Category:Software]]
= Description =
This is an XMB command, typically this is utilised with the [[XMB XML Coding|XML code]] below:
'''module-action''' is an [[XMBML Coding|XMBML]] command that works like a module (.sprx file) intercom, allowing XMBML files to use/send commands to a selected module, so it can perform functions outside the limits of the module managing that XMB Category.
{{Boxcode|content=<syntaxhighlight lang="xml">
 
<View id="Entry_1">
The list of usable modules is indexed in '''xmb_plugin.sprx''' (modules availables in main XMB) and '''xmb_ingame.sprx''' (modules availables in in-game XMB) and contains the module reference, the path to the module (.sprx file), and the path to the associated resource (.rco file).
<Attributes>
 
<Table key="XMB_MODULE">
All the .sprx modules are stored in path: '''/dev_flash/vsh/module/''' and the .rco resource files in path: '''/dev_flash/vsh/resource/'''
<Pair key="icon"><String>a valid entry for this pair key</String></Pair>
 
<Pair key="title"><String>a valid entry for this pair key</String></Pair>
{{XMB_Indexed_Modules}}
<Pair key="info"><String>a valid entry for this pair key</String></Pair>
 
<Pair key="module_name"><String>a valid entry for this pair key</String></Pair>
= Common uses =
<Pair key="module_action"><String>a valid entry for this pair key</String></Pair>
 
</Table>
== A Web-Site link ==
</Attributes>
This type of entry cab be placed on the root of the XMB category or in an XMB Item Tree. It makes a call to [[webbrowser_plugin|webbrowser_plugin.sprx]]
<Items>
 
<Item class="type:x-xmb/module-action" key="XMB_MODULE" attr="XMB_MODULE"/>
{{Boxcode|code=<syntaxhighlight lang="xml">
</Items>
<View id="seg_xmb_weblink">
</View>
<Attributes>
<Table key="link_1">
<Pair key="icon"><String>/dev_hdd0/devwiki_icon.png</String></Pair>
<Pair key="title"><String>PS3 Dev Wiki</String></Pair>
<Pair key="module_name"><String>webbrowser_plugin</String></Pair>
<Pair key="module_action"><String>http://www.psdevwiki.com/</String></Pair>
  </Table>
</Attributes>
<Items>
<Item class="type:x-xmb/module-action" key="link_1" attr="link_1"/>
</Items>
</View>
</syntaxhighlight>}}
</syntaxhighlight>}}


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''' (or the '''xmb_ingame.sprx''' for the in-game XMB) and contains a Module Reference and the path to the module .sprx file and associated .rco file for each module.  
*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 for the icon 'dev_wiki_icon' inside the rco file associated with the XMB category this XMBML code is placed, or alternativelly inside explore_plugin_full.rco
**The title will just print the contents of the string.
 
== Stubs ==
Can be used to stub XMB items in {{SHOP}} Firmware. All firmwares use this method to stub XMB items which have been stubbed. <small>With the exception of some XMB items which make "sel://" calls (such as "What's New") which have been left in-tact and Shop FW modules have only recently (4.30+?) blocked these calls returning the "This operation cannot be used during demonstration mode" message.</small>


table for 3.55 {{CEX}} xmb_plugin.sprx: (perhaps someone can make a table design which is intuitively inclusive of other firmwares and the xmb_ingame.sprx)
*explore_plugin.sprx


{| class="wikitable sortable"
{{File Formats}}<noinclude>[[Category:Main]]</noinclude>
|-
! Module Reference !! Associated .rco Filepath !! Module Filepath !! Known Use
|-
| playlist_plugin || /dev_flash/vsh/resource/playlist_plugin.rco || /dev_flash/vsh/module/playlist_plugin.sprx ||
|-
| scenefolder_plugin || /dev_flash/vsh/resource/scenefolder_plugin.rco || /dev_flash/vsh/module/scenefolder_plugin.sprx ||
|-
| system_plugin || N/A || N/A ||
|-
| xmb_plugin || N/A || N/A ||
|-
| explore_plugin || /dev_flash/vsh/resource/explore_plugin_full.rco || /dev_flash/vsh/module/explore_plugin.sprx || Can be used to stub XMB items in {{Shop}} Firmware. All firmwares use this method to stub XMB items which have been stubbed. <small>With the exception of some XMB items which make "sel://" calls (such as "What's New") which have been left in-tact and Shop FW modules have only recently (4.30+?) blocked these calls returning the "This operation cannot be used during demonstration mode" message.</small>
|-
| game_plugin || /dev_flash/vsh/resource/game_plugin.rco  || /dev_flash/vsh/module/basic_plugins.sprx ||
|-
| np_trophy_ingame || /dev_flash/vsh/resource/np_trophy_ingame.rco || /dev_flash/vsh/module/np_trophy_ingame.sprx ||
|-
| gamedata_plugin || /dev_flash/vsh/resource/gamedata_plugin.rco || /dev_flash/vsh/module/gamedata_plugin.sprx ||
|-
| game_ext_plugin || /dev_flash/vsh/resource/gamedata_plugin.rco || /dev_flash/vsh/module/game_ext_plugin.sprx ||
|-
| premo_plugin || /dev_flash/vsh/resource/premo_plugin.rco || /dev_flash/vsh/module/premo_plugin.sprx ||
|-
| micon_lock_plugin || N/A || /dev_flash/vsh/module/micon_lock_plugin.sprx ||
|-
| category_setting_plugin || /dev_flash/vsh/resource/category_setting_plugin.rco || /dev_flash/vsh/module/category_setting_plugin.sprx ||
|-
| sysconf_plugin || /dev_flash/vsh/resource/sysconf_plugin.rco || /dev_flash/vsh/module/sysconf_plugin.sprx ||
|-
| netconf_plugin || /dev_flash/vsh/resource/netconf_plugin.rco || /dev_flash/vsh/module/netconf_plugin.sprx ||
|-
| software_update_plugin || /dev_flash/vsh/resource/software_update_plugin.rco || /dev_flash/vsh/module/software_update_plugin.sprx ||
|-
| bdp_plugin || /dev_flash/vsh/resource/bdp_plugin.rco || /dev_flash/vsh/module/bdp_plugin.sprx ||
|-
| bdp_disccheck_plugin || /dev_flash/vsh/resource/bdp_disccheck_plugin.rco || /dev_flash/vsh/module/bdp_disccheck_plugin.sprx ||
|-
| bdp_storage_plugin || /dev_flash/vsh/resource/bdp_storage_plugin.rco || /dev_flash/vsh/module/bdp_storage_plugin.sprx ||
|-
| user_plugin || /dev_flash/vsh/resource/user_plugin.rco || /dev_flash/vsh/module/user_plugin.sprx ||
|-
| friendim_plugin || N/A || /dev_flash/vsh/module/friendim_plugin.sprx ||
|-
| friendml_plugin || /dev_flash/vsh/resource/friendml_plugin.rco || /dev_flash/vsh/module/friendml_plugin.sprx ||
|-
| friendtrophy_plugin || /dev_flash/vsh/resource/friendtrophy_plugin.rco || /dev_flash/vsh/module/friendtrophy_plugin.sprx ||
|-
| profile_plugin || /dev_flash/vsh/resource/profile_plugin.rco || /dev_flash/vsh/module/profile_plugin.sprx ||
|-
| photoviewer_plugin || /dev_flash/vsh/resource/photoviewer_plugin.rco || /dev_flash/vsh/module/photoviewer_plugin.sprx ||
|-
| videoplayer_plugin || /dev_flash/vsh/resource/videoplayer_plugin.rco || /dev_flash/vsh/module/videoplayer_plugin.sprx ||
|-
| webbrowser_plugin || /dev_flash/vsh/resource/webbrowser_plugin.rco || /dev_flash/vsh/module/webbrowser_plugin.sprx || Can be used to create [[XMB XML Coding#A Web-Site link|website links]].
|-
| webrender_plugin || /dev_flash/vsh/resource/webrender_plugin.rco || /dev_flash/vsh/module/webrender_plugin.sprx ||
|-
| xai_plugin || /dev_flash/vsh/resource/xai_plugin.rco || /dev_flash/vsh/module/xai_plugin.sprx ||
|-
| audioplayer_plugin || /dev_flash/vsh/resource/audioplayer_plugin.rco || /dev_flash/vsh/module/audioplayer_plugin.sprx ||
|-
| videodownloader_plugin || /dev_flash/vsh/resource/videodownloader_plugin.rco || /dev_flash/vsh/module/videodownloader_plugin.sprx ||
|-
| nas_plugin || /dev_flash/vsh/resource/nas_plugin.rco || /dev_flash/vsh/module/nas_plugin.sprx ||
|-
| download_plugin || /dev_flash/vsh/resource/download_plugin.rco || /dev_flash/vsh/module/download_plugin.sprx ||
|-
| ps3_savedata_plugin || /dev_flash/vsh/resource/ps3_savedata_plugin.rco || /dev_flash/vsh/module/ps3_savedata_plugin.sprx ||
|-
| vmc_savedata_plugin || /dev_flash/vsh/resource/vmc_savedata_plugin.rco. || /dev_flash/vsh/module/vmc_savedata_plugin.sprx ||
|-
| thumthum_plugin || /dev_flash/vsh/resource/thumthum_plugin.rco || /dev_flash/vsh/module/thumthum_plugin.sprx ||
|-
| npsignin_plugin || /dev_flash/vsh/resource/npsignin_plugin.rco || /dev_flash/vsh/module/npsignin_plugin.sprx ||
|-
| avc_plugin || /dev_flash/vsh/resource/avc_plugin.rco ||/dev_flash/vsh/module/avc_plugin.sprx ||
|-
| avc2_text_plugin || /dev_flash/vsh/resource/avc2_text_plugin.rco || /dev_flash/vsh/module/avc2_text_plugin.sprx ||
|-
| sacd_plugin || /dev_flash/vsh/resource/sacd_plugin.rco || /dev_flash/vsh/module/sacd_plugin.sprx ||
|-
| eula_cddb_plugin || /dev_flash/vsh/resource/eula_cddb_plugin.rco || /dev_flash/vsh/module/eula_cddb_plugin.sprx ||
|-
| strviewer_plugin || /dev_flash/vsh/resource/strviewer_plugin.rco. || /dev_flash/vsh/module/strviewer_plugin.sprx ||
|-
| edy_plugin || /dev_flash/vsh/resource/edy_plugin.rco || /dev_flash/vsh/module/edy_plugin.sprx ||
|-
| print_plugin || /dev_flash/vsh/resource/print_plugin.rco || /dev_flash/vsh/module/print_plugin.sprx ||
|-
| newstore_plugin || /dev_flash/vsh/resource/newstore_plugin.rco || /dev_flash/vsh/module/newstore_plugin.sprx ||
|-
| deviceconf_plugin || /dev_flash/vsh/resource/deviceconf_plugin.rco || /dev_flash/vsh/module/deviceconf_plugin.sprx ||
|-
| dlna_plugin || /dev_flash/vsh/resource/dlna_plugin.rco || /dev_flash/vsh/module/dlna_plugin.sprx ||
|-
| np_trophy_plugin || /dev_flash/vsh/resource/np_trophy_plugin.rco || /dev_flash/vsh/module/np_trophy_plugin.sprx ||
|-
| kensaku_plugin || /dev_flash/vsh/resource/kensaku_plugin.rco || /dev_flash/vsh/module/kensaku_plugin.sprx ||
|-
| regcam_plugin || /dev_flash/vsh/resource/regcam_plugin.rco || /dev_flash/vsh/module/regcam_plugin.sprx ||
|-
| idle_plugin || /dev_flash/vsh/resource/idle_plugin.rco || /dev_flash/vsh/module/idle_plugin.sprx ||
|-
| filecopy_plugin || /dev_flash/vsh/resource/filecopy_plugin.rco || /dev_flash/vsh/module/filecopy_plugin.sprx ||
|-
| wboard_plugin || /dev_flash/vsh/resource/wboard_plugin.rco || /dev_flash/vsh/module/wboard_plugin.sprx ||
|-
| checker_plugin || /dev_flash/vsh/resource/checker_plugin.rco || /dev_flash/vsh/module/checker_plugin.sprx ||
|-
| hknw_plugin || /dev_flash/vsh/resource/hknw_plugin.rco || /dev_flash/vsh/module/hknw_plugin.sprx ||
|-
| poweroff_plugin || /dev_flash/vsh/resource/poweroff_plugin.rco || /dev_flash/vsh/module/poweroff_plugin.sprx ||
|-
| eula_hcopy_plugin || /dev_flash/vsh/resource/eula_hcopy_plugin.rco || /dev_flash/vsh/module/eula_hcopy_plugin.sprx ||
|-
| videoeditor_plugin || /dev_flash/vsh/resource/videoeditor_plugin.rco || /dev_flash/vsh/module/videoeditor_plugin.sprx ||
|-
|}

Latest revision as of 17:55, 14 February 2022

Description[edit | edit source]

module-action is an XMBML command that works like a module (.sprx file) intercom, allowing XMBML files to use/send commands to a selected module, so it can perform functions outside the limits of the module managing that XMB Category.

The list of usable modules is indexed in xmb_plugin.sprx (modules availables in main XMB) and xmb_ingame.sprx (modules availables in in-game XMB) and contains the module reference, the path to the module (.sprx file), and the path to the associated resource (.rco file).

All the .sprx modules are stored in path: /dev_flash/vsh/module/ and the .rco resource files in path: /dev_flash/vsh/resource/

XMB Indexed Modules
Module Reference
<module>.sprx
<resource>.rco
Indexed in: In firmwares: XMBML module-action
availables
Notes
xmb_plugin.sprx xmb_ingame.sprx From Up to
playlist_plugin
playlist_plugin.sprx
playlist_plugin.rco
Yes No ??? 4.86 make_new_playlist_photo
make_new_playlist_music
new_playlist
playlists manager
scenefolder_plugin
scenefolder_plugin.sprx
scenefolder_plugin.rco
Yes No ??? 4.86 make_new_scenefolder_video_wo_title
make_new_scenefolder_video
system_plugin
basic_plugins.sprx
system_plugin.rco
Yes Yes ??? 4.86 ??? common and miscelaneous functions
xmb_plugin
xmb_plugin.sprx
N/A
Yes Yes ??? 4.86 ???
explore_plugin
explore_plugin.sprx
explore_plugin_full.rco
Yes Yes ??? 4.86

NotifyErrorNoExecute
ClearWBoardFocus
SetWBoardFocus
ExecStorageCopy
ShopDemo_ResetTimer
CloseListChild
FocusMessageBox
FocusFriend
ClearCache
ToggleExhibitionMode
SwitchBackgroundMode
SwitchFriendListMode
explore:log?channel_boot=
explore:log?channel_focus=
explore:log?screen_boot=
explore:log?screen_focus=
explore:log?video=%s%s
explore:log_flush?
explore:log_resession?
explore:call_updater
explore:log_direct?url=

file explorer
game_plugin
basic_plugins.sprx
game_plugin.rco
Yes Yes ??? 4.86 manual
psp_manual
miscelaneous game functions
np_trophy_ingame
np_trophy_ingame.sprx
np_trophy_ingame.rco
Yes Yes ??? 4.86 ??? online trophy functions
gamedata_plugin
gamedata_plugin.sprx
gamedata_plugin.rco
Yes No ??? 4.86 < any number > BDgame/gameupdate installations
game_ext_plugin
game_ext_plugin.sprx
gamedata_plugin.rco
Yes No ??? 4.86 ??? more miscelaneous game functions
premo_plugin
premo_plugin.sprx
premo_plugin.rco
Yes No ??? 4.86 ??? PSP remote play
micon_lock_plugin
micon_lock_plugin.sprx
N/A
Yes No ??? 4.86 ???
category_setting_plugin
category_setting_plugin.sprx
category_setting_plugin.rco
Yes No ??? 4.86 ??? XMB settings column
sysconf_plugin
sysconf_plugin.sprx
sysconf_plugin.rco
Yes No ??? 4.86 ??? miscelaneous system functions
netconf_plugin
netconf_plugin.sprx
netconf_plugin.rco
Yes No ??? 4.86 ??? network configuration manager
software_update_plugin
software_update_plugin.sprx
software_update_plugin.rco
Yes No ??? 4.86 ??? firmware updater miscelllaneous functions
bdp_plugin
bdp_plugin.sprx
bdp_plugin.rco
Yes No ??? 4.86 ??? bluray player
bdp_disccheck_plugin
bdp_disccheck_plugin.sprx
bdp_disccheck_plugin.rco
Yes No ??? 4.86 ??? bluray movie disc identifyer
bdp_storage_plugin
bdp_storage_plugin.sprx
bdp_storage_plugin.rco
Yes No ??? 4.86 ??? bluray movie disc identifyer ?
user_plugin
user_plugin.sprx
user_plugin.rco
Yes No ??? 4.86 ??? offline users manager
friendim_plugin
friendim_plugin.sprx
N/A
Yes No ??? 4.86 new_friend
new_message

psim:PluginNewMessageLaunch
psim:sendBrowserWakeup
psim:sendEtcLaunch
GameRecv
GameSend

chat functions
friendml_plugin
friendml_plugin.sprx
friendml_plugin.rco
Yes No ??? 4.86 ??? friends/chat functions
friendtrophy_plugin
friendtrophy_plugin.sprx
friendtrophy_plugin.rco
Yes No ??? 4.86 ??? friends/chat miscellaneous functions ?
profile_plugin
profile_plugin.sprx
profile_plugin.rco
Yes No ??? 4.86 ??? first boot user manager ?
photoviewer_plugin
photoviewer_plugin.sprx
photoviewer_plugin.rco
Yes No ??? 4.86 ??? image viewer
videoplayer_plugin
videoplayer_plugin.sprx
videoplayer_plugin.rco
Yes No ??? 4.86 psvp: video player
webbrowser_plugin
webbrowser_plugin.sprx
webbrowser_plugin.rco
Yes No ??? 4.86 <url> web browser
webrender_plugin
webrender_plugin.sprx
webrender_plugin.rco
Yes No ??? 4.86 <url> web browser miscelaneous functions ?
xai_plugin
xai_plugin.sprx
xai_plugin.rco
Yes No ??? 4.86 ??? XMB widgets
audioplayer_plugin
audioplayer_plugin.sprx
audioplayer_plugin.rco
Yes No ??? 4.86 ??? audio player
videodownloader_plugin
videodownloader_plugin.sprx
videodownloader_plugin.rco
Yes No ??? 4.86 ??? video downloader
nas_plugin
nas_plugin.sprx
nas_plugin.rco
Yes No ??? 4.86 ??? game purchase manager ?
download_plugin
download_plugin.sprx
download_plugin.rco
Yes No ??? 4.86 <number> file downloader
ps3_savedata_plugin
ps3_savedata_plugin.sprx
ps3_savedata_plugin.rco
Yes No ??? 4.86 ??? savedata manager (PS3)
vmc_savedata_plugin
vmc_savedata_plugin.sprx
vmc_savedata_plugin.rco
Yes No ??? 4.86 ??? virtual memory card manager (PS1 & PS2)
thumthum_plugin
thumthum_plugin.sprx
thumthum_plugin.rco
Yes No ??? 4.86 ???
npsignin_plugin
npsignin_plugin.sprx
npsignin_plugin.rco
Yes No ??? 4.86 ??? PSN login manager
avc_plugin
avc_plugin.sprx
avc_plugin.rco
Yes No ??? 4.86 new_chat Audio/Video chat manager ?
avc2_text_plugin
avc2_text_plugin.sprx
avc2_text_plugin.rco
Yes No ??? 4.86 new_chat Audio/Video chat manager 2 ?
sacd_plugin
sacd_plugin.sprx
sacd_plugin.rco
Yes No ??? 4.86 ??? super audio-CD player
eula_cddb_plugin
eula_cddb_plugin.sprx
eula_cddb_plugin.rco
Yes No ??? 4.86 ??? audio-CD database manager
strviewer_plugin
strviewer_plugin.sprx
strviewer_plugin.rco
Yes No ??? 4.86 ??? XMB language selector ?
edy_plugin
edy_plugin.sprx
edy_plugin.rco
Yes No ??? 4.86 ??? Edy viewer pay service
print_plugin
print_plugin.sprx
print_plugin.rco
Yes No ??? 4.86 ??? printer manager
newstore_plugin
newstore_plugin.sprx
newstore_plugin.rco
Yes No ??? 4.86 ??? PSN store viewer
deviceconf_plugin
deviceconf_plugin.sprx
deviceconf_plugin.rco
Yes No ??? 4.86 ??? peripheral manager
dlna_plugin
dlna_plugin.sprx
dlna_plugin.rco
Yes No ??? 4.86 dlna_scan dlna media services manager
np_trophy_plugin
np_trophy_plugin.sprx
np_trophy_plugin.rco
Yes No ??? 4.86 ???
kensaku_plugin
kensaku_plugin.sprx
kensaku_plugin.rco
Yes No ??? 4.86 kensaku_google internet search (the loupe icon in network column)
regcam_plugin
regcam_plugin.sprx
regcam_plugin.rco
Yes No ??? 4.86 ??? credit card manager ?
idle_plugin
idle_plugin.sprx
idle_plugin.rco
Yes No ??? 4.86 ??? XMB idle mode enabler ?
filecopy_plugin
filecopy_plugin.sprx
filecopy_plugin.rco
Yes No ??? 4.86 copy:device external device file importer/exporter
wboard_plugin
wboard_plugin.sprx
wboard_plugin.rco
Yes No ??? 4.86 wbrd:show? "what's new" display mode content manager
checker_plugin
checker_plugin.sprx
checker_plugin.rco
Yes No ??? 4.86 ???
hknw_plugin
hknw_plugin.sprx
hknw_plugin.rco
Yes No ??? 4.86 ??? photo editor (hakinowa)
poweroff_plugin
poweroff_plugin.sprx
poweroff_plugin.rco
Yes No ??? 4.86 ??? system power manager
eula_hcopy_plugin
eula_hcopy_plugin.sprx
eula_hcopy_plugin.rco
Yes No ??? 4.86 ??? hdd copy/backup utility
videoeditor_plugin
videoeditor_plugin.sprx
videoeditor_plugin.rco
Yes No ??? 4.86 ??? video editor
This table only represents modules indexed in CEX firmwares !

Common uses[edit | edit source]

A Web-Site link[edit | edit source]

This type of entry cab be placed on the root of the XMB category or in an XMB Item Tree. It makes a call to webbrowser_plugin.sprx

		<View id="seg_xmb_weblink">
			<Attributes>
				<Table key="link_1">
					<Pair key="icon"><String>/dev_hdd0/devwiki_icon.png</String></Pair>
					<Pair key="title"><String>PS3 Dev Wiki</String></Pair>
					<Pair key="module_name"><String>webbrowser_plugin</String></Pair>
					<Pair key="module_action"><String>http://www.psdevwiki.com/</String></Pair>
  				</Table>
			</Attributes>
			<Items>
				<Item class="type:x-xmb/module-action" key="link_1" attr="link_1"/>
			</Items>
		</View>
  • 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 for the icon 'dev_wiki_icon' inside the rco file associated with the XMB category this XMBML code is placed, or alternativelly inside explore_plugin_full.rco
    • The title will just print the contents of the string.

Stubs[edit | edit source]

Can be used to stub XMB items in  SHOP  Firmware. All firmwares use this method to stub XMB items which have been stubbed. With the exception of some XMB items which make "sel://" calls (such as "What's New") which have been left in-tact and Shop FW modules have only recently (4.30+?) blocked these calls returning the "This operation cannot be used during demonstration mode" message.

  • explore_plugin.sprx