Editing XMB Manuals

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=
MANUAL can be use as a guide, read me, extra artwork & infos etc... and load them in game, without having to quit the hdd app/homebrew/PS3 PSN game.
=In-Game Manuals for HDD games/apps=
=In-Game Manuals for HDD games/apps=
The manual appears with a "question mark" icon named "Software Manual" and the title_id of the game/app in small font under it, in {{icon category game}} column inside [[XMB|XMB In-Game]] mode by pressing {{padps}} button
Manuals can be used as a guide, changelog, readme, extra artwork, etc... and are loaded without having to quit the hdd app/game.


==PS3 Games==
==PS3 Games==
Implemented around 4.00 firmware (not working on 3.55, working on 4.21+)
===Structure tree & infos===
The icon of software manual will appear on [[XMB|XMB]] in Game by pressing {{padps}} ([[XMB-Game|XMB-Game]] Column regardless of the [[PARAM.SFO#CATEGORY|PARAM.SFO CATEGORY]]) with this directory "MANUAL" (not working on 3.55, working on 4.21+).


*Buttons
Press {{padsquare}} to zoom in/zoom out, {{padcross}} or {{padps}} buttons to close it.
**{{padsquare}} to zoom in (50% zoom)/zoom out (full screen)
**{{dpadr}} and {{padlr}} for "next" page
**{{dpadl}} and {{padll}} for "previous" page
**{{padcircle}} (or {{padcross}} for japan) returns to [[XMB|XMB In-Game]]
**{{padps}} returns to game (directly, from MANUAL back to the game, bypasing [[XMB|XMB In-Game]])


The zoom has 2 working modes, that depends of the aspect ratio of the image, there are not intermediate zoom levels, and the bigger zoom is predefined to around 50% bigger of the "full screen" mode:
*For 16:9 images
**Image is displayed initially at "full screen"
**When pressing {{padsquare}} image is zoomed-in around 50% bigger
*For non 16:9 images
**Image is displayed initially at "full height" or "full width" (bigger one wins) to keep the whole image on screen by using transparent areas all around when needed
**When pressing {{padsquare}} for first time, the image is zoomed-in to full screen, with some areas of the image out of screen
**When pressing {{padsquare}} for second time, the image is zoomed-in around 50% bigger than the previous step
===Structure tree & infos===
  '''NP**12345/MANUAL/'''001.DDS, 002.DDS    //XMB in English (United Kingdom & United States)
  '''NP**12345/MANUAL/'''001.DDS, 002.DDS    //XMB in English (United Kingdom & United States)
  '''NP**12345/MANUAL/02/'''001.DDS, 002.DDS //XMB in French
  '''NP**12345/MANUAL/02/'''001.DDS, 002.DDS //XMB in French
Line 31: Line 18:
  ...
  ...


*Only for PS3 type, HDD Installed Contents
*The images, [[Multimedia Formats and Tools|Direct Draw Surface (DDS) format]], need to be compressed as DXT1 (resolution as 1920x1080 work on HDTV and SDTV).
*Is not supported inside PS3 game disc structure... but is supported in the "GameData" installations made by PS3 disc games and by his game updates/patches
*For add multiple languages, it seems to follow theses system [[Content_Information_Files#Languages| Languages code]]
*To add multiple manuals for different languages use the subfolders '''02''' (for french manual), '''03''' (for spanish manual), etc..., the numbers follows the system [[Content_Information_Files#Languages| Language codes]]
*'''only for HDD Contents ?''' (for Disc Game it was not working, be as SFO category DG or AP. For GD:? (see BLUS-31273 INSDIR pkg Angry Bird Star Wars edition))
*Up to 999.DDS pages ? (speculative, because the image names uses 3 digits, e,g: 123.DDS but max not tested)
*up to only 999 pages?
 
*[http://psx-scene.com/forums/content/redemp-s-xmb-video-icon-icon1-pam-dds-manuals-collection-retroxmb-4550/ PSX SCENE thread resource by '''Redemp''']
===Image Formats===
*The .DDS original format (found in NPUA80543) is '''DXT1C''' (dxt1, only color), '''without''' mipmaps. See: [[Multimedia Formats and Tools]]
*The resolutions (width x height) needs to have a number of pixels that is a multiple of 4 (both width and height sizes needs to be multiple of 4). DDS tools cant make a direct conversion of images that are not multiple of 4 (error: ''Image is not a multiple of 4 and no rescaling specified''), and by using rescaling is not posible to create DDS images with sizes that are not multiple of 4 (error: ''[Rescaling] [Processing] returned error IMAGE_NOT_MULT4'')
 
 
*Most useful resolutions (because all modern TV's and PS3 are designed for it) are all that matches 16:9 aspect ratio, you can see a list of the most common here: http://en.wikipedia.org/wiki/16:9#Common_resolutions
**Supported 16:9 resolutions: 640x360, 960x540, 1024x576, 1280x720, 1600x900, 1920x1080 (found in NPUA80543), 2048x1152, 2560x1440
**'''NOT''' supported 16:9 resolutions ('''not multiple of 4'''): 864x486 (486 is not multiple of 4), 1366x768 (1366 is not multiple of 4)
**'''NOT''' supported 16:9 resolutions ('''too big in bytes ?'''): 2880x1620 (2,22 MB per page), 3200x1800 (2,74 MB per page), 3840x2160 for [http://en.wikipedia.org/wiki/Graphics_display_resolution#4K_UHD 4K UHD TV] (3,95 MB per page)
 
{| class="wikitable"
|+Page size by resolution (comparison)
! rowspan="2" | DDS Format !! colspan="13" | 16:9 Resolutions
|-
! 640x360 !! 960x540<br>[http://en.wikipedia.org/wiki/Graphics_display_resolution#qHD (qHD TV)] !! 1024x576 !! 1280x720<br>[http://en.wikipedia.org/wiki/Graphics_display_resolution#HD (HD TV)] !! 1600x900 !! 1920x1080<br>[http://en.wikipedia.org/wiki/Graphics_display_resolution#FHD (Full HD TV)] !! 2048x1152 !! 2560x1440<br>[http://en.wikipedia.org/wiki/Graphics_display_resolution#WQHD (QHD TV)]
|-
| DXT1C,  No mipmaps || 112 KB || 253 KB || 288 KB || 450 KB || 703 KB || 0,98 MB || 1,12 MB || 1,75 MB
|}
 
*Other resolutions (not 16:9)
**Supported: 1280x1024
 
{| class="wikitable"
|+Page size by resolution (comparison)
! rowspan="2" | DDS Format !! colspan="1" | Not 16:9 Resolutions
|-
! 1280x1024
|-
| DXT1C,  No mipmaps || 640 KB
|}
 
{{Boxframe1|content='''Can be created with nvidia texture tool (nvdxt.exe) by using this command:'''
*Individual file:
{{Keyboard|content=<syntaxhighlight lang="bash">nvdxt.exe -file input.png -dxt1c -nomipmap -output output.dds</syntaxhighlight>}}
*Individual file with cube filter rescale to 1920x1080 resolution, and highest quality compression:
{{Keyboard|content=<syntaxhighlight lang="bash">nvdxt.exe -file input.png -dxt1c -nomipmap -prescale 1920 1080 -quality_highest -output output.dds</syntaxhighlight>}}
*Multiple files with cube filter rescale to 1920x1080 resolution, highest quality compression, and using folder paths for input and output (massive conversion of any supported image with any name and any resolution from CUSTOM_IMAGES folder to MANUAL folder)
{{Keyboard|content=<syntaxhighlight lang="bash">nvdxt.exe -deep c:\CUSTOM_IMAGES -all -dxt1c -nomipmap -prescale 1920 1080 -quality_highest -outdir c:\MANUAL</syntaxhighlight>}}
*Nvidia Texture Tool notes:
**Supported image formats
***.tga .bmp .gif .ppm .jpg .tif .cel .dds .png .psd .rgb .bw .rgba
**DDS format and options
*** '''-dxt1c:''' DXT1 (color only)
*** '''-nomipmap:''' don't generate MIP maps
**General options
*** '''-quick:''' use fast compression method
*** '''-quality_normal:''' normal quality compression
*** '''-quality_production:''' production quality compression
*** '''-quality_highest:''' highest quality compression (this can be very slow)
*** '''-prescale <int> <int>:''' rescale image to this size first
**Rescale filters (default: cube filter)
*** '''-RescalePoint'''
*** '''-RescaleBox'''
*** '''-RescaleTriangle'''
*** '''-RescaleQuadratic'''
*** '''-RescaleCubic'''
*** '''-RescaleCatrom'''
*** '''-RescaleMitchell'''
*** '''-RescaleGaussian'''
*** '''-RescaleSinc'''
*** '''-RescaleBessel'''
*** '''-RescaleHanning'''
*** '''-RescaleHamming'''
*** '''-RescaleBlackman'''
*** '''-RescaleKaiser'''
**Paths
*** '''-file <filename>:''' input file to process. Accepts wild cards
*** '''-output <filename>:''' filename to write to [-outfile can also be specified]
*** '''-deep <directory>:''' include all subdirectories
*** '''-all:''' all image files in current directory
*** '''-outdir <directory>:''' output directory
**Other notes
***The '''-prescale''' is a '''-rescale''' that happens first, both uses the same filters, included the default cube filter rescaling used in this examples ('''-RescaleCubic''' is the default filter used when no other filters are specifyed) and all the other availables like '''-RescaleGaussian''', etc...
}}
 
{{Boxframe1|content='''Can be created with gimp plugin...'''<br>
Please help to fill...
}}
 
{{Boxframe1|content='''Can be created with photoshop plugin...'''<br>
Please help to fill...
}}
 
*Pixelation notes:
Overall, and based on how the pages will be displayed with or without zoom... there are basically 2 types of manuals
 
 
The most common is the classic "user manual" from any device, where are used texts with long sentences, a few icons, and some small images overlayed to explain the working or the controlls of the device/program/game/whatever
 
In this kind of manual, the pages are supposed to be readed at "full screen", so is needed to use a font with good size, this makes pointless to use the zoom function (well, most users will zoom for science purposes, but they will realize is pointless because zooming in a sentence is stupid if you can read it without zoom)
 
For this manuals is good to go to the small resolution sizes (like 1024x576 or smaller with 288 KB per page) because there is a small pixelation but is only notable when zoomed in... and well... user is not supposed to zoom in more than 1 time (the first time for science), this manuals are good for homebrew where the manual doesnt needs to be bigger than the homebrew app itself (a manual of 30 MB for a homebrew with size 5 MB looks excesive)
 
 
The other type of manual is where it contains maps of the game with the location of items, places, or any kind of image with big detail that is interesting to display it in the bigger size posible (here the user is supposed to zoom in allways in every page)
 
For this ones is good to go for the bigger resolution sizes like 2560x1440 (and 1,75 MB per page) because usually there are not much pages and are for games wich size is much bigger than the manual (a manual of 100 MB for a game with size 10GB doesnt looks excesive)


===Links & Tutorials===
===Links & Tutorials===
Line 139: Line 29:
*[http://www.ps3hax.net/showthread.php?p=668763 here is a example of MANUAL] in game, for FB Alpha Retro Loader by '''CaptainCPS-X''' (24 pages).
*[http://www.ps3hax.net/showthread.php?p=668763 here is a example of MANUAL] in game, for FB Alpha Retro Loader by '''CaptainCPS-X''' (24 pages).
*[https://github.com/CaptainCPS/FBAlphaRL/commit/d876617722270acf9161afd83e6cd73014210dc5 git of CaptainCPS-X with infos for pkg.py to create propers pkg including MANUAL]
*[https://github.com/CaptainCPS/FBAlphaRL/commit/d876617722270acf9161afd83e6cd73014210dc5 git of CaptainCPS-X with infos for pkg.py to create propers pkg including MANUAL]
*[http://code.google.com/p/gimp-dds/ Gimp DDS plug in]
*[https://developer.nvidia.com/nvidia-texture-tools-adobe-photoshop Photoshop 5.1 / CS6 "NVIDIA Texture Tools" plugin ]
*[http://psx-scene.com/forums/content/retroxmb-icon1-pam-manuals-dds-redemp-4365 retroXMB MANUAL] by '''Redemp'''
*[http://psx-scene.com/forums/content/retroxmb-icon1-pam-manuals-dds-redemp-4365 retroXMB MANUAL] by '''Redemp'''
*[https://anonfiles.com/file/942ee38bcf72321b05a11c76233b768b True Ancestor PKG Creator patched for MANUAL]
*[https://anonfiles.com/file/942ee38bcf72321b05a11c76233b768b True Ancestor PKG Creator patched for MANUAL]
*[http://psx-scene.com/forums/content/redemp-s-xmb-video-icon-icon1-pam-dds-manuals-collection-retroxmb-4550/ PSX SCENE thread resource by '''Redemp''']


===Gallery===
===Gallery===
Note: images has been converted to jpg for wikify purpose.
Note: images converted to jpg for wikify purpose.
 
<GALLERY>
<GALLERY>
File:PS_Seismograph_page002.jpg | PS Seismograph page 002
File:PS_Seismograph_page002.jpg | PS Seismograph page 002
File:PS_Seismograph_page003.jpg | PS Seismograph page 003
File:PS_Seismograph_page003.jpg | PS Seismograph page 003
File:PS_Seismograph_page004.jpg | PS Seismograph page 004
File:PS_Seismograph_page004.jpg | PS Seismograph page 004
</GALLERY>
<GALLERY>
File:MANUAL_FB_Alpha_Retro_Loader_001.jpg | FBAlphaRL page 001
File:MANUAL_FB_Alpha_Retro_Loader_001.jpg | FBAlphaRL page 001
File:MANUAL_FB_Alpha_Retro_Loader_003.jpg | FBAlphaRL page 003
File:MANUAL_FB_Alpha_Retro_Loader_003.jpg | FBAlphaRL page 003
Line 175: Line 69:


===Structure tree===
===Structure tree===
<div style="height:300px; overflow:auto">
  NPUO30***/ (only from few US example)
  NPUO30***/ (only from few US example)
     |
     |
Line 206: Line 102:
                       |
                       |
                       |-.usm
                       |-.usm
</div>


=Web Manuals=
=Web Manuals=
Line 221: Line 118:


=Manuals Multilingual Support=
=Manuals Multilingual Support=
{{PlayStation Languages}}
{{XMB languages}}
*Notes:
*Notes:
**Portugues (Portugal), and Portugues (Brazil) can share the same manual ingame
**Portugues (Portugal), and Portugues (Brazil) can share the same manual ingame
**English (United States), and English (United Kingdom) can share the same manual ingame
**English (United States), and English (United Kingdom) can share the same manual ingame


{{Reverse engineering}}<noinclude>[[Category:Main]]</noinclude>
{{File Formats}}<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_Manuals"