Luma3DS

Luma3DS is a homebrew program to patch the system software of (New) Nintendo (2DS) 3DS handheld consoles, adding features such as per-game language settings, debugging capabilities for developers, and removing restrictions enforced by Nintendo such as the region lock.

It is a noob-proof (N)3DS Custom Firmware, that also allows you to run unauthorized (homebrew) content by removing signature checks. To use it, you will need a console capable of running homebrew software on the Arm9 processor.

Features

• Custom Loader.
• Rosalina menu.
• Cheat Engine.
• Service Manager (SM) and PXI.
• Data protection.
• Removal of restrictions:
  • Launch custom Gameboy Advance Virtual Console games without using a homebrew emulator.
  • Region-free patches, without the need to perform region changes.
  • Run homebrews/unsigned codes.
  • Able to boot older flashcarts with homebrew such as NTR Launcher.
• Developer features.
• Optional features (enable from the config menu):
  • Default/Autoboot EmuNAND (dual boot firmwares).
  • Screen brightness.
  • Custom splash screen image/duration.
  • PIN lock.
  • Locale Emulation.
• And many more.

Installation

Installing

As of Luma3DS v8.0, boot9strap v1.2 or higher is required for usage and all previous entrypoints are no longer supported. Start from here if you do not yet have arm9loaderhax or boot9strap.

Download the latest version of Luma3DS. The file you want to download is Luma3DSvX.X(.X).7z, not Source code (zip) or Source code (tar.gz).

Extract boot.firm from the Luma3DSvX.X(.X).7z archive with a tool like 7-zip (Windows/Linux) or Unarchiver (macOS) to the root of your 3DS' SD card.

If your 3DS will not power on after this step or you get an Unsupported Loader error, please try updating boot9strap.

Note: CTRNAND Luma3DS (optional) will allow you to boot your 3DS without having an SD card inserted.

Upgrading

You can manually update Luma3DS following the above steps, but it is recommended to use KunoichiZ's fork of Hamcha's LumaUpdate.

To install LumaUpdate, you must have FBI installed on your 3DS.

A detailed guide can be found at the official site.

User guide

Luma3DS has impletmented the custom sysmodule Rosalina, which contains a myriad of features for both developer and end user convenience.

3DSX loading:

• Work just like installed titles; this means you can use the Home Menu and applets while a 3DSX application is running, use the GDB stub, etc.
• By default, the title used to boot boot.3dsx is hblauncher_loader (can be changed from Miscellaneous options> Switch the hb. title to the current app).
  • Simply launch any title, use that option, close the title; the next time you launch that title, it will run boot.3dsx.
  • Note 3DSX applications will freeze if the takeover title is set to Health & Safety.

GDB Stub:

• A fully featured GDB stub for easy debugging.
• Can debug up to 3 processes simultaneously (the process to attach to are to be selected in the process list menu).
  • To use the GDB stub, enable the debugger in the Rosalina menu), navigate to the the Process List and select processes you want to attach to.
  • Make sure to disable the debugger when finished, otherwise your 3DS will not be able to cleanly shutdown/reboot/firmlaunch.
  • Compatible with both GDB and IDA Pro ("Use single-step support", in the specific debugger options prompt, should be unchecked).

InputRedirection:

• Allows you to control your 3DS using your PC with, for example, an external controller (Xbox360 controller, etc).
• C-stick/ZL/ZR redirection is N3DS-only, possibly only with newer games.
• Recommended clients are InputRedirectionClient-Qt (compatible with xinput on Windows, evdev on Linux, should be compatible with OSX) or InputClient-SDL.

Rosalina menu

Once the 3DS is booted, you can toggle the Rosalina menu using L+Down+Select (by default; key combo can be changed in the Misc options menu). Many features are available from this menu:

New 3DS menu - Enable/disable the higher clock speed and extra L2 cache available on the New 3DS/2DS.

• Note that some games don't work with the extra L2/clock speed and may freeze or crash.
• You can enable the clock increase and extra L2 cache independent of each other, so if you run into issues try disabling one or both.

Cheats - A built-in cheat engine.

• Supports Gateshark-style cheats. Please see the dedicated Cheat Engine page for more information.

Process List - A list of running processes.

• Used as a selection menu for the RAM viewer/editor and when selecting a process to attach to the debugger, if it's enabled.

RAM viewer - By selecting a process in the Process List, you can view/edit its RAM.

• Note that some processes are heapless and thus the L/R heap/code switcher will not show for them.

Take screenshot - Screenshot is saved to /luma/screenshots.

Debugger options - Enable/disable the built-in GDB stub.

System configuration - Options to modify the system state.

• Toggle LEDs - The power and WiFi LEDs can be toggled on/off in this menu by pressing A (entering sleep mode will reset the LED state).
• Toggle Wireless - Toggle WiFi on/off without flipping the hardware switch (older 3DSes) or returning to the Home Menu (newer 3DSes).

Miscellaneous options - Sub-menu with the misc/various options not suited for any other menu.

• Switch the hb. title to the current app - Or Switch the hb. title to hblauncher_loader (if a takeover title is already selected).
• Change the menu combo - Select this option and then press and hold the combination keys for the Rosalina menu.
• Start InputRedirection - Enables/disables InputRedirection.
• Save settings - Saves the Rosalina key combo and takeover title to Luma's config.bin, allowing custom choices to persist through reboots.

Power off - Powers the system off, bypassing the Return to Home Menu page.

Reboot - Restarts the system.

Battery percentage - Remaining battery percentage is displayed in the bottom right of the menu.

Version info - The Luma3DS version and commit hash is displayed in the bottom left of the menu.

Controls

L+Down+Select - Rosalina in-game menu

Hold Select (while turning 3DS on with the power button) - Configuration menu

Known issues

Please refer to the offical page.

Changelog

v10.2.1 17 Nov 2020

• Fix system version 11.14 not booting.
• Allow out-of-region Download Play functionality (thanks @Pixel-Pop).
• Fix a rare issue where the Rosalina Menu wouldn't be displayed during application launch (thanks @Nanquitas).
• General system stability improvements to enhance the user's experience.

v10.2 17 Jul 2020

• Massively improved the screenshot feature:
  • Now takes around 100ms instead of 10s (speed may vary, and the first screenshot in a series is slower).
  • 800px top-screen mode is now supported.
  • Rosalina menu options have been reordered to take this into account.
• Added brightness (luminance) selection submenu.
• Screen filters submenu improvements:
  • Changed the filter values, and there are now more of them.
  • The selected filter is now properly restored when the lid is reopened.
• Removed the lag and crash associated to InputRedirection (thanks @Nanquitas):
  • On N3DS, this may cause a key press to be repeated in Home Menu for no reason. Just pressing ZL/ZR on the console is enough to fix this.
• Improved Rosalina menu handling:
  • C-Pad (left pad) can now be used to navigate the menu.
  • You can now easily scroll through the menus by maintaining directional keys.
  • InputRedirection can now be used to access and navigate the menu.
  • New key options for the menu combo: C-Pad Left/Right/Up/Down & "Touch Screen Pressed" (sorry, no ZL/ZR).
• Removed the need for the console to reboot again when switching to homebrew from a higher-memory game (e.g. Pokémon Sun on O3DS -> configured homebrew title).
• Homebrew can now write to the shared config page.
• Fixed the fact that the console would hang if sleep mode was entered when the Rosalina menu was open.
• Enabling either the debugger or InputRedirection will now prevent the console from going to sleep until both are disabled (to prevent the console from hanging).
• Rosalina is now supported on N3DS SAFE_FIRM, including the homebrew launching functionality that comes with it:
  • This is controlled by a new option in the main Luma menu. That option also enables running 11.3-and-below system versions on N2DS and also allows the system to run even with defective head-tracking hardware.
  • The newest release of the Homebrew Menu needs to be used (it comes bundled with Luma3DS in this release archive). You also need to rebuild all your homebrew with the latest libctru release. Some homebrew may not work, nevertheless.
  • Some Rosalina features may not work properly there (e.g. the brightness and New 3DS submenus).
• Separated the exception dump parser script to a new repository.
• In addition, with thanks to @fincs, this release of Luma3DS comes bundled with version 2.2.0 of the Homebrew Menu (EDIT: replaced by hotfixed version).

v10.1.3 30 Apr 2020

• Fixed a bug that would cause the pxi module to crash on shutdown/reboot/firmlaunch for some people.
• Other minor changes.

v10.1.2 28 Apr 2020

• Fixed cheats not working at all (v10.1.1 regression).
• Fixed WiFi forcing not working at all (v10.1.1 regression). Also fixed other related bugs, including the mishandling of non-reachable access points.
• Fixed a long-standing issue where the debugger and InputRedirection would hang for a long time and fail to recover if there was no internet.
• Fixed a long-standing issue where the console would take a long time to power off/reboot/firmlaunch if either the debugger or InputRedirection were left enabled. Please note that this still happens if both are left enabled at the same time.

v10.1.1 27 Apr 2020

• Fixed multiple issues affecting shutdown (and reboot, firmlaunch) time. Shutdown time should be reduced to around 2.5~3.5s (from 16s):
  • A regression from v10.1 that was also potentially affecting startup times.
  • A regression from v10.0.
  • A bug back from 2016 causing shutdown times to be 1.5 to 5.5s longer than normal.
• Fixed an issue where some Luma builds wouldn't boot.
• Fixed most remaining cases where you would get an Arm9 svcBreak with 0xC8804465, in particular if you pressed the SAFE_MODE combo very late (this was a long-standing issue).
• 3DSX: increased the maximum core1 CPU time limit for APT_SetAppCpuTimeLimit from 30% to 89%.

v10.1 26 Apr 2020

• Fixed booting on 4.x (*).
• Allowed launching 3dsx apps on < 8.x where Rosalina is supported (currently, 4.x and above).
• Added two new options in Rosalina's "System configuration" submenu:
  • The option to force a WiFi network, allowing to use local-network homebrew even if the connection test would fail (@LiquidFenrir).
  • The option to disable short POWER button presses in Rosalina->System configuration (@izzy84075).
• Changed a few things in the NTP submenu:
  • Added the ability to offset the time in the NTP menu by any number of minutes (@nathanhitch).
  • Changed the default IP to that of time.windows.com, not blocked in mainland China.
• Added support for BPS patches (@leoetlino).
• Arm9 menu: check for button combos again after the PIN and/or splash screens.
• Fixed a few bugs in loader sysmodule that were causing crashes (@leoetlino, #1375: @Lizardon1, @muhmuhten).
• Fixed a few bugs in other sysmodules (@lioncash, @piepie62, @Oreo639, @mariohackandglitch), including one that would cause erroneous errdisp screens to show.
• General system stability improvements to enhance the user's experience.
• In addition, with thanks to @fincs, this release of Luma3DS comes bundled with version 2.1.1 of the Homebrew Menu.
• To update, simply drag and drop boot.firm and boot.3dsx to the root of your SD card, as always.
• (*) The space left for Rosalina on this system version (and maybe a few other system versions) is running out; the level of support for it may be reduced to that of 3.x in the future.

Revision changelog.

Credits

Luma3DS is being developed by @AuroraWright and @TuxSH.

See https://github.com/AuroraWright/Luma3DS/wiki/Credits