3DS HomeMenu extdata Tool 3DS: Difference between revisions

Revision as of 06:59, 7 July 2021

3DS HomeMenu extdata Tool is a Nintendo 3DS homebrew tool for accessing the Home Menu SD extdata, this is usable from Ninjhax. This allows reading/writing the home-menu SD extdata SaveData.dat, and the extdata theme-cache.

This essentially allows user to write custom themes to SD extdata (e.g. Ninjhax/Gateway), which home-menu will automatically load at Home Menu process next startup.

Installation

Installing

Copy the folder containing .3dxs and .smdh to the the 3ds folder on your SD card. Launch it via homebrew launcher.

Compiling

This requires the latest ctrulib from git.

If you build a CXI/CIA for this, the accessinfo must have bitmask 0x01 set (in the RSF that's FileSystemAccess with field - CategorySystemApplication).

User guide

Before modifying

Backing up extdata before modifying it at all is recommended:

You can copy the data from sdmc:/Nintendo 3DS/{ID0}/{ID1}/extdata/00000000/{extdataIDlow}/ to elsewhere, where extdataIDlow is the extdataIDs for home-menu extdata and theme extdata.

Main menu

Copy extdata SaveData.dat to sd - Option to backup your SaveData.dat to SD (this contains the current theme settings and other things).
Copy SaveData.dat from sd to extdata - Option to restore your SaveData.dat from SD.
Enable normal theme-cache - Ooption to enable using the theme-data from SD. Do not use this if you don't have any theme DLC installed, use the below menu option instead.
Enable persistent theme-cache - Same as above except the custom themes are persistent even without any theme DLC installed.
Copy theme-data from extdata to sd - Option to backup the theme-data stored in extdata.
Copy theme-data from sd to extdata - Option to write a custom theme to extdata.

Theme-data

The data this app reads/writes to/from sdmc is located in the same directory that the app runs from (SD root for CXI/CIA). The theme-data this app uses on sdmc is the following.

ThemeManage.bin - Copied from extdata to sdmc.
- This can be copied to extdata from sdmc, if it doesn't exist on sdmc for that then data is generated for it then writen to extdata.
BodyCache.bin and body_LZ.bin - The former is copied from extdata to sdmc.
- When copying from sdmc to extdata, the app will first attempt to use BodyCache.bin, then body_LZ.bin.
- When ThemeManage.bin exists on sdmc with sdmc->extdata, this body-data is only copied when the size field in ThemeManage.bin for this is non-zero.
- When copying to extdata, the filesize must be smaller than or exactly 0x150000-bytes.
BgmCache.bin and bgm.bcstm - Handled basically the same way as the body-data, except with the bgm sizes.
- When copying to extdata, the filesize must be smaller than or exactly 0x337000-bytes.
- When writing BGM to extdata, Home Menu must not be already using any BGM from the theme-cache (prior to when this tool wrote anything to extdata).

Disable theme-cache

To disable using the theme-cache, you can:

Either enter home-menu theme-settings then select none, restore a backup of SaveData.dat with this tool, restore the entire home-menu and/or theme extdata with the above backup.
Or delete the homemenu and/or theme extdata.

Controls

D-Pad/C-Pad - Select a menu entry

A - Enter a menu

B - Return to the hbmenu

Known issues

Please refer to reported issues.

Changelog

v1.1.1

Updated for latest ctrulib+devkitARM.
Set the icon strings to proper values.
Replaced the 5-second-delay with a press-button-wait.

v1.1 6 Jan 2015

Custom theme persistence even without any theme DLC installed, and other minor fixes/changes.

v1.0 31 Dec 2014

Initial release. Extract this to the root of your SD for use with ninjhax.

External links

GitHub - https://github.com/yellows8/3ds_homemenu_extdatatool
3dbrew - http://3dbrew.org/wiki/Home_Menu

@@ Line 1: / Line 1: @@
 {{Infobox 3DS homebrew
-| title = 3DS HomeMenu extdata Tool
+| title = 3DS homemenu ext data Tool
 | image = https://dlhb.gamebrew.org/3dshomebrew/3DSHomeMenuextdataTool-01.jpg|250px
 | type = Utilities
-| version = v1.1.1
+| version = v1.1.1 (9 Jul 2015)
 | licence = Mixed
 | author = yellows8
@@ Line 10: / Line 10: @@
 | source = https://dlhb.gamebrew.org/3dshomebrew/3ds_homemenu_extdatatool_v111.rar
 }}
-This is a Nintendo 3DS homebrew tool for accessing the Home Menu SD extdata, this is usable from ninjhax. This allows reading/writing the home-menu SD extdata SaveData.dat, and the extdata theme-cache.
-This essentially allows the user to write custom themes to SD extdata, which home-menu will automatically load at Home Menu process next startup.
+DS HomeMenu extdata Tool is a Nintendo 3DS homebrew tool for accessing the Home Menu SD extdata, this is usable from Ninjhax. This allows reading/writing the home-menu SD extdata SaveData.dat, and the extdata theme-cache.
-== Compiling ==
+This essentially allows user to write custom themes to SD extdata (e.g. Ninjhax/Gateway), which home-menu will automatically load at Home Menu process next startup.
+==Installation==
+===Installing===
+Copy the folder containing .3dxs and .smdh to the the 3ds folder on your SD card. Launch it via homebrew launcher.
+===Compiling===
 This requires the latest ctrulib from git.
-If you build a CXI/CIA for this, the accessinfo must have bitmask 0x01 set(in the RSF that's &quot;FileSystemAccess&quot; with field &quot;- CategorySystemApplication&quot;).
+If you build a CXI/CIA for this, the accessinfo must have bitmask 0x01 set (in the RSF that's <code>FileSystemAccess</code> with field <code>- CategorySystemApplication</code>).
+==User guide==
+===Before modifying===
+Backing up [http://3dbrew.org/wiki/Extdata extdata] before modifying it at all is recommended:
+You can copy the data from <code>sdmc:/Nintendo 3DS/{ID0}/{ID1}/extdata/00000000/{extdataIDlow}/</code> to elsewhere, where extdataIDlow is the extdataIDs for home-menu extdata and theme extdata.
+===Main menu===
+* Copy extdata SaveData.dat to sd - Option to backup your SaveData.dat to SD (this contains the current theme settings and other things).
+* Copy SaveData.dat from sd to extdata - Option to restore your SaveData.dat from SD.
+* Enable normal theme-cache - Ooption to enable using the theme-data from SD. Do not use this if you don't have any theme DLC installed, use the below menu option instead.
+* Enable persistent theme-cache - Same as above except the custom themes are persistent even without any theme DLC installed.
+* Copy theme-data from extdata to sd - Option to backup the theme-data stored in extdata.
+* Copy theme-data from sd to extdata - Option to write a custom theme to extdata.
+===Theme-data===
+The data this app reads/writes to/from sdmc is located in the same directory that the app runs from (SD root for CXI/CIA). The theme-data this app uses on sdmc is the following.
+* '''ThemeManage.bin''' - Copied from extdata to sdmc.
+** This can be copied to extdata from sdmc, if it doesn't exist on sdmc for that then data is generated for it then writen to extdata.
+* '''BodyCache.bin and body_LZ.bin''' - The former is copied from extdata to sdmc.
+** When copying from sdmc to extdata, the app will first attempt to use BodyCache.bin, then body_LZ.bin.
+** When ThemeManage.bin exists on sdmc with sdmc->extdata, this body-data is only copied when the size field in ThemeManage.bin for this is non-zero.
+** When copying to extdata, the filesize must be smaller than or exactly 0x150000-bytes.
+* '''BgmCache.bin and bgm.bcstm''' - Handled basically the same way as the body-data, except with the bgm sizes.
+** When copying to extdata, the filesize must be smaller than or exactly 0x337000-bytes.
+** When writing BGM to extdata, Home Menu must not be already using any BGM from the theme-cache (prior to when this tool wrote anything to extdata).
+===Disable theme-cache===
+To disable using the theme-cache, you can:
+* Either enter home-menu theme-settings then select none, restore a backup of SaveData.dat with this tool, restore the entire home-menu and/or theme extdata with the above backup.
+* Or delete the homemenu and/or theme extdata.
+==Controls==
+D-Pad/C-Pad - Select a menu entry
-== Usage ==
+A - Enter a menu
-Backing up extdata before modifying it at all is recommended: you can copy the data from &quot;sdmc:/Nintendo 3DS/{ID0}/{ID1}/extdata/00000000/{extdataIDlow}/&quot; to elsewhere, where extdataIDlow is the extdataIDs for home-menu extdata and theme extdata: [http://3dbrew.org/wiki/Extdata http://3dbrew.org/wiki/Extdata]
+B - Return to the hbmenu
-If you want to disable using the theme-cache, you can either enter home-menu theme-settings then select none, restore a backup of SaveData.dat with this tool, restore the entire home-menu and/or theme extdata with the above backup, or delete the homemenu and/or theme extdata.
+==Known issues==
+Please refer to [https://github.com/yellows8/3ds_homemenu_extdatatool/issues reported issues].
-Once the main-menu loads(after opening the extdata archives), use the D-Pad/Circle-Pad to select a menu entry. Press A to enter a menu. When at the main-menu, press B to return to the hbmenu.
+==Changelog==
+'''v1.1.1'''
+* Updated for latest ctrulib+devkitARM.
+* Set the icon strings to proper values.
+* Replaced the 5-second-delay with a press-button-wait.
-==Main menu:==
+'''v1.1 6 Jan 2015'''
+* Custom theme persistence even without any theme DLC installed, and other minor fixes/changes.
-* &quot;Copy extdata SaveData.dat to sd&quot; This can be used to backup your SaveData.dat to SD(this contains the current theme settings and other things).
+'''v1.0 31 Dec 2014'''
-* &quot;Copy SaveData.dat from sd to extdata&quot; This can be used to restore your SaveData.dat from SD.
+* Initial release. Extract this to the root of your SD for use with ninjhax.
-* &quot;Enable normal theme-cache&quot; This enables using the theme-data from SD. Do not use this if you don't have any theme DLC installed([[../../issues/1|#1]]), use the below menu option instead.
-* &quot;Enable persistent theme-cache&quot; Same as above except the custom themes are persistent even without any theme DLC installed.
-* &quot;Copy theme-data from extdata to sd&quot; This can be used to backup the theme-data stored in extdata.
-* &quot;Copy theme-data from sd to extdata&quot; This can be used to write a custom theme to extdata.
-'''The data this app reads/writes to/from sdmc is located in the same directory that the app runs from(SD root for CXI/CIA). The theme-data this app uses on sdmc is the following:'''
+==External links==
+* GitHub - https://github.com/yellows8/3ds_homemenu_extdatatool
+* 3dbrew - http://3dbrew.org/wiki/Home_Menu
-* &quot;ThemeManage.bin&quot; This is copied from extdata to sdmc. This can be copied to extdata from sdmc, if it doesn't exist on sdmc for that then data is generated for it then writen to extdata.
+[[Category:3DS homebrew application]]
-* &quot;BodyCache.bin&quot; and &quot;body_LZ.bin&quot;: The former is copied from extdata to sdmc. When copying from sdmc to extdata, the app will first attempt to use &quot;BodyCache.bin&quot;, then &quot;body_LZ.bin&quot;. When ThemeManage.bin exists on sdmc with sdmc-&gt;extdata, this body-data is only copied when the size field in ThemeManage.bin for this is non-zero. When copying to extdata, the filesize must be smaller than or exactly 0x150000-bytes.
+[[Category:Homebrew utility applications on 3DS]]
-* &quot;BgmCache.bin&quot; and &quot;bgm.bcstm&quot;: Handled basically the same way as the body-data, except with the bgm sizes. When copying to extdata, the filesize must be smaller than or exactly 0x337000-bytes. When writing BGM to extdata, Home Menu ''must'' ''not'' be already using any BGM from the theme-cache(prior to when this tool wrote anything to extdata), otherwise this issue occurs: [[../../issues/3|#3]].