Toggle menu
Toggle personal menu
Not logged in
Your IP address will be publicly visible if you make any edits.

3DS:Luma3DS/Configuration: Difference between revisions

From Hacks Guide Wiki
(add features from luma v12)
(update info to match luma v13, swap a few {{B}} with {{Key press}}, minor misc. revisions)
Line 15: Line 15:


==Navigating Luma3DS configuration==
==Navigating Luma3DS configuration==
{{info|If your {{B|Select}}, {{B|Start}}, {{B|D-Pad Up}}, {{B|D-Pad Down}}, or {{B|A}} keys are broken, you will be unable to perform most functions in Luma3DS configuration. As an alternative, you can manually modify all options that are in the Luma3DS configuration by modifying the <code>config.ini</code> file in the <code>luma</code> folder (as of Luma3DS v12.0).}}
{{info|If your {{B|Select}}, {{Key press|Up}}, {{Key press|Down}}, or {{B|A}} buttons are broken, you will be unable to use the Luma3DS configuration. As an alternative, you can manually modify all options that are in the Luma3DS configuration by modifying the <code>config.ini</code> file in the <code>luma</code> folder (as of Luma3DS v12.0).}}
You can access Luma3DS configuration by holding {{B|Select}} while powering on your device.<br>
You can access Luma3DS configuration by holding {{B|Select}} while powering on your device.<br>
When in the Luma3DS configuration menu, you can use the {{B|D-Pad Up}} and {{B|D-Pad Down}} D-Pad buttons to highlight different options. Press {{B|A}} to enable, disable, or cycle through the options. The currently highlighted option will be coloured a different colour from the rest of the configuration menu and an option that is currently enabled will be indicated with <code>(x)</code>. For example, <code>(x) Show NAND or user string in System Settings</code> indicates that the "Show NAND or user string in System Settings" option is enabled.<br>
When in the Luma3DS configuration menu, you can use the {{Key press|Up}} and {{Key press|Down}} buttons to highlight different options. Press {{B|A}} to enable, disable, or cycle through the options. The currently highlighted option will be coloured differently from the rest of the configuration menu, and an option that is currently enabled will be indicated with <code>(x)</code>. For example, <code>(x) Show NAND or user string in System Settings</code> indicates that the "Show NAND or user string in System Settings" option is enabled.<br>
Once you are done configuring Luma3DS, press the {{B|Start}} button to save your configuration. If you have enabled a PIN, you will be told to set it; otherwise, the 3DS will reboot into the HOME Menu.
Once you are done configuring Luma3DS, either select the '''Save and exit''' option or press the {{B|Start}} button to save your configuration. If the PIN setting is enabled, you will be told to set it; otherwise, the 3DS will immediately reboot.


==Luma3DS configuration options==
==Luma3DS configuration options==
Line 31: Line 31:


====PIN lock====
====PIN lock====
Determines whether Luma3DS will require a PIN to be entered when powering on your device. You will be prompted to set the PIN after pressing {{B|Start}} to save the configuration. For more information, see [[3DS:Luma3DS/PIN lock]].
Determines whether Luma3DS will require a PIN to be entered when powering on your device. You will be prompted to set the PIN after saving the configuration. For more information, see [[3DS:Luma3DS/PIN lock]].


====New 3DS CPU====
====New 3DS CPU====
Line 42: Line 42:
if DSi is chosen, by default this will attempt to boot to the {{GitHub|devkitPro/nds-hb-menu/releases/latest|nds-hb-menu}} - if this is not installed, it will boot to an exception instead.
if DSi is chosen, by default this will attempt to boot to the {{GitHub|devkitPro/nds-hb-menu/releases/latest|nds-hb-menu}} - if this is not installed, it will boot to an exception instead.


The title IDs used for this can be configured in the <code>config.ini</code> file.
The title IDs used for each of these options can be configured in the <code>config.ini</code> file.




Line 53: Line 53:
When enabled, Luma3DS will load modded game files. This option will not do anything unless you have any files to load, which should be placed in <code>/luma/titles/(title ID of game)</code>.<br>
When enabled, Luma3DS will load modded game files. This option will not do anything unless you have any files to load, which should be placed in <code>/luma/titles/(title ID of game)</code>.<br>
You will often enable this option if you are planning to use game mods via LayeredFS, such as translation patches or ROM hacks.<br>
You will often enable this option if you are planning to use game mods via LayeredFS, such as translation patches or ROM hacks.<br>
You will also need this option if you need to manually specify the locale for games that don't work despite Luma3DS's region-free patch. For more information, see [[3DS:Setting game locales]].
You will also need this option if you need to manually specify the locale for games that fail to work despite Luma3DS's region-free patch. For more information, see [[3DS:Setting game locales]].


====Redirect app. syscore threads to core2====
==== Redirect app. syscore threads to core2 ====
{{info|This option can only be used on a new 3DS/2DS.}}
{{info|This option can only be used on a new 3DS/2DS.}}
When enabled, Luma3DS will move some application threads to core2, which usually goes unused despite being intended for applications. This will boost performance on games that benefit from the New 3DS CPU setting (like Pokemon US/UM) by around 10%, but may also break some games and applications.
When enabled, Luma3DS will move some application threads to core2, which usually goes unused despite being intended for applications. This will boost performance on resource-intensive games (like Pokemon US/UM) by around 10%, but may also break some games and applications.


====Show NAND or user string in System Settings====
==== Show NAND or user string in System Settings ====
When enabled, Luma3DS will show its own (or a user-specified) version string in System Settings. For example, the default version string of an unmodded 3DS on 11.16.0-49U would be <code>Ver. 11.16.0-49U</code>. With this option enabled, the version string would instead show <code>Sys. 11.16.0-49U</code>. This serves as a decent custom firmware check, but it is not comprehensive since the option can be disabled at will.
When enabled, Luma3DS will show its own (or a user-specified) version string in System Settings. For example, the default version string of an unmodded 3DS on 11.16.0-49U would be <code>Ver. 11.16.0-49U</code>. With this option enabled, the version string would instead show <code>Sys. 11.16.0-49U</code>. This serves as a decent custom firmware check, but it is not comprehensive since the option can be disabled at will.


A custom version string of up to '''19 characters''' can also be manually specified by creating a file with the custom string called <code>customversion_sys.txt</code> and putting it inside the <code>luma</code> folder.
A custom version string of up to '''19 characters''' can also be manually specified by creating a file with the custom string called <code>customversion_sys.txt</code> and putting it inside the <code>luma</code> folder.


====Show GBA boot screen in patched AGB_FIRM====
==== Show GBA boot screen in patched AGB_FIRM ====
When enabled, Luma3DS will show the [https://www.youtube.com/watch?v=6_ZD3FxMcvQ GBA boot screen] when loading a GBA game through the built-in GBA firmware of the 3DS (such as through virtual console).
When enabled, Luma3DS will show the [https://www.youtube.com/watch?v=6_ZD3FxMcvQ GBA boot screen] when loading a GBA game through the built-in GBA firmware of the 3DS (such as through virtual console).


====Force routing audio output through headphones====
==== Force routing audio output through headphones ====
Forces all audio output except for the camera shutter to go to the headphones. Because Luma3DS only directly affects NATIVE_FIRM, this will not work in DS games, GBA games, payloads such as GodMode9, or [[3DS:Safe Mode]].
Forces all audio output except for the camera shutter to go to the headphones. Because Luma3DS only directly affects NATIVE_FIRM, this will not work in DS games, GBA games, payloads such as GodMode9, or [[3DS:Safe Mode|Safe Mode]].


Due to software limitations, this will stop working temporarily if you unplug and then replug headphones. Close and reopen the screen when this happens to fix it.
Due to software limitations, this will stop working temporarily if you unplug and then replug headphones. Close and reopen the screen when this happens to fix it.




===EmuNAND/RedNAND only===
=== EmuNAND/RedNAND only ===
{{info|These options will only appear if your currently inserted SD card has an [[3DS:EmuNAND and RedNAND|EmuNAND/RedNAND]] set up. These are almost entirely unneeded by now, however, and should instead be [[3dsguide:move-emunand|moved into the SysNAND]] unless you are dealing with CHN/KOR regioned fonts.}}
{{info|These options will only appear if your currently inserted SD card has an [[3DS:EmuNAND and RedNAND|EmuNAND/RedNAND]] set up. These are almost entirely unneeded by now, however, and should instead be [[3dsguide:move-emunand|moved into the SysNAND]] unless you are using them to deal with Chinese/Korean fonts.}}


====Default EmuNAND====
==== Default EmuNAND ====
It is possible to have multiple EmuNANDs on one SD card. This option changes which one to boot into by default. If you only have one EmuNAND, this option will not do anything.<br>
It is possible to have multiple EmuNANDs on one SD card. This option changes which one to boot into by default. If you only have one EmuNAND, this option will not do anything.<br>
You can also specify which EmuNAND to boot into by holding a certain button while booting ({{B|D-Pad Up}} for 1, {{B|D-Pad Right}} for 2, {{B|D-Pad Down}} for 3, {{B|D-Pad Left}} for 4).
You can also manually specify which EmuNAND to boot into by holding a certain direction on the D-Pad while powering on: {{Key press|Up}} for 1, {{Key press|Right}} for 2, {{Key press|Down}} for 3, {{Key press|Left}} for 4.


====Autoboot EmuNAND====
==== Autoboot EmuNAND ====
Determines whether EmuNAND will automatically boot when you turn on your 3DS without holding any buttons. If this option is disabled, you will boot into SysNAND by default. You can force the 3DS to boot into SysNAND, even with this option enabled, by holding {{B|L}} on boot, and vice versa.
Determines whether the emuNAND will automatically boot when you turn on your 3DS without holding any buttons. If this option is disabled, you will boot into the sysNAND by default. Holding {{B|L}} when powering on will invert this logic, meaning the 3DS will boot into sysNAND even when this option is enabled (or into emuNAND if it's disabled).


====Use EmuNAND FIRM if booting with R====
If this option is enabled, you will be able to use EmuNAND's NATIVE_FIRM instead of SysNAND's NATIVE_FIRM by holding the {{B|R}} button while powering on.


You probably don't need to touch this option unless you have very specific use cases that won't be covered here.
== Configuration options in config.ini ==


As of Luma3DS v11.0, certain options have been moved and can only be edited in the <code>config.ini</code> file, located in both <code>SD:/luma/config.ini</code> and <code>[1]:/rw/luma/config.ini</code>. This section documents those options.


==Configuration options in config.ini==
==== config_version_major, config_version_minor ====
 
As of Luma3DS v11.0, certain options have been moved and can only be edited in the <code>config.ini</code> file in <code>SD:/luma/config.ini</code> or <code>CTRNAND:/rw/luma/config.ini</code>. This section documents those options.
 
====config_version_major, config_version_minor====
{{warning|There is no reason to touch this option, and doing so may reset your Luma3DS configuration.}}
{{warning|There is no reason to touch this option, and doing so may reset your Luma3DS configuration.}}
Luma3DS uses these lines to determine what revision of <code>config.ini</code> is being used to prevent inconsistencies between Luma3DS updates. '''Do not touch these options'''.
Luma3DS uses these lines to determine what revision of <code>config.ini</code> is being used to prevent inconsistencies between Luma3DS updates. '''Do not touch these options'''.


====splash_duration_ms====
==== splash_duration_ms ====
Determines for how many milliseconds the splash screen should be displayed, up to 2,147,483,647 milliseconds. For more information, see [[3DS:Splash screens]].
Determines for how many milliseconds the splash screen should be displayed, up to 2,147,483,647 milliseconds. For more information, see [[3DS:Splash screens]].


====autoboot_dsi_titleid====
==== autoboot_dsi_titleid ====
Determines the DSi title to boot into when <code>autoboot_3ds_homebrew</code> is set to 2. The selected title must be installed on the NAND, or it will instead crash on boot - the default app used is {{GitHub|devkitPro/nds-hb-menu|nds-hb-menu}}.
Determines the DSi title to boot into when <code>autoboot_3ds_homebrew</code> is set to 2. The selected title must be installed on the NAND, or it will instead crash on boot - the default app used is {{GitHub|devkitPro/nds-hb-menu|nds-hb-menu}}.




===Rosalina menu options===
=== Rosalina menu options ===
The following options can be altered in some way via the [[3DS:Luma3DS/Rosalina|Rosalina menu]].
The following options can be altered in some way via the [[3DS:Luma3DS/Rosalina|Rosalina menu]].




====hbldr_3dsx_titleid====
==== hbldr_3dsx_titleid ====
The title ID that is input here will launch the Homebrew Launcher instead of whatever application is actually run. In most cases, this will be set to the Homebrew Launcher Wrapper that is installed in the guide (000400000d921e00).
The title ID that is input here will launch the Homebrew Launcher instead of whatever application is actually run. In most cases, this will be set to the Homebrew Launcher Wrapper that is installed in the guide (000400000d921e00).


====rosalina_menu_combo====
==== rosalina_menu_combo ====
Determines what keys you need to press to open the Rosalina menu. By default, this is set to {{B|L}} + {{B|D-Pad Down}} + {{B|Select}}.<br>
Determines what keys you need to press to open the Rosalina menu. By default, this is set to {{Key press|L|Down|SELECT}}.<br>
For example, if one of the default keys is broken, you can set it to <code>X+Y</code> to change the menu combination to {{B|X}} + {{B|Y}}.
For example, if one of the default keys is broken, you can set it to <code>X+Y</code> to change the menu combination to {{Key press|X|Y}}.


====ntp_tz_offset_min====
==== ntp_tz_offset_min ====
Determines your timezone to set the time correctly. The value is the number of minutes your timezone is from UTC.<br>
Determines your timezone to set the time correctly. The value is the number of minutes your timezone is from UTC.<br>
For example, Eastern Standard Time (EST) in the United States is UTC-5, so the offset would be 60 * -5 = -300.
For example, Eastern Standard Time (EST) is UTC-5, so the offset would be 60 * -5 = -300.




====Screen filter options====
==== Screen filter options ====
All of the following options can be configured for each screen, and thus have two variables.
All of the following options can be configured for each screen, and thus have two variables.




=====screen_filters_cct=====
===== screen_filters_cct =====
Determines the Correlated Color Temperature (cct). Can be set to any integer between 1000 and 25100.
Determines the Correlated Color Temperature (cct). Can be set to any integer between 1000 and 25100.


=====screen_filters_gamma=====
===== screen_filters_gamma =====
Adjusts the gamma of the screen. Can be set to any integer between 0 and 1411. Increasing this above 1 will make colors look more saturated.
Adjusts the gamma of the screen. Can be set to any integer between 0 and 1411. Increasing this above 1 will make colors look more saturated.


=====screen_filters_contrast=====
===== screen_filters_contrast =====
Adjusts the contrast of the screen. Can be set to any integer between 0 and 255.
Adjusts the contrast of the screen. Can be set to any integer between 0 and 255.


=====screen_filters_brightness=====
===== screen_filters_brightness =====
Adjusts the brightness of the screen. Can be set to any number between -1 and 1.
Adjusts the brightness of the screen. Can be set to any number between -1 and 1.


=====screen_filters_invert=====
===== screen_filters_invert =====
If set to 1, inverts the colors of the screen.
If set to 1, inverts the colors of the screen.




===Options you shouldn't touch===
=== Options you shouldn't touch ===
You shouldn't touch these options unless you know what you're doing.
You shouldn't touch these options unless you know what you're doing.




====autoboot_3ds_app_mem_type====
==== autoboot_3ds_app_mem_type ====
{{warning|This option is only of interest for developers. Changing it without knowing what you are doing may result in frequent crashes.}}
{{warning|This option is only of interest for developers. Changing it without knowing what you are doing may result in frequent crashes.}}
When set to anything but 0, uses an alternate memory layout when <code>autoboot_3ds_homebrew</code> is set to 1.
When set to anything but 0, uses an alternate memory layout when <code>autoboot_3ds_homebrew</code> is set to 1.


====use_dev_unitinfo====
==== use_dev_unitinfo ====
{{warning|This option will break most retail features while enabled - this includes online play, eShop, amiibo, and retail games.}}
{{warning|This option will break most retail features while enabled - this includes online play, eShop, amiibo, and all retail games.}}
When set to 1, this option changes a flag in the 3DS firmware so that it thinks it is a development unit, allowing you to run development applications.
When set to 1, this option changes a flag in the 3DS firmware so that it thinks it is a development unit, allowing you to run development applications.


====disable_arm11_exception_handlers====
==== disable_arm11_exception_handlers ====
{{warning|This option usually does not stop errors from happening - it only makes them harder to troubleshoot.}}
{{warning|This option usually does not stop errors from happening - it only makes them harder to troubleshoot.}}
When set to 1, this option disables the "An exception occurred" message that occurs when an application crashes, normally replacing it with a black screen or a generic error message.
When set to 1, this option disables the [[3DS:EXCEPTION|An exception occurred]] message that occurs when an application crashes, normally replacing it with a black screen or a generic error message.


====enable_safe_firm_rosalina====
==== enable_safe_firm_rosalina ====
{{info|Luma3DS should not be active in SAFE_FIRM since SAFE_FIRM is meant as a 'rescue mode' - it's relatively unlikely anything bad will happen, but don't enable this option without a specific good reason.}}
{{info|Luma3DS should not be active in SAFE_FIRM since SAFE_FIRM is meant as a 'rescue mode' - it's relatively unlikely anything bad will happen, but don't enable this option without a specific good reason.}}
When set to 1, this option does two things:
When set to 1, this option does two things:
Line 162: Line 157:
* Suppresses the <code>0xF96183FE</code> QTM error, which notably allows the New 2DS XL to work on firmwares below 11.3.0
* Suppresses the <code>0xF96183FE</code> QTM error, which notably allows the New 2DS XL to work on firmwares below 11.3.0


==Troubleshooting with Luma3DS configuration==
== Troubleshooting with Luma3DS configuration ==
The Luma3DS configuration menu contains two pieces of information that can be used for troubleshooting: the currently installed Luma3DS version and the location from which Luma3DS is booting.<br>
The Luma3DS configuration menu contains two pieces of information that can be used for troubleshooting: the currently installed Luma3DS version and the location from which Luma3DS is booting.<br>
If you are starting on a new SD card or upgrading from an old (2017 or older) custom firmware setup, you can follow the instructions [[3dsguide:checking-for-cfw|here]] to find out the correct course of action.<br>
If you are starting on a new SD card or upgrading from an old (2017 or older) custom firmware setup, you can follow the instructions [[3dsguide:checking-for-cfw|here]] to find out the correct course of action.<br>