Editing XMBML module-action

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:
= Description =
==module-action example==
'''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.
This is an XMB command, typically this is utilised with the [[XMB XML Coding|XML code]] below:
{{Boxcode|content=<syntaxhighlight lang="xml">
<View id="Entry_1">
<Attributes>
<Table key="XMB_MODULE">
<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>
<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>
<Pair key="module_action"><String>a valid entry for this pair key</String></Pair>
</Table>
</Attributes>
<Items>
<Item class="type:x-xmb/module-action"  key="XMB_MODULE" attr="XMB_MODULE"/>
</Items>
</View>
</syntaxhighlight>}}


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).
This is acts like a module (SPRX) intercom, allowing XML 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 'useable' 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/'''
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}}
==XMB Indexed modules==
 
{| class="wikitable sortable"
|-
! rowspan="2" | Module Reference<BR /><module>.sprx<BR /><resource>.rco !! colspan="2" | Indexed in: !! colspan="2" | In firmwares: !! rowspan="2" | module-action<BR />availables !! rowspan="2" | Notes
|-
! xmb_plugin.sprx !! xmb_ingame.sprx !! From !! Up to
|-
| [[playlist_plugin]]<BR />playlist_plugin.sprx<BR />playlist_plugin.rco || {{Yes}} || {{No}} || ??? || 3.55 || make_new_playlist_photo <BR />make_new_playlist_music<BR />new_playlist || playlists manager
|-
| [[scenefolder_plugin]]<BR />scenefolder_plugin.sprx<BR />scenefolder_plugin.rco || {{Yes}} || {{No}} || ??? || 3.55 || make_new_scenefolder_video_wo_title<br>make_new_scenefolder_video ||
|-
| [[system_plugin]]<BR />basic_plugins.sprx<BR />system_plugin.rco || {{Yes}} || {{Yes}} || ??? || 3.55 || ??? || common and miscelaneous functions
|-
| [[xmb_plugin]]<BR />xmb_plugin.sprx<BR />N/A || {{Yes}} || {{Yes}} || ??? || 3.55 || ??? ||
|-
| [[explore_plugin]]<BR />explore_plugin.sprx<BR />explore_plugin_full.rco || {{Yes}} || {{Yes}} || ??? || 3.55 ||
NotifyErrorNoExecute <br>
ClearWBoardFocus <br>
SetWBoardFocus<br>
ExecStorageCopy <br>
NotifyErrorNoExecute<br>
ShopDemo_ResetTimer<br>
CloseListChild<br>
FocusMessageBox <br>
FocusFriend<br>
ClearCache<br>
explore:log?channel_boot=<br>
explore:log?channel_focus=<br>
explore:log?screen_boot=<br>
explore:log?screen_focus=<br>
explore:log?video=%s%s<br>
explore:log_flush?<br>
explore:log_resession?<br>
explore:call_updater<br>
explore:log_direct?url=<br>
|| file explorer
|-
| [[game_plugin]]<BR />basic_plugins.sprx<BR />game_plugin.rco || {{Yes}} || {{Yes}} || ??? || 3.55 || manual<BR />psp_manual || miscelaneous game functions
|-
| [[np_trophy_ingame]]<BR />np_trophy_ingame.sprx<BR />np_trophy_ingame.rco || {{Yes}} || {{Yes}} || ??? || 3.55 || ??? || online trophy functions
|-
| [[gamedata_plugin]]<BR />gamedata_plugin.sprx<BR />gamedata_plugin.rco || {{Yes}} || {{No}} || ??? || 3.55 || < any number > || BDgame/gameupdate installations
|-
| [[game_ext_plugin]]<BR />game_ext_plugin.sprx<BR />gamedata_plugin.rco || {{Yes}} || {{No}} || ??? || 3.55 || ??? || more miscelaneous game functions
|-
| [[premo_plugin]]<BR />premo_plugin.sprx<BR />premo_plugin.rco || {{Yes}} || {{No}} || ??? || 3.55 || ??? || PSP remote play
|-
| micon_lock_plugin<BR />micon_lock_plugin.sprx<BR />N/A || {{Yes}} || {{No}} || ??? || 3.55 || ??? ||
|-
| [[category_setting_plugin]]<BR />category_setting_plugin.sprx<BR />category_setting_plugin.rco || {{Yes}} || {{No}} || ??? || 3.55 || ??? || XMB settings column
|-
| [[sysconf_plugin]]<BR />sysconf_plugin.sprx<BR />sysconf_plugin.rco || {{Yes}} || {{No}} || ??? || 3.55 || ??? || miscelaneous system functions
|-
| [[netconf_plugin]]<BR />netconf_plugin.sprx<BR />netconf_plugin.rco || {{Yes}} || {{No}} || ??? || 3.55 || ??? || network configuration manager
|-
| [[software_update_plugin]]<BR />software_update_plugin.sprx<BR />software_update_plugin.rco || {{Yes}} || {{No}} || ??? || 3.55 || ??? || firmware updater miscelllaneous functions
|-
| [[bdp_plugin]]<BR />bdp_plugin.sprx<BR />bdp_plugin.rco || {{Yes}} || {{No}} || ??? || 3.55 || ??? || bluray player
|-
| [[bdp_disccheck_plugin]]<BR />bdp_disccheck_plugin.sprx<BR />bdp_disccheck_plugin.rco || {{Yes}} || {{No}} || ??? || 3.55 || ??? || bluray movie disc identifyer
|-
| [[bdp_storage_plugin]]<BR />bdp_storage_plugin.sprx<BR />bdp_storage_plugin.rco || {{Yes}} || {{No}} || ??? || 3.55 || ??? || bluray movie disc identifyer ?
|-
| [[user_plugin]]<BR />user_plugin.sprx<BR />user_plugin.rco || {{Yes}} || {{No}} || ??? || 3.55 || ??? || offline users manager
|-
| [[friendim_plugin]]<BR />friendim_plugin.sprx<BR />N/A || {{Yes}} || {{No}} || ??? || 3.55 || new_friend <BR />new_message <br>
psim:PluginNewMessageLaunch<br>
psim:sendBrowserWakeup <br>
psim:sendEtcLaunch
|| chat functions
|-
| [[friendml_plugin]]<BR />friendml_plugin.sprx<BR />friendml_plugin.rco || {{Yes}} || {{No}} || ??? || 3.55 || ??? || friends/chat functions
|-
| [[friendtrophy_plugin]]<BR />friendtrophy_plugin.sprx<BR />friendtrophy_plugin.rco || {{Yes}} || {{No}} || ??? || 3.55 || ??? || friends/chat miscellaneous functions ?
|-
| [[profile_plugin]]<BR />profile_plugin.sprx<BR />profile_plugin.rco || {{Yes}} || {{No}} || ??? || 3.55 || ??? || first boot user manager ?
|-
| [[photoviewer_plugin]]<BR />photoviewer_plugin.sprx<BR />photoviewer_plugin.rco || {{Yes}} || {{No}} || ??? || 3.55 || ??? || image viewer
|-
| [[videoplayer_plugin]]<BR />videoplayer_plugin.sprx<BR />videoplayer_plugin.rco || {{Yes}} || {{No}} || ??? || 3.55 || psvp: || video player
|-
| [[webbrowser_plugin]]<BR />webbrowser_plugin.sprx<BR />webbrowser_plugin.rco || {{Yes}} || {{No}} || ??? || 3.55 || <url> || web browser
|-
| [[webrender_plugin]]<BR />webrender_plugin.sprx<BR />webrender_plugin.rco || {{Yes}} || {{No}} || ??? || 3.55 || <url> || web browser miscelaneous functions ?
|-
| xai_plugin<BR />xai_plugin.sprx<BR />xai_plugin.rco || {{Yes}} || {{No}} || ??? || 3.55 || ??? || XMB widgets
|-
| [[audioplayer_plugin]]<BR />audioplayer_plugin.sprx<BR />audioplayer_plugin.rco || {{Yes}} || {{No}} || ??? || 3.55 || ??? || audio player
|-
| [[videodownloader_plugin]]<BR />videodownloader_plugin.sprx<BR />videodownloader_plugin.rco || {{Yes}} || {{No}} || ??? || 3.55 || ??? || video downloader
|-
| [[nas_plugin]]<BR />nas_plugin.sprx<BR />nas_plugin.rco || {{Yes}} || {{No}} || ??? || 3.55 || ??? || game purchase manager ?
|-
| [[download_plugin]]<BR />download_plugin.sprx<BR />download_plugin.rco || {{Yes}} || {{No}} || ??? || 3.55 || <number> || file downloader
|-
| [[ps3_savedata_plugin]]<BR />ps3_savedata_plugin.sprx<BR />ps3_savedata_plugin.rco || {{Yes}} || {{No}} || ??? || 3.55 || ??? || savedata manager (PS3)
|-
| [[vmc_savedata_plugin]]<BR />vmc_savedata_plugin.sprx<BR />vmc_savedata_plugin.rco || {{Yes}} || {{No}} || ??? || 3.55 || ??? || virtual memory card manager (PS1 & PS2)
|-
| [[thumthum_plugin]]<BR />thumthum_plugin.sprx<BR />thumthum_plugin.rco || {{Yes}} || {{No}} || ??? || 3.55 || ??? ||
|-
| [[npsignin_plugin]]<BR />npsignin_plugin.sprx<BR />npsignin_plugin.rco || {{Yes}} || {{No}} || ??? || 3.55 || ??? || PSN login manager
|-
| [[avc_plugin]]<BR />avc_plugin.sprx<BR />avc_plugin.rco || {{Yes}} || {{No}} || ??? || 3.55 || ??? || Audio/Video chat manager ?
|-
| [[avc2_text_plugin]]<BR />avc2_text_plugin.sprx<BR />avc2_text_plugin.rco || {{Yes}} || {{No}} || ??? || 3.55 || new_chat || Audio/Video chat manager 2 ?
|-
| [[sacd_plugin]]<BR />sacd_plugin.sprx<BR />sacd_plugin.rco || {{Yes}} || {{No}} || ??? || 3.55 || ??? || super audio-CD player
|-
| [[eula_cddb_plugin]]<BR />eula_cddb_plugin.sprx<BR />eula_cddb_plugin.rco || {{Yes}} || {{No}} || ??? || 3.55 || ??? || audio-CD database manager
|-
| [[strviewer_plugin]]<BR />strviewer_plugin.sprx<BR />strviewer_plugin.rco || {{Yes}} || {{No}} || ??? || 3.55 || ??? || XMB language selector ?
|-
| [[edy_plugin]]<BR />edy_plugin.sprx<BR />edy_plugin.rco || {{Yes}} || {{No}} || ??? || 3.55 || ??? || Edy viewer pay service
|-
| [[print_plugin]]<BR />print_plugin.sprx<BR />print_plugin.rco || {{Yes}} || {{No}} || ??? || 3.55 || ??? || printer manager
|-
| [[newstore_plugin]]<BR />newstore_plugin.sprx<BR />newstore_plugin.rco || {{Yes}} || {{No}} || ??? || 3.55 || ??? || PSN store viewer
|-
| [[deviceconf_plugin]]<BR />deviceconf_plugin.sprx<BR />deviceconf_plugin.rco || {{Yes}} || {{No}} || ??? || 3.55 || ??? || peripheral manager
|-
| [[dlna_plugin]]<BR />dlna_plugin.sprx<BR />dlna_plugin.rco || {{Yes}} || {{No}} || ??? || 3.55 || dlna_scan || dlna media services manager
|-
| [[np_trophy_plugin]]<BR />np_trophy_plugin.sprx<BR />np_trophy_plugin.rco || {{Yes}} || {{No}} || ??? || 3.55 || ??? ||
|-
| [[kensaku_plugin]]<BR />kensaku_plugin.sprx<BR />kensaku_plugin.rco || {{Yes}} || {{No}} || ??? || 3.55 || kensaku_google || internet search (the loupe icon in network column)
|-
| [[regcam_plugin]]<BR />regcam_plugin.sprx <BR />regcam_plugin.rco|| {{Yes}} || {{No}} || ??? || 3.55 || ??? || credit card manager ?
|-
| [[idle_plugin]]<BR />idle_plugin.sprx<BR />idle_plugin.rco || {{Yes}} || {{No}} || ??? || 3.55 || ??? || XMB idle mode enabler ?
|-
| [[filecopy_plugin]]<BR />filecopy_plugin.sprx<BR />filecopy_plugin.rco || {{Yes}} || {{No}} || ??? || 3.55 || copy:device || external device file importer/exporter
|-
| [[wboard_plugin]]<BR />wboard_plugin.sprx<BR />wboard_plugin.rco || {{Yes}} || {{No}} || ??? || 3.55 || wbrd:show? || "what's new" display mode content manager
|-
| [[checker_plugin]]<BR />checker_plugin.sprx<BR />checker_plugin.rco || {{Yes}} || {{No}} || ??? || 3.55 || ??? ||
|-
| [[hknw_plugin]]<BR />hknw_plugin.sprx<BR />hknw_plugin.rco || {{Yes}} || {{No}} || ??? || 3.55 || ??? || photo editor (hakinowa)
|-
| [[poweroff_plugin]]<BR />poweroff_plugin.sprx<BR />poweroff_plugin.rco || {{Yes}} || {{No}} || ??? || 3.55 || ??? || system power manager
|-
| [[eula_hcopy_plugin]]<BR />eula_hcopy_plugin.sprx<BR />eula_hcopy_plugin.rco || {{Yes}} || {{No}} || ??? || 3.55 || ??? || hdd copy/backup utility
|-
| [[videoeditor_plugin]]<BR />videoeditor_plugin.sprx<BR />videoeditor_plugin.rco || {{Yes}} || {{No}} || ??? || 3.55 || ??? || video editor
|-
|}


= Common uses =
*Notes:
This table only represents modules indexed in CEX firmwares... for other firmwares (in the case of differences) can be added more columns using the same format in the header of this other table: [[XMB#XMB_Configuration_Files|XMB Configuration Files]]


== A Web-Site link ==
===Common uses===
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]]
*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>


{{Boxcode|code=<syntaxhighlight lang="xml">
*webbrowser_plugin.sprx
<View id="seg_xmb_weblink">
Can be used to create [[XMB XML Coding#A Web-Site link|website links]]
<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>}}


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


*explore_plugin.sprx


{{File Formats}}<noinclude>[[Category:Main]]</noinclude>
{{System 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/XMBML_module-action"