(added plugin_loader_enabled and volume_slider_override + moved force_audio_output to config.ini only settings + removed a few extra spaces so section headers feel more attached to their sections) |
(change the very important version number from 9.1 to 9.0 "Display boot source on the bottom screen in the config menu" https://github.com/LumaTeam/Luma3DS/releases/tag/v9.0) |
||
(7 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
{{hatnote|1=This article is about the Luma3DS configuration menu, accessible on boot. For information about Rosalina (the menu that is accessible when booted into HOME Menu), see [[3DS:Luma3DS/Rosalina|Luma3DS/Rosalina]].}} | {{hatnote|1=This article is about the Luma3DS configuration menu, accessible on boot. For information about Rosalina (the menu that is accessible when booted into HOME Menu), see [[3DS:Luma3DS/Rosalina|Luma3DS/Rosalina]].}} | ||
The Luma3DS configuration menu is a menu that can be accessed by holding | The Luma3DS configuration menu is a menu that can be accessed by holding (Select) while turning on your 3DS. In the menu, you can: | ||
* See what version of Luma3DS is currently installed | * See what version of Luma3DS is currently installed | ||
* Modify | * Modify Luma3DS's 'optional' settings (settings that will, in general, not affect the overall functionality of your 3DS) | ||
* See where Luma3DS is booting from | * See where Luma3DS is booting from | ||
By default, [[3dsguide:index|our custom firmware installation guide]] uses the default configuration that is generated when Luma3DS is first run. This page will contain explanations for the various options contained in Luma3DS configuration so that you can make an informed decision on what options (if any) to change. | By default, [[3dsguide:index|our custom firmware installation guide]] uses the default configuration that is generated when Luma3DS is first run. This page will contain explanations for the various options contained in Luma3DS configuration so that you can make an informed decision on what options (if any) to change. | ||
Luma3DS configuration will often be | Luma3DS configuration will be often be set back to their default settings if: | ||
* You | * You are upgrading to a newer version of Luma3DS that has a breaking change | ||
* You are switching between Luma3DS forks | * You are switching between Luma3DS forks | ||
Luma3DS also keeps separate configuration | Luma3DS also keeps separate configuration for the SD card and CTRNAND (internal memory). The human-readable configuration file is located at <code>SD:/luma/config.ini</code> and <code>CTRNAND:/rw/luma/config.ini</code>, respectively. | ||
==Navigating Luma3DS configuration== | == Navigating Luma3DS configuration == | ||
{{info|If your (Select), (Start), (D-Pad Up), (D-Pad Down), or (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 v11.0).}} | |||
=== | You can access Luma3DS configuration by holding (Select) while powering on your device. | ||
When in the Luma3DS configuration menu, you can use the (Up) and (Down) D-Pad buttons to highlight different options. Press (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. | |||
Once you are done configuring Luma3DS, press the (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. | |||
== Luma3DS configuration options == | |||
==== Screen brightness ==== | |||
Changes the brightness of the Luma3DS configuration screen. Takes effect instantly. | Changes the brightness of the Luma3DS configuration screen. Takes effect instantly. | ||
====Splash==== | ==== Splash ==== | ||
Determines whether Luma3DS will attempt to display a splash screen (a custom boot image) while booting your 3DS. This option will not do anything unless you have splash images in the <code>luma</code> folder | |||
Determines whether Luma3DS will attempt to display a splash screen (a custom boot image) while booting your 3DS. This option will not do anything unless you have splash images in the <code>luma</code> folder. For more information, see [[3DS:Splash screens]]. | |||
==== 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 (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 | |||
====New 3DS CPU==== | ==== New 3DS CPU (New 3DS only) ==== | ||
Determines whether to use the New 3DS's enhanced clock speed and L2 cache in games intended for Old 3DS. This may improve performance for some games, but it may also break other games. This is the same option as the one that can be found in the [[3DS:Luma3DS/Rosalina|Rosalina menu]]. | |||
==== Enable loading external FIRMs and modules ==== | |||
Determines whether Luma3DS will attempt to load customized FIRMs and system modules (basically, for modifying non-game elements on the 3DS). This option will not do anything unless you have the necessary files in <code>luma</code> or <code>/luma/sysmodules</code>. | |||
You will most likely only use this option for specific applications like TWPatch (for widescreen DS games) and | |||
rverse (a custom Miiverse server). For more information, consult their respective installation guides. | |||
==== Enable game patching ==== | |||
Determines whether Luma3DS will attempt to load modded game files. This option will not do anything unless you have the necessary files in <code>/luma/titles/(title ID of game)</code>. | |||
You will often enable this option if you are planning to use game mods via LayeredFS, such as translation patches or ROM hacks. | |||
You will also need this option if you need to manually specify the locale for games that aren't cooperating with Luma3DS's region-free patch. For more information, see [[3DS:Setting game locales]]. | |||
==== Show NAND or user string in System Settings ==== | ==== Show NAND or user string in System Settings ==== | ||
Determines whether 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 ==== | ||
Determines whether 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). | |||
== 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 | |||
{{info|These options will only appear if your currently inserted SD card has an [[3DS:EmuNAND and RedNAND|EmuNAND/RedNAND]] set up.}} | |||
==== 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. | |||
You can also manually specify which EmuNAND to boot into by holding a | 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. | ||
You can also manually specify which EmuNAND to boot into by holding a D-Pad button while booting (Up for 1, Right for 2, Down for 3, 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 (Left Shoulder) on boot, and vice versa. | |||
== | ==== 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 booting with the (Right Shoulder) button held. | |||
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 to exclusively 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|Don't touch this one.}} | |||
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''' - otherwise, you may accidentally reset your Luma3DS configuration. | |||
==== | ==== 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 | |||
==== | === Rosalina menu options === | ||
The following options can also be changed via the [[3DS:Luma3DS/Rosalina|Rosalina menu]]. | |||
==== | ==== hbldr_3dsx_titleid ==== | ||
The | 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 application installed in the guide (000400000d921e00). | ||
==== rosalina_menu_combo ==== | |||
Determines what key(s) you need to press to open the Rosalina menu. By default, this is set to (Left Shoulder) + (Down D-Pad) + (Select). | |||
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 <code>(X)</code> + <code>(Y)</code>. | |||
===== | ==== screen_filters_cct ==== | ||
This value (between 1000 and 25100) determines how strong the blue light filter is. Lower is more orange (and thus, normally, less eye-straining). The dfeault value is 6500. | |||
===== | ==== ntp_tz_offset_min ==== | ||
Determines your timezone for the purpose of setting the correct time. This configuration option is based on UTC. | |||
For example, Eastern Standard Time (EST) in the United States is UTC-5, so the offset would be 60 * -5 = -240. | |||
=== 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. | ||
==== | ==== use_dev_unitinfo ==== | ||
{{warning|This option | |||
{{warning|This option will break most retail features while enabled (including online play, eShop, amiibo, and 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 | |||
When set to 1, this option disables the | {{warning|This option normally does not stop errors from happening! It just shows a black screen or generic error message instead of the detailed error message, which makes it 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. | |||
==== enable_safe_firm_rosalina ==== | ==== enable_safe_firm_rosalina ==== | ||
When set to 1, this option does two things: | When set to 1, this option does two things: | ||
* Allows Rosalina to function when using [[3DS:Safe Mode|Safe Mode]] (for example, if you need to take screenshots of Safe Mode or perform whatever other functions Rosalina allows) | * Allows Rosalina to function when using [[3DS:Safe Mode|Safe Mode]] (for example, if you need to take screenshots of Safe Mode or perform whatever other functions Rosalina allows) | ||
* 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 | ||
This option won't do anything drastic, but there's not much reason to enable it unless you actually have a use for it. | |||
== 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. | |||
If you are starting | 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. | ||
If you are starting fresh from 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. | |||
As of Luma3DS v9.0, the location from which Luma3DS is booting will be displayed in yellow on the bottom screen. The following lines are known to be possible: | As of Luma3DS v9.0, the location from which Luma3DS is booting will be displayed in yellow on the bottom screen. The following lines are known to be possible: | ||
* Booted from SD via B9S | * Booted from SD via B9S | ||
** Indicates that Luma3DS is being booted from the <code>boot.firm</code> file on the root of your SD card (or wherever else | ** Indicates that Luma3DS is being booted from the <code>boot.firm</code> file on the root of your SD card (or wherever else you may have it configured if you are using fastboot3DS). | ||
* Booted from CTRNAND via B9S | * Booted from CTRNAND via B9S | ||
** Indicates that Luma3DS is being booted from the <code>boot.firm</code> file on the root of SYSNAND CTRNAND (or wherever else | ** Indicates that Luma3DS is being booted from the <code>boot.firm</code> file on the root of SYSNAND CTRNAND (or wherever else you may have it configured if you are using fastboot3DS). If an SD card is inserted and you still see this message, you are either missing <code>boot.firm</code> from the root of your SD card, or your SD card isn't being read. | ||
* Booted from SD via B9S (ntrboot) | * Booted from SD via B9S (ntrboot) | ||
** Indicates that Luma3DS is being booted from the <code>boot.firm</code> file on the root of your SD card, but that you are running B9S via ntrboot. If you're trying to install CFW, you should instead use SafeB9SInstaller as your <code>boot.firm</code> file. | ** Indicates that Luma3DS is being booted from the <code>boot.firm</code> file on the root of your SD card, but that you are running B9S via ntrboot. If you're trying to install CFW, you should instead use SafeB9SInstaller as your <code>boot.firm</code> file. | ||
* Booted from SD via FIRM0 or FIRM1 | * Booted from SD via FIRM0 or FIRM1 | ||
** Indicates that Luma3DS has been installed to your FIRM partitions (where boot9strap or fastboot3DS would normally go). This is known to break some custom firmware functions, so unless | ** Indicates that Luma3DS has been installed to your FIRM partitions (where boot9strap or fastboot3DS would normally go). This is known to break some custom firmware functions, so unless you intended for this to happen, you should [[3dsguide:updating-b9s|follow these instructions]] to install boot9strap to your FIRM partitions. | ||
Revision as of 14:03, 5 October 2022
The Luma3DS configuration menu is a menu that can be accessed by holding (Select) while turning on your 3DS. In the menu, you can:
- See what version of Luma3DS is currently installed
- Modify Luma3DS's 'optional' settings (settings that will, in general, not affect the overall functionality of your 3DS)
- See where Luma3DS is booting from
By default, our custom firmware installation guide uses the default configuration that is generated when Luma3DS is first run. This page will contain explanations for the various options contained in Luma3DS configuration so that you can make an informed decision on what options (if any) to change.
Luma3DS configuration will be often be set back to their default settings if:
- You are upgrading to a newer version of Luma3DS that has a breaking change
- You are switching between Luma3DS forks
Luma3DS also keeps separate configuration for the SD card and CTRNAND (internal memory). The human-readable configuration file is located at SD:/luma/config.ini
and CTRNAND:/rw/luma/config.ini
, respectively.
If your (Select), (Start), (D-Pad Up), (D-Pad Down), or (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 config.ini file in the luma folder (as of Luma3DS v11.0). |
You can access Luma3DS configuration by holding (Select) while powering on your device.
When in the Luma3DS configuration menu, you can use the (Up) and (Down) D-Pad buttons to highlight different options. Press (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 (x)
. For example, (x) Show NAND or user string in System Settings
indicates that the "Show NAND or user string in System Settings" option is enabled.
Once you are done configuring Luma3DS, press the (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.
Luma3DS configuration options
Screen brightness
Changes the brightness of the Luma3DS configuration screen. Takes effect instantly.
Splash
Determines whether Luma3DS will attempt to display a splash screen (a custom boot image) while booting your 3DS. This option will not do anything unless you have splash images in the luma
folder. For more information, see 3DS:Splash screens.
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 (Start) to save the configuration. For more information, see 3DS:Luma3DS/PIN lock.
New 3DS CPU (New 3DS only)
Determines whether to use the New 3DS's enhanced clock speed and L2 cache in games intended for Old 3DS. This may improve performance for some games, but it may also break other games. This is the same option as the one that can be found in the Rosalina menu.
Enable loading external FIRMs and modules
Determines whether Luma3DS will attempt to load customized FIRMs and system modules (basically, for modifying non-game elements on the 3DS). This option will not do anything unless you have the necessary files in luma
or /luma/sysmodules
.
You will most likely only use this option for specific applications like TWPatch (for widescreen DS games) and rverse (a custom Miiverse server). For more information, consult their respective installation guides.
Enable game patching
Determines whether Luma3DS will attempt to load modded game files. This option will not do anything unless you have the necessary files in /luma/titles/(title ID of game)
.
You will often enable this option if you are planning to use game mods via LayeredFS, such as translation patches or ROM hacks.
You will also need this option if you need to manually specify the locale for games that aren't cooperating with Luma3DS's region-free patch. For more information, see 3DS:Setting game locales.
Show NAND or user string in System Settings
Determines whether 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 Ver. 11.16.0-49U
. With this option enabled, the version string would instead show Sys. 11.16.0-49U
. 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 customversion_sys.txt
and putting it inside the luma
folder.
Show GBA boot screen in patched AGB_FIRM
Determines whether Luma3DS will show the GBA boot screen when loading a GBA game through the built-in GBA firmware of the 3DS (such as through virtual console).
EmuNAND/RedNAND only
These options will only appear if your currently inserted SD card has an EmuNAND/RedNAND set up. |
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.
You can also manually specify which EmuNAND to boot into by holding a D-Pad button while booting (Up for 1, Right for 2, Down for 3, Left for 4).
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 (Left Shoulder) on boot, and vice versa.
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 booting with the (Right Shoulder) button held.
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 to exclusively the config.ini
file in SD:/luma/config.ini
or CTRNAND:/rw/luma/config.ini
. This section documents those options.
config_version_major, config_version_minor
Don't touch this one. |
Luma3DS uses these lines to determine what revision of config.ini
is being used to prevent inconsistencies between Luma3DS updates. Do not touch these options - otherwise, you may accidentally reset your Luma3DS configuration.
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.
The following options can also be changed via the Rosalina menu.
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 application installed in the guide (000400000d921e00).
Determines what key(s) you need to press to open the Rosalina menu. By default, this is set to (Left Shoulder) + (Down D-Pad) + (Select).
For example, if one of the default keys is broken, you can set it to X+Y
to change the menu combination to (X)
+ (Y)
.
screen_filters_cct
This value (between 1000 and 25100) determines how strong the blue light filter is. Lower is more orange (and thus, normally, less eye-straining). The dfeault value is 6500.
ntp_tz_offset_min
Determines your timezone for the purpose of setting the correct time. This configuration option is based on UTC.
For example, Eastern Standard Time (EST) in the United States is UTC-5, so the offset would be 60 * -5 = -240.
Options you shouldn't touch
You shouldn't touch these options unless you know what you're doing.
use_dev_unitinfo
This option will break most retail features while enabled (including online play, eShop, amiibo, and 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.
disable_arm11_exception_handlers
This option normally does not stop errors from happening! It just shows a black screen or generic error message instead of the detailed error message, which makes it 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.
enable_safe_firm_rosalina
When set to 1, this option does two things:
- Allows Rosalina to function when using Safe Mode (for example, if you need to take screenshots of Safe Mode or perform whatever other functions Rosalina allows)
- Suppresses the
0xF96183FE
QTM error, which notably allows the New 2DS XL to work on firmwares below 11.3.0
This option won't do anything drastic, but there's not much reason to enable it unless you actually have a use for it.
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.
If you are starting fresh from a new SD card or upgrading from an old (2017 or older) custom firmware setup, you can follow the instructions here to find out the correct course of action.
As of Luma3DS v9.0, the location from which Luma3DS is booting will be displayed in yellow on the bottom screen. The following lines are known to be possible:
- Booted from SD via B9S
- Indicates that Luma3DS is being booted from the
boot.firm
file on the root of your SD card (or wherever else you may have it configured if you are using fastboot3DS).
- Indicates that Luma3DS is being booted from the
- Booted from CTRNAND via B9S
- Indicates that Luma3DS is being booted from the
boot.firm
file on the root of SYSNAND CTRNAND (or wherever else you may have it configured if you are using fastboot3DS). If an SD card is inserted and you still see this message, you are either missingboot.firm
from the root of your SD card, or your SD card isn't being read.
- Indicates that Luma3DS is being booted from the
- Booted from SD via B9S (ntrboot)
- Indicates that Luma3DS is being booted from the
boot.firm
file on the root of your SD card, but that you are running B9S via ntrboot. If you're trying to install CFW, you should instead use SafeB9SInstaller as yourboot.firm
file.
- Indicates that Luma3DS is being booted from the
- Booted from SD via FIRM0 or FIRM1
- Indicates that Luma3DS has been installed to your FIRM partitions (where boot9strap or fastboot3DS would normally go). This is known to break some custom firmware functions, so unless you intended for this to happen, you should follow these instructions to install boot9strap to your FIRM partitions.