110
edits
Changes
no edit summary
| 1029
| 1029
| June 6/7, 2011
| June 6/7, 2011
| [[eShop]] added, web browser available, [[System Transfer]] added. Full DSiWare data management available. [[Automatic_System_Update_Download|Automatic]] downloading for system updates added.
| [[eShop]] added, web browser available, [[System Transfer]] added. Full DSiWare data management available. [[Automatic_System_Update_Download|Automatic]] downloading for system updates added. Video stubbed.
|
|
|
|
| ?
| ?
| November 6, 2011
| November 6, 2011
| CUP Only Release. Improved the arrangement of [[Friend List]]. Update from some game cards such as Super Mario 3D Land.
| CUP Only Release. Add "join game" feature to [[Friend List]]. Update from some game cards such as Super Mario 3D Land.
|
|
|
|
|-
|-
| [[3.1.0-6|3.1.0-6]]
| [[3.1.0-6|3.1.0-6]]
| Unknown
| Not updated
| Unknown
| Unknown
| Unknown. Sighted preinstalled on some early European 3DS XLs.
| Unknown. Sighted preinstalled on some early European 3DS XLs.
|
|
| No
| No
| No
| Yes (K)
| Available
| Available
| October 6, 2014
| October 6, 2014
|
|
| No
| No
| No
| Yes (U/E)
| Available
| Available
| October 29, 2014
| October 29, 2014
|
|
|
|
| No
| Yes (J/U/E)
| Available
| Available
| February 2, 2015
| February 2, 2015
|
|
| March 2, 2015
| March 2, 2015
| See [[9.5.0-22|this]].
| See [[9.5.0-23|this]].
| No
| No
| Yes
| Yes
|
|
| No
| As above
| Available
| Available
| March 2, 2015
| March 2, 2015
|
|
|
|
| No
| Yes (J/U/E)
| Available
| Available
| March 23, 2015
| March 23, 2015
|
|
| No
| No
| No
| Yes (J/U/E)
| Available
| Available
| April 20, 2015
| April 20, 2015
| No
| No
| No
| No
| No
| Yes (J/U/E)
| Available
| Available
| June 1, 2015
| June 1, 2015
|
|
|
|
| No
| Yes (J/U/E/K)
| Available
| Available
| July 13, 2015
| July 13, 2015
| No
| No
| No
| No
| No
| Yes (J/U/E/K)
| Available
| Available
| September 14, 2015
| September 14, 2015
|
|
|
|
| No
| Yes (J/U/E)
| Available
| Available
| October 19, 2015
| October 19, 2015
|
|
|
|
| No
| Yes (J/U/E)
| Available
| Available
| November 9, 2015
| November 9, 2015
|
|
|
|
| No
| Yes (J/U/E)
| Available
| Available
| January 25, 2016
| January 25, 2016
| Yes
| Yes
| Yes
| Yes
| No
| Yes (J/U)
| Available
| Available
| February 22, 2016
| February 22, 2016
| Yes
| Yes
| Yes
| Yes
| No
| Yes (J/U/E)
| Available
| Available
| March 14, 2016
| March 14, 2016
| No
| No
| Yes
| Yes
| No
| Yes (J/U/E)
| Available
| Available
| May 9, 2016
| May 9, 2016
|
|
|
|
| No
| Yes (J/U/E)
| Available
| Available
| September 13, 2016
| September 13, 2016
| Available
| Available
| October 24, 2016
| October 24, 2016
|-
|-
| R, L, and X
| [[11.3.0-36|11.3.0-36]]
| This launches [[System Settings]] for touchscreen calibration.
|
|-
| February 6, 2017
| R, L, and Y
| See [[11.3.0-36|this]].
| This launches [[System Settings]] for circlepad calibration.
| Yes
|}
| Yes
| Yes
| No
| Available
| February 6, 2017
|-
| [[11.4.0-37|11.4.0-37]]
|
| April 10, 2017
| See [[11.4.0-37|this]].
| Yes
| Yes
| Yes
| No
| Available
| April 10, 2017
|-
| [[11.5.0-38|11.5.0-38]]
|
| July 10, 2017
| See [[11.5.0-38|this]].
|
|
|
| No
| Available
| July 10, 2017
|-
| [[11.6.0-39|11.6.0-39]]
|
| September 18, 2017
| See [[11.6.0-39|this]].
|
|
|
| No
| Available
| September 18, 2017
|-
|-
| R, X, Y, A, and B, a 3DS gamecard must be inserted as well.
| [[11.7.0-40|11.7.0-40]]
| This launches the gamecard application. Note that pressing the HOME button in the gamecard application launched this way will only result in the system shutting down.
|
| June 18, 2018
| See [[11.7.0-40|this]].
|
|
|
| No
| Available
| June 18, 2018
|-
|-
| This is used when the above path isn't used.
| [[11.8.0-41|11.8.0-41]]
| This launches System Settings for the system setup.
|
|}
| July 30, 2018
| See [[11.8.0-41|this]].
|
|
|
| No
| Available
| July 30, 2018
|-
| [[11.9.0-42|11.9.0-42]]
|
| December 3, 2018
| See [[11.9.0-42|this]].
|
|
|
| No
| Available
| December 3, 2018
|-
| [[11.10.0-43|11.10.0-43]]
|
| May 27, 2019
| See [[11.10.0-43|this]].
|
|
|
| No
| Available
| May 27, 2019
|-
|-
| [[11.11.0-43E|11.11.0-43E]]
|
| August 26, 2019
| See [[11.11.0-43E|this]].
|
|
|
| No
| Available
| August 26, 2019
|-
|-
| JPN
| [[11.12.0-44|11.12.0-44]]
| gWr4JXxb2mKTG3lq
|
| November 4, 2019
| See [[11.12.0-44|this]].
|
|
|
| No
| Available
| November 4, 2019
|-
|-
| NA
| [[11.13.0-45|11.13.0-45]]
| uuI82221UKkqmtbp
|
|-
| December 2, 2019
| EUR / Others
| See [[11.13.0-45|this]].
| UrXSeurnxhPrq7AS
|
|
|
| No
| Available
| December 2, 2019
|}
|}
"[[3DS_System_Flaws|System]]/[[3DS_Userland_Flaws|Userland]] security flaws fixed*": This includes known flaws, and any fixed flaws discovered via code bin-diff.
"[[3DS_System_Flaws|System]]/[[3DS_Userland_Flaws|Userland]] security flaws fixed*" and "3DS-mode homebrew affected" only apply to the changes done with that specific system-update("affected" does not include hax codebases breaking *just* due to updated codebins).
[[Category:Nintendo Software]]
== Auto-Boot Function ==
When the Home Menu is initially loaded by [[NS]], it checks the gamecard ExeFS:/[[SMDH|icon]] for the auto-boot flag. If the auto-boot flag is set, it will load the application on the cartridge and the home menu will not remain running in the background, or at least not in an operational state. Using software cues to return to the home menu, or sleep menu while in this state, causes a shutdown.
Notable features of demo titles:
*Auto-boot demos generally disable the functionality of the home button.
*The ''New Super Mario Bros 2'' demo, retained the functionality of the home button, and had an timer which triggered the demo to quit after a period of inactivity.
Auto-boot cartridges, can bypass some of the functions of the Home Menu. Auto Booted software:
* Doesn't show usage history in the [[Activity Log]]
* Bypasses Parental controls
* Bypasses Forced Game Card Updates
* Bypasses Initial 3DS Setup
* The console does not have a friends list presence.
* Is still subject to region lock(see below).
Region lock is still active, so the home menu will refuse to launch demos with incorrect region lock will not load, displaying "An Error has Occurred". However, game card update partition checks are not done, which allows launching demos that have region free encoding, but have an alternate(or even invalid) region update partition.
The following auto-boot paths can be used by Home Menu, checked in the same order listed below(the above gamecard auto-boot is checked before this):
{| class="wikitable"
{| class="wikitable"
! Key-combo / requirements for this path
! Description
! Description
|-
|-
| 0x0
| R, L, and X
| 0x10
| This launches [[System Settings]] for touchscreen calibration.
|-
|-
| 0x10
| R, L, and Y
| <Filesize-0x10>
| This launches [[System Settings]] for circlepad calibration.
|}
|}
The following is only checked when the low u16 from [[Config_Savegame|config]] block 0x00110000 is value zero(normally this is non-zero). Thus, the below is only handled when a system setup is required.
{| class="wikitable"
{| class="wikitable"
! Key-combo / requirements for this path
! Description
! Description
|-
|-
| 0x0
| R, X, Y, A, and B, a 3DS gamecard must be inserted as well.
| 0x8
| This launches the gamecard application. Note that pressing the HOME button in the gamecard application launched this way will only result in the system shutting down.
|-
|-
| 0x8
| This is used when the above path isn't used.
| 0x4
| This launches System Settings for the system setup.
| u32 titleversion
|}
== Region Lockout ==
One of the Home Menu's functions, is to regulate region lockout. The region lockout data for any given title is held in the [[SMDH#BNR Region|ICN data]]. There are 6 regions of which have their own region lockout, Japan, USA, Europe(including Nintendo Australia), China, Taiwan and Korea. There is also a value which makes a title exempt from region lockout, and consequently accessible from any region of 3DS.
The region-field stored in the [[SMDH|ICN-data]] is only checked when Home Menu itself launches a title, not when other titles use NS to have Home Menu launch titles. This isn't actually useful for gamecard region-free however, due to the gamecard system-updates, see below.
Also note that while some gamecard games are mostly region-free(main CXI is identical for all regions of the gamecard), those gamecards can't actually be launched with all 3DS regions due to the gamecard system-update, see below. Note that the main CXI being identical for all regions of a gamecard also means the savedata keyY is identical for all regions of that gamecard too(except for old system-version <v2.2 games, in some cases, due to different cardIDs).
== Home Menu Themes ==
=== Effects of Region Lockout ===
Every 3DS title regardless of location (NAND/SD Card/Game Card) is subject to region lockout scrutiny by the Home Menu. And the home menu treats 'out-of-region' titles by simply refusing to show them on the home menu. No messages are shown on the home menu to notify the user, the title is simply ignored. However out-of-region SD Card titles, will appear and quickly disappear, while all the SD Titles are being processed. In cases where access to the home menu GUI is not needed to launch the title (like in the case of kiosk demos), the home menu states an error has occurred, and launching of the title is stopped.
=== Game Card Updates ===
Either intentionally a region lock mechanism or not, the function which checks the game card update partition returns an error when it is detected the update is for a region other than the 3DS's region (Most likely triggered by the absence of the correct CVer title). And errors returned from checking the update partition, will result in the home menu displaying "This Game Card cannnot be used", when the user attempts to launch the title.
== Home-menu [[SpotPass]] usage ==
Home-menu originally used two domains with HTTPS for SpotPass. SpotPass stores this content in Home-menu's NAND shared extdata.
* The system notifications are downloaded from: <nowiki>https://a248.e.akamai.net/f/248/103046/10m/npdl.c.app.nintendowifi.net/p01/nsa/<regionID>/<filename>/<langcode>/<filename></nowiki> Where langcode is the two-character language codes from [[Config Savegame#Languages|config]], and regionID is from the below table. <filename> is bashoX/sysmsgX where X is 0-3.
* https://pls.c.shop.nintendowifi.net/pl/upload This URL is used for uploading data from the home menu NAND shared extdata, it's unknown what this is used for. This data is uploaded every 24 hours.
* <nowiki>https://npul.c.app.nintendowifi.net/p01/recv/<regionID>/<filename></nowiki> This is used for uploading unknown data from extdata. <filename> can be one of the following:
** "phu"
** "tiu" The POST data contains a list of [[BOSS_Services|BOSS]] taskIDs etc. This seems to be only for Nintendo titles?(system+eShop apps)
** "splu"
** "sendmgn" For this it appears SpotPass does a HTTP POST with data originally from Launcher.dat?
{| class="wikitable"
{| class="wikitable" border="1"
|-
|-
! Offset
! Region
! Size
! ID
|-
|-
| 0x0
| JPN
| 0x1
| gWr4JXxb2mKTG3lq
|-
|-
| 0x1
| NA
| 0x1
| uuI82221UKkqmtbp
|-
|-
| 0x2
| EUR / Others
| UrXSeurnxhPrq7AS
|-
|}
|}
The SpotPass content payload for notifications begin with a header, followed by an [[SMDH|icon]] and the UTF-16 text, and various metadata.
The SD ExtData [[Extdata#Filesystem|File System]] for Home Menu introduced with [[2.0.0-2|2.0.0-X]] is as follows:
=== VersionList ===
During startup, Home Menu loads "/versionList.dat" from NAND extdata 0xf000000e. This is downloaded via SpotPass, the file-data downloaded via HTTPS here is raw (no SpotPass container):
* Retail: [https://tagaya-ctr.cdn.nintendo.net/tagaya/versionlist]
* Dev-unit: [https://tagaya-dev-ctr.cdn.nintendo.net/tagaya/versionlist] The titles listed in this are not available on the [[Title list|normal]] CDN.
This is a list of title-updates available on the eShop, for regular app titles and update-titles. This is what Home Menu checks to determine whether the currently selected application needs to be updated or not. When an Internet connection is not available or wifi is disabled, Home Menu will skip VersionList handling/messages when you launch applications.
{| class="wikitable" border="1"
File structure:
{| class="wikitable"
|-
|-
! File
! Offset
! Details
! Size
! Description
! FW Introduced
|-
|-
| icon
| 0x0
| Stubbed. Always image 00000002.
| 0x10
| 0x4 Bytes
| The first u32 is normally 0x1, the rest is normally all-zero.
|-
|
| 0x10
| <Filesize-0x10>
| Title entries, 0x10-bytes each.
|}
Title entry structure:
{| class="wikitable"
|-
|-
! Offset
! Size
! Description
|-
|-
| Cache.dat
| 0x0
| Indexes and records details for the cached icon data. Always image 00000004.
| 0x8
| 0x1688 Bytes
| u64 TitleID
| [[2.0.0-2]]
|-
| [https://dl.dropboxusercontent.com/u/60710927/CTR/Sample/HomeMenuExtdata/Cache.dat Download]
| 0x8
| 0x4
| u32 titleversion
|-
|-
| CacheD.dat
| 0xC
| Cached icon data for Home Menu. Always image 00000005.
| 0x4
| 0x4cfe00 Bytes
| Unknown u32, usually zero?
|}
|}
=== Cache.dat & CacheD.dat ===
=== [[BOSS_Services|BOSS]] usage notes ===
Home Menu uses 4 hard-coded NsDataIds: 0x1, 0x2, 0x3, and 0x4, under a loop in the same function for writing to "bashotorya.dat".
== Automatic System Update Download ==
See [[Automatic System Update Download]].
== Home Menu Error Messages ==
{| class="wikitable" border="1"
{| class="wikitable"
|-
|-
! OFFSET
! Dialog Text
! SIZE
! Description
|-
|-
| 0x0
| "An error has occured. Please save your data ... then restart the system"
| 8
| This dialog is displayed when a system applet(including Home Menu) crashes/terminates. This dialog is also displayed for system errors as well.
|}
|}
== Home Menu Themes ==
See [[Home_Menu/Themes|here]].
As of [[11.0.0-33]] Home Menu themes are only supported with USA, EUR, and JPN. CHN Home Menu was last updated with v7.0, and TWN doesn't even have a Home Menu settings menu(just the old screen brightness config menu + an [[amiibo Settings]] icon on the right side of the browser icon).
=== SaveData.dat ===
KOR Home Menu doesn't have the theme-settings menu button. While this does have the theme handling code, it isn't actually usable since extdataID 0x0 is used for theme-extdata for non-<JPN/USA/EUR> regions(which is invalid).
== Home Menu [[System_SaveData|NAND]] savedata ==
=== Launcher.dat ===
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
| 0x0
| 0x0
| 0x1
| 0x1
| SaveData.dat format version.
| Launcher.dat format version.
|-
| 0x1
| 0x1
| Padding?
|-
| 0x2
| 0x2
| u16, cart launcher position on the home menu
|-
| 0x4
| 0x4
| Unknown, normally 0x0.
|-
|-
| 0x8
| 0x8
| 0xB40
| 0xB40
| 360 u64s, list of titleIDs(used with icons). Equivalent to the same array in Launcher.dat.
| 360 u64s, list of NAND titleIDs. For an unused entry, the u64 value is ~0(in that case, the corresponding entries at 0xD9A/0x106A for this titleID are not used either). This is used for the icons displayed on the main Home Menu screen.
|-
|-
| 0xB48
| 0xB51
| 0x168
| 0x1
| s8 bool array with 360 entries. Some SD-only icon array. Probably an array for each icon present status? Each entry is only known to be set to 0x00 or 0x01, with the former being the default.
| u8, numbers of rows on the home menu, minus 1 (range 0..5) (with the enlarge/reduce option)
|-
|-
| 0xCB0
| 0xB5C
| 0x2D0
| 0x2
| s16 array with 360 entries, used with icons. Equivalent to the same array in Launcher.dat. Implemented with format-version 2.
| u16, position of the cursor on the home menu
|-
|-
| 0xF80
| 0xB5E
| 0x2
| u16, horizontal scrolling level (divided by the number of rows to get the actual number of columns hidden) on the home menu
|-
| 0xD80
| 0x2 or 0x4
| u16 or u32, number the next created folder will have (starts at 1)
|-
| 0xD9A
| 0x2D0
| Array of 360 s16 fields, each one corresponds to the titleIDs at the array located at offset 0x8. This is used for icon position, 0x0 for the very first icon, 0x1 for the next one and so on. This is completely linear, no X/Y coordinates. Implemented with the format-version for [[4.0.0-7|4.0.0-X]].
|-
| 0x106A
| 0x168
| 0x168
| s8 array with 360 entries, used with icons. Equivalent to the same array in Launcher.dat. Implemented with format-version 2.
| Array of 360 s8 fields, each one corresponds to the titleIDs at the array located at offset 0x8. This is used for icon position. When an s8 here is -1(which is the normal value), the icon is located with the first chunk of icons(outbuf+0), otherwise the base address is outbuf+0xB40+<s8val*0x1E0>(which is equivalent to 60 icons * s8val). Implemented with the format-version for [[4.0.0-7|4.0.0-X]]. Corresponds to the id of the folder the icon is in, range -1..59, with -1 meaning not in a folder
|-
| 0x11DC
| 0x78
| Array of 60 s16 fields, corresponding to folders position (with -1 meaning the folder is deleted/not yet created)
|-
| 0x1434
| 0x3C
| Array of 60 u8 fields, the number of rows in each corresponding folder (defaults to 2)
|-
| 0x1470
| 0x78
| Array of 60 u16 fields, the position of the cursor in each corresponding folder (defaults to 0)
|-
|-
| 0x13b8
| 0x14E8
| 0x8
| 0x78
| Theme entry structure for the regular theme.
| Array of 60 u16 fields, the horizontal scroll level in each corresponding folder (divided by the number of rows to get the actual number of columns hidden) (defaults to 0)
|-
|-
| 0x13c0
| 0x1560
| 0x8*10(0x50)
| 0x7F8
| Array of theme entry structures for theme [[9.3.0-21|shuffling]].
| Array of 60 utf-16 strings of length 0x22 (in bytes, so only 0x11 utf-16 characters) (not NULL-terminated), the name of each corresponding folder
|-
|-
| 0x141b
| 0x1D58
| 0x1
| 0xF0
| 0 = one regular theme, 1 = multiple themes for theme [[9.3.0-21|shuffle]].
| Array of 60 u32, the number of each corresponding folder
|}
|}
The icon arrays above are handled exactly the same way as Launcher.dat.
== SD ExtData ==
The SD ExtData [[Extdata#Filesystem|File System]] for Home Menu introduced with [[2.0.0-2|2.0.0-X]] is as follows:
root
├── icon
├── boss
└── user
├── SaveData.dat
├── Cache.dat
└── CacheD.dat
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset
! File
! Details
! Size
! Size
! Description
! FW Introduced
! Plaintext
|-
|-
| 0x0
| icon
| 0x4
| Stubbed. Always image 00000002.
| Theme index: for DLC this is the content-index, for built-in themes this is an index for an array selecting the built-in theme.
| 0x4 Bytes
| n/a
|
|-
|-
| 0x4
| SaveData.dat
| 0x1
| Always image 00000003.
| Normally zero. This is the low 8-bits in the DLC titleID that this theme was originally loaded from.
| 0x2cb0 Bytes (0x2da0 starting with [[4.0.0-7]])
| [[2.0.0-2]]
| [https://dl.dropboxusercontent.com/u/60710927/CTR/Sample/HomeMenuExtdata/SaveData.dat Download]
|-
|-
| 0x5
| Cache.dat
| 0x1
| Indexes and records details for the cached icon data. Always image 00000004.
| Theme type, the valid range is 0..5. 0 = none, 1 = built-in theme from Home Menu RomFS, 2 = theme data loaded from SD cache / content archive. 3 = ?, 4 = ?, 5 = ?
| 0x1688 Bytes
| [[2.0.0-2]]
| [https://dl.dropboxusercontent.com/u/60710927/CTR/Sample/HomeMenuExtdata/Cache.dat Download]
|-
|-
| 0x6
| CacheD.dat
| 0x1
| Cached icon data for Home Menu. Always image 00000005.
| Normally zero?
| 0x4cfe00 Bytes
|-
| [[2.0.0-2]]
| 0x7
| [https://dl.dropboxusercontent.com/u/60710927/CTR/Sample/HomeMenuExtdata/CacheD.dat Download]
|}
|}
=== Cache.dat & CacheD.dat ===
These two files work in tandem to allow the home menu to cache icon data for applications which are presented on the Home Menu. The size of both files suggests a maximum cache size of 360 icons. Cache.dat stores details about the cache icon data, and CacheD.dat stores the icon data. The icon cache stores icon data for *all* applications shown on the Home Menu, this includes DSi NAND Titles, and DS(i) cartridges. The format of cached DS(i) icon data is not understood, but they are the same size as 3DS icon data (0x36c0).
In Cache.dat the first 8 bytes are a header where the first byte is the format-version, then follows each icon slots's entry in the format:
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Version value
! OFFSET
! Filesize
! SIZE
! Implemented with Home Menu system-version
! DESCRIPTION
|-
|-
| 0
| 0x0
| 0x2CB0
| 8
| [[2.0.0-2|2.0.0-X]]
| Title ID in Little Endian
|-
|-
| 2
| 0x8
| 0x2DA0
| 4
| [[4.0.0-7|4.0.0-X]]
| Unknown
|-
|-
| 3
| 0xc
| 4
| Unknown
| 4 (Latest version as of v10.6-v11.0 Home Menu)
| 0x2DA0
|}
|}
All unused entries have the Title IDs filled with "0xff".
In CacheD.dat, the icon data is concatenated together, with the first icon at offset 0x0.
=== SaveData.dat ===
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! File
! Offset
! Size
! Size
! Extdata image ID
! Description
|-
|-
| ThemeManage.bin
| 0x0
| 0x1
| SaveData.dat format version.
| 00000003
| [[9.0.0-20]]
|-
|-
| BodyCache.bin
| 0x8
| Contains cached data from the last loaded [[Home_Menu/Themes|theme]] RomFS body_LZ.bin file. The filesize must match 0x150000, otherwise the Home Menu code returns an error.
| 0xB40
| 360 u64s, list of titleIDs(used with icons). Equivalent to the same array in Launcher.dat, but for SD titles.
|-
|-
| BgmCache.bin
| 0xB48
| Contains cached data from the last loaded [[Home_Menu/Themes|theme]] RomFS bgm.bcstm file. The filesize must match 0x337000, otherwise the Home Menu code returns an error.
| 0x168
| 0x337000
| s8 bool array with 360 entries. Some SD-only icon array. Probably an array for each icon present status? Each entry is only known to be set to 0x00 or 0x01, with the former being the default.
| 00000005
|-
| [[9.0.0-20]]
| 0xCB0
| 0x2D0
| s16 array with 360 entries, used with icons. Equivalent to the same array in Launcher.dat. Implemented with format-version 2.
|-
| 0xF80
| 0x168
| s8 array with 360 entries, used with icons. Equivalent to the same array in Launcher.dat. Implemented with format-version 2.
|-
| 0x13b8
| 0x8
| Theme entry structure for the regular theme.
|-
| 0x13c0
| 0x8*10(0x50)
| Array of theme entry structures for theme [[9.3.0-21|shuffling]].
|-
|-
| nsalist
| 0x141b
| Contains the list of DLC themes(IDs+prices), downloaded via [[SpotPass]].
| 0x1
| 0 = one regular theme, 1 = multiple themes for theme [[9.3.0-21|shuffle]].
| [[9.0.0-20]]
|}
|}
The icon arrays above are handled exactly the same way as Launcher.dat.
When the theme cache is enabled via the above fields, Home Menu loads the cache at startup(if the used theme structure is valid).
Theme entry structure:
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
| 0x0
| 0x0
| 0x4
| 0x4
| Unknown, normally value 0x1?
| Theme index: for DLC this is the content-index, for built-in themes this is an index for an array selecting the built-in theme.
|-
|-
| 0x4
| 0x4
| 0x4
| 0x1
| Unknown, normally zero?
| Normally zero. This is the low 8-bits in the DLC titleID that this theme was originally loaded from.
|-
|-
| 0x8
| 0x5
| 0x4
| 0x1
| Actual size of the cached body_LZ.bin data.
| Theme type, the valid range is 0..5. 0 = none, 1 = built-in theme from Home Menu RomFS, 2 = theme data loaded from SD cache / content archive. 3 = ?, 4 = ?, 5 = ?
|-
|-
| 0xC
| 0x6
| 0x4
| 0x1
| Actual size of the cached bgm.bcstm data.
| Normally zero?
|-
|-
| 0x10
| 0x7
| 0x4
| 0x1
| Unknown
| Normally zero?
|}
|}
When the theme-type is value1 the themeindex must be <9. When the theme-type is value2 the themeindex has to be non-zero, and the u8 at offset 0x4 must not be >=10.
The theme-loader code (besides the AM <is-current-themeindex-DLC-installed> code) handles all theme-types >=2 the same way. However, it seems all DLC AM code involving checking the currently-used theme DLC only gets executed when the theme-type is value2. The code in the theme-loader for that also checks that a certain Home Menu state flag is non-zero, before running the AM DLC code(it's unknown where this flag value comes from).
== Home Menu badge SD [[Extdata|ExtData]] ==
==== SaveData.dat format versions ====
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! File
! Version value
! Details
! Filesize
! Size
! Implemented with Home Menu system-version
|-
|-
| BadgeData.dat
| 0
| [[Home_Menu#BadgeData.dat|See below.]]
| 0x2CB0
| [[2.0.0-2|2.0.0-X]]
|
|-
|-
| BadgeMngFile.dat
| 2
| [[Home_Menu#BadgeMngFile.dat|See below.]]
| 0x2DA0
| 0xD4A8
| [[4.0.0-7|4.0.0-X]]
|
|-
| [[9.0.0-20]]
| 3
| 0x2DA0
| [[9.0.0-20|9.0.0-X]]
|-
| 4 (Latest version as of v10.6-v11.0 Home Menu)
| 0x2DA0
| [[9.3.0-21|9.3.0-X]]
|}
|}
=== BadgeData.dat ===
The Home Menu code for writing the updated SaveData.dat to FS is broken when the filesize is smaller than expected due to being from an older format-version originally. When writing to the file, Home Menu checks the filesize then attempts to use [[FSFile:SetSize]] on mismatch, but [[FSFile:SetSize]] can't be used with extdata(error from [[FSFile:SetSize]] appears to be ignored). When writing to SaveData.dat the write-size is the one for the current format-version, but since extdata files are fixed-size this will only result in the first {original filesize} bytes being written(result-code = 0xE0E046C1).
Basically, unless the extdata is deleted from the SD card FS manually, the SaveData.dat filesize will never be successfully updated from an old filesize to the current-format filesize by Home Menu.
== Home Menu [[Home_Menu/Themes|Theme]] SD [[Extdata|ExtData]] ==
The filesystem for this extdata is as follows:
root
├── icon
| UTF-16 Badge Set Titles (16 per set for different languages)
├── boss
└── user
├── ThemeManage.bin
├── BodyCache.bin
├── BgmCache.bin
└── nsalist
{| class="wikitable" border="1"
|-
|-
! File
! Details
! Size
! Extdata image ID
! FW Introduced
! Plaintext
|-
|-
| 0x250F80
| ThemeManage.bin
| 100 * 0x2000
| Theme management info. The filesize must match 0x800, otherwise the Home Menu code returns an error.
| [http://en.wikipedia.org/wiki/Z-order_curve Tiled] RGB565 64x64 Badge Set Icons
| 0x800
| 00000003
| [[9.0.0-20]]
|-
|-
| 0x318F80
| BodyCache.bin
| 1000 * 0x2800
| Contains cached data from the last loaded [[Home_Menu/Themes|theme]] RomFS body_LZ.bin file. The filesize must match 0x150000, otherwise the Home Menu code returns an error.
| [http://en.wikipedia.org/wiki/Z-order_curve Tiled] RGB565 64x64 + Tiled A4 64x64 Badge Icons
| 0x150000
| 00000004
| [[9.0.0-20]]
|
|-
|-
| 0xCDCF80
| BgmCache.bin
| 1000 * 0xA00
| Contains cached data from the last loaded [[Home_Menu/Themes|theme]] RomFS bgm.bcstm file. The filesize must match 0x337000, otherwise the Home Menu code returns an error.
| [http://en.wikipedia.org/wiki/Z-order_curve Tiled] RGB565 32x32 + Tiled A4 32x32 Badge Icons
| 0x337000
|}
| 00000005
| [[9.0.0-20]]
=== BadgeMngFile.dat ===
|-
| nsalist
| Contains the list of DLC themes(IDs+prices), downloaded via [[SpotPass]].
|
| 00000007
| [[9.0.0-20]]
|}
BodyCache.bin and BgmCache.bin contain cached theme data for the currently used DLC theme. ThemeManage.bin is loaded by Home Menu during startup. The cached theme data is loaded at startup when a DLC theme is selected. This also contains theme-shop [[SpotPass]] data.
BodyCache.bin and BgmCache.bin are all-zero when no theme is selected.
Starting with [[9.3.0-21|9.3.0-X]] Home Menu can use more files in this extdata, for theme shuffling. "theme:/ThemeManage.bin" "theme:/BgmCache_%02d.bin" "theme:/BodyCache_rd.bin"
=== ThemeManage.bin ===
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
| 0x0
| 0x0
| 0x4
| 0x4
| u32, Must Be Zero
| Unknown, normally value 0x1?
|-
|-
| 0x4
| 0x4
| 0x4
| 0x4
| u32, Number of Badge Sets
| Unknown, normally zero?
|-
|-
| 0x8
| 0x8
| 0x4
| 0x4
| u32, Number of Unique Badges
| Actual size of the cached body_LZ.bin data.
|-
|-
| 0xC
| 0xC
| 0x4
| 0x4
| u32, Number of Placed Badges
| Actual size of the cached bgm.bcstm data.
|-
|-
| 0x10
| 0x10
| 0x4
| 0x4
| u32, Selected Badge Set in Home Menu (0xFFFFFFFF = All Badges)
| Unknown
|-
|-
| 0x14
| 0x14
| 0x4
| 0x4
| u32, Selected Badge Column in All Badges
| Unknown
|-
|-
| 0x18
| 0x18
| 0x4
| 0x4
| u32, Number of Total Badges
| When a DLC theme is selected, this is the content-index of the DLC theme.
|-
|-
| 0x1C
| 0x1C
| 0x4
| 0x4
| u32, Nintendo Network ID Number
| Unknown, usually value 0x200 when the data in theme-cache is actually used?
|}
The total filesize is 0x800-bytes, normally the data starting at offset 0x1C is all-zero.
When no theme is actually used, the only non-zero fields are the following: the u32 stored at offset 0x0 in ThemeManage.bin is value 0x1, with offset 0x10 u32 set to value 0x1.
== Home Menu badge SD [[Extdata|ExtData]] ==
The filesystem for this extdata(when it actually exists) is as follows:
root
├── icon
├── boss
└── user
├── BadgeData.dat
└── BadgeMngFile.dat
{| class="wikitable" border="1"
|-
|-
! File
! Details
! Size
! Extdata image ID
! FW Introduced
|-
|-
| 0x358
| BadgeData.dat
| 0x80
| [[Home_Menu#BadgeData.dat|See below.]]
| Used Badge Slots (each bit = 1 slot)
| 0xF4DF80
|
| [[9.0.0-20]]
|-
|-
| 0x3D8
| BadgeMngFile.dat
| 0x10
| [[Home_Menu#BadgeMngFile.dat|See below.]]
| Used Badge Set Slots (each bit = 1 slot)
| 0xD4A8
|
| [[9.0.0-20]]
|}
=== BadgeData.dat ===
{| class="wikitable" border="1"
|-
|-
! Offset
! Offset
! Size
! Size
! Description
! Description
|-
|-
| 0x0
| 0x0
| 0x4
| 100 * 16 * 0x8A
| u32, Unknown
| UTF-16 Badge Set Titles (16 per set for different languages)
|-
|-
| 0x4
| 0x35E80
| 0x4
| 1000 * 16 * 0x8A
| u32, Badge ID
| UTF-16 Badge Titles (16 per set for different languages)
|-
|-
| 0x8
| 0x250F80
| 0x4
| 100 * 0x2000
| u32, Badge Set ID
| [http://en.wikipedia.org/wiki/Z-order_curve Tiled] RGB565 64x64 Badge Set Icons
|-
|-
| 0xC
| 0x318F80
| 0x2
| 1000 * 0x2800
| u16, Badge Index
| [http://en.wikipedia.org/wiki/Z-order_curve Tiled] RGB565 64x64 + Tiled A4 64x64 Badge Icons
|-
|-
| 0xE
| 0xCDCF80
| 0x2
| 1000 * 0xA00
| u16, Badge Sub ID (used for multi-part badges)
| [http://en.wikipedia.org/wiki/Z-order_curve Tiled] RGB565 32x32 + Tiled A4 32x32 Badge Icons
|}
|}
==== BadgeSetIdentifier ====
=== BadgeMngFile.dat ===
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
| 0x0
| 0x0
| 0x4
| 0x4
| u32, Unknown (Usually 0xFFFFFFFF)
| u32, Must Be Zero
|-
|-
| 0x4
| 0x4
| 0x4
| 0x4
| u32, Unknown (Usually 0xFFFFFFFF)
| u32, Number of Badge Sets
|-
|-
| 0x8
| 0x8
| 0x4
| 0x4
| u32, Unknown (Usually 0x0)
| u32, Number of Unique Badges
|-
|-
| 0xC
| 0xC
| 0x4
| 0x4
| u32, Unknown (Usually 0x2710)
| u32, Number of Placed Badges
|-
|-
| 0x10
| 0x10
| 0x4
| 0x4
| u32, Badge Set ID
| u32, Selected Badge Set in Home Menu (0xFFFFFFFF = All Badges)
|-
|-
| 0x14
| 0x14
| 0x4
| 0x4
| u32, Badge Set Index
| u32, Selected Badge Column in All Badges
|-
|-
| 0x18
| 0x4
| u32, Number of Total Badges
|-
|-
| 0x0
| 0x1C
| 0x10
| 0x4
| [[Home_Menu#BadgeIdentifier|BadgeIdentifier]]
| u32, Nintendo Network ID Number
|-
|-
| 0x10
| 0x20
| 0x2
| 0x338
| u16, Number Placed
| Unknown (always zeros? unused?)
|-
|-
| 0x12
| 0x358
| 0x2
| 0x80
| u16, Quantity
| Used Badge Slots (each bit = 1 slot)
|-
|-
| 0x14
| 0x3D8
| 0x10
| 0x10
| u64[2], Shortcut Title ID (twice, once per u64)
| Used Badge Set Slots (each bit = 1 slot)
|-
|-
! Offset
| 0x3E8
! Size
| 1000 * 0x28
| [[Home_Menu#BadgeInfo|BadgeInfo]] Entries
|-
| 0xA028
| 100 * 0x30
| [[Home_Menu#BadgeSetInfo|BadgeSetInfo]] Entries
|-
| 0xB2E8
| 360 * 0x18
| [[Home_Menu#BadgeLayoutSlot|BadgeLayoutSlot]] Entries
|}
==== BadgeIdentifier ====
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
! Description
|-
|-
| 0x0
| 0x0
| 0x18
| 0x4
| [[Home_Menu#BadgeSetIdentifier|BadgeSetIdentifier]]
| u32, Unknown
|-
|-
| 0x4
| 0x4
| 0x4
| 0x4
| u32, Number of Unique Badges
| u32, Badge ID
|-
|-
| 0x20
| 0x8
| 0x4
| 0x4
| u32, Number of Total Badges
| u32, Badge Set ID
|-
|-
| 0x24
| 0xC
| 0x4
| 0x2
| u32, Start Badge Index
| u16, Badge Index
|-
|-
| 0x28
| 0xE
| 0x4
| 0x2
| u32, Unknown (usually 0x0)
| u16, Badge Sub ID (used for multi-part badges)
|}
|}
==== BadgeLayoutSlot ====
==== BadgeSetIdentifier ====
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
|-
|-
| 0x0
| 0x0
| 0x10
| 0x4
| [[Home_Menu#BadgeIdentifier|BadgeIdentifier]]
| u32, Unknown (Usually 0xFFFFFFFF)
|-
|-
| 0x4
| 0x4
| u32, Position
| 0x4
| u32, Unknown (Usually 0xFFFFFFFF)
|-
| 0x8
| 0x4
| u32, Unknown (Usually 0x0)
|-
| 0xC
| 0x4
| u32, Unknown (Usually 0x2710)
|-
| 0x10
| 0x4
| u32, Badge Set ID
|-
|-
| 0x14
| 0x14
| 0x4
| 0x4
| u32, Folder (0xF0FF = Icon of a folder, 0xFFFFFFFF = No folder)
| u32, Badge Set Index
|}
|}
==== BadgeInfo ====
{| class="wikitable" border="1"
== Home Menu theme layout SD [[Extdata|ExtData]] ==
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x10
| [[Home_Menu#BadgeIdentifier|BadgeIdentifier]]
|-
| 0x10
| 0x2
| u16, Number Placed
|-
| 0x12
| 0x2
| u16, Quantity
|-
| 0x14
| 0x4
| u32, Unknown (packed data?)
|-
|-
| 0x18
! Details
| 0x10
| u64[2], Shortcut Title ID (twice, once per u64)
|}
==== BadgeSetInfo ====
{| class="wikitable" border="1"
|-
! Offset
! Size
! Size
! Extdata image ID
! Description
|-
| 0x0
| 0x18
| [[Home_Menu#BadgeSetIdentifier|BadgeSetIdentifier]]
|-
| 0x18
| 0x4
| u32, Unknown (usually 0xFFFFFFFF)
|-
| 0x1C
| 0x4
| u32, Number of Unique Badges
|-
| 0x20
| 0x4
| u32, Number of Total Badges
|-
| 0x24
| 0x4
| u32, Start Badge Index
|-
| 0x28
| 0x4
| u32, Unknown (usually 0x0)
|-
| 0x2C
| 0x4
| u32, Unknown (usually 0x0)
|}
==== BadgeLayoutSlot ====
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x10
| [[Home_Menu#BadgeIdentifier|BadgeIdentifier]]
|-
| 0x10
| 0x4
| u32, Position
|-
| 0x14
| 0x4
| u32, Folder (0xF0FF = Icon of a folder, 0xFFFFFFFF = No folder)
|}
The file size must match 0xD4A8, otherwise the Home Menu code returns an error.
== Home Menu theme layout SD [[Extdata|ExtData]] ==
The filesystem for this extdata(when it actually exists) is as follows:
root
├── icon
├── boss
└── user
└── MngFile.dat
{| class="wikitable" border="1"
|-
! File
! Details
! Size
! Extdata image ID
! FW Introduced
! FW Introduced
! Plaintext
! Plaintext
|-
| MngFile.dat
| See below.
| 0x004D1280
| 00000003
| [[9.6.0-24]]
|}
=== MngFile.dat ===
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x4
| u32, must be zero.
|-
| 0x4
| 0xC
| array of 8 u8, 0 if the corresponding layout slot is not set, 1 if it is
|-
| 0xC
| 0x3000 * 8
| Start of the layout entries.
|-
| 0x1800C
| 0xC
| Padding
|-
|-
| MngFile.dat
| 0x18010
| 0x2DA0 * 8
| 0x004D1280
| Start of the [[Home_Menu#SaveData.dat|SaveData.dat]] entries.
| [[9.6.0-24]]
|-
|-
| 0x0
| 0x2ED10
| 0x4
| 0xD4A8 * 8
| u32, must be zero.
| Start of the [[Home_Menu#BadgeMngFile.dat|BadgeMngFile.dat]] entries.
|-
|-
| 0x4
| 0x99250
| 0x4
| 0x30
| u32, total number of stored layouts.
| Padding
|-
|-
| 0x8
| 0x99280
| 0x4
| 256*3*8 * 400/8 * 8
| ?
| Start of the top screen (400x240) screenshots, in BGR8 tiled format, rotated 90 degrees and with 8 rows per "chunk", and actually 256 pixels wide instead of 240, with the last 16 being all black
|-
|-
| 0xC
| 0x2F1280
| ?
| 256*3*8 * 320/8 * 8
| Start of the layout entries.
| Start of the bottom screen (320x240) screenshots, in BGR8 tiled format, rotated 90 degrees and with 8 rows per "chunk", and actually 256 pixels wide instead of 240, with the last 16 being all black
|}
|}
| 0x0
| 0x0
| 0x2558
| 0x2558
| Exact copy of the entire Home Menu [[System_SaveData]] Launcher.dat, this is the actual layout data.
| Exact copy of the entire Home Menu [[System_SaveData]] [[Home_Menu#Launcher.dat|Launcher.dat]], this is the actual layout data.
|-
|-
| 0x2558
| 0x2558
| ?
| 0xAA8
| Layout preview screenshot gfx data, displayed by the Home Menu layout settings menu.
| Padding
|}
|}