3DS:Game plugins/3GX

2023-08-05T04:06:50Z

Wryyyong: Further adjustments for Luma3DS v13.0

{{shortcut|3DS:3GX|3GX}}
{{Page WIP|notes=
*Usage notes (if any) are missing.
}}
The 3GX file format is an evolution of the old PLG file format that is used in newer game plugins. You can use them via Luma3DS's built-in plugin loader.

== Installation ==

<tabber>
|-|Universal Updater=
==== What you need ====

* [[3DS:Universal-Updater|Universal-Updater]]

==== Installation ====

# Search for <code>Luma3DS</code> in Universal Updater, and download the <code>boot.firm</code> file
# Reboot your system
# In the Luma configuration screen, select any options you need, then press START
#* Hint: If you don't know what the options are, you don't need any

|-|Manually=

==== What you need ====

* The latest release of [https://github.com/LumaTeam/Luma3DS/releases/latest Luma3DS]

==== Installation ====

* Copy the <code>boot.firm</code> to the root of the SD card, replacing the <code>boot.firm</code> already there
* Insert the SD card into your system and power it on
* On the Luma Configuration screen, enable any options that you need, then press Start
** Hint: If you don't know what the options are, you don't need them
</tabber>

== Using 3GX plugins ==

=== Plugin location ===
The 3GX plugin loader will look for plugins in the <code>luma</code> -> <code>plugins</code> directory. Each plugin must be inside a folder named with the game's Title ID. Inside the folder, place your <code>.3gx</code> file.
* You can get the game's title ID from [http://3dsdb.com/ here] (cartridges), [https://hax0kartik.github.io/3dsdb/ here] (digital games), or from the <code>FBI -> Titles</code> menu. For example, Taiko no Tatsujin: Dokodon! Mystery Adventure's title ID is <code>0004000000190E00</code>, so if you wanted to use a plugin for that game, you'd create a folder named <code>0004000000190E00</code>
* The creator of the plugin may have already created a folder with the correct name for you, in which case you can just copy the title ID folder from the plugin's zip/rar/7z archive to the <code>plugins</code> folder
* If you want the plugin to run for ''all'' games (for example, for the CTRPluginFramework blank plugin), rename the plugin to <code>default.3gx</code> and just leave it in the <code>plugins</code> folder

An example directory for a plugin affecting one game would be <code>luma</code> -> <code>plugins</code> -> <code>0004000000190E00</code> -> <code>plugin.3gx</code>.

An example directory for a plugin affecting all games would be <code>luma</code> -> <code>plugins</code> -> <code>default.3gx</code>.

=== Using 3GX plugins ===

# Open the Rosalina menu ([Left Shoulder] + [Down D-Pad] + [Select] by default)
# Scroll down to the plugin loader option, then press (A) to enable it
# Exit the Rosalina menu by pressing (B) a couple of times
# Open your game of choice
#* The screen should flash another color to indicate that the plugin has successfully loaded
# Look at the information on the plugin's webpage/README for usage instructions - usage will differ for each plugin

=== Usage notes ===
WIP

3DS:Luma3DS/Rosalina

2023-08-05T04:04:00Z

Wryyyong: This functionality is now present within the official distribution of Luma3DS as of v13.0 and thus this heads-up is no longer necessary.

{{hatnote|1=This article is about Rosalina, accessible when booted into the HOME Menu. For information about the Luma3DS configuration menu (accessible by holding SELECT on boot), see [[3DS:Luma3DS/Configuration|this page]].}}

Rosalina is a system module for Luma3DS that can be accessed while your 3DS is powered on and in 3DS mode by pressing a keycombo specified in the file <code>sd:/luma/config.ini</code>. By default, the keycombo is {{B|L}} + {{B|Down}} + {{B|Select}}.

Rosalina is ''not'' accessible from within payloads (such as GodMode9), from DS/DSi mode (such as when using a DS cartridge or when using TWiLightMenu++), or from GBA mode (such as when using GBA virtual console).

This menu offers many options for real-time configuration of the system, including but not limited to the following:
* Take screenshots
* Change system settings such as brightness, active cheats, wireless status, and (on New 3DS/2DS only) clock speed & L2 cache
* Activate a blue light filter

[[3dsguide:index|Our custom firmware installation guide]] uses the Rosalina menu for multiple functions. This page will contain explanations for all the options and information present in the Rosalina menu to enable easier navigation and usage.

==Opening and navigating the Rosalina Menu==
{{info|If your {{B|L}}, {{B|D-Pad Down}}, or {{B|Select}} keys are broken, you will not be able to open the Rosalina menu by default. To fix this, modify the <code>sd:/luma/config.ini</code> file by editing the variable <code>rosalina_menu_keycombo</code> to two or more keys that work for you, such as <code>X+Y</code>. If you do not see the <code>config.ini</code>, [[3dsguide:checking-for-cfw|update Luma3DS to version 11.0 or newer]].}}

You can access Rosalina by pressing your chosen keycombo while in most areas of the system, excluding the following:
* Safe Mode (can be bypassed, read [[3DS:Luma3DS/Configuration|Luma3DS Configuration]] for more details)
* DS and GBA games, and homebrew that enters these modes ([[3DS:DS games#TwilightMenu++|TWiLightMenu++]] being a notable example)

Once in the Rosalina menu, use {{B|D-Pad Up}} and {{B|D-Pad Down}} to navigate the options. Press {{B|A}} to choose/enable/disable an option or view a submenu. Once in a submenu, press B to return to the main menu. The currently highlighted option is denoted by a <code>></code> to the left of its text - the option highlighted when you first open the menu is <code>Take screenshot</code>.

While the Rosalina menu is launched, whatever is actively will pause until you exit the Rosalina menu. If you are playing a game online, this will cause your session to disconnect.

Once you are done changing options, press B until you exit Rosalina and return to the system, unpausing what is currently running.

==Rosalina Options==

===Take Screenshot===
Takes a screenshot of both screens' content and saves it to <code>sd:/luma/screenshots</code> as two <code>.bmp</code> files. Activates immediately after being pressed.

===Change screen brightness===
Shows the current luminance of the screen and allows you to change it with the D-Pad - {{B|D-Pad Up}} and {{B|D-Pad Down}} increment by 1, {{B|D-Pad Left}} and {{B|D-Pad Right}} increment by 10. The change in luminance takes effect instantly, including inside Rosalina. Note that any action that restarts the system or enters a place where Rosalina cannot function will reset brightness to the last chosen preset.

===Cheats...===
When inside a title where cheats have been selected for use (either through [[Checkpoint]] or through {{GitHub|LumaTeam/Luma3DS/wiki/Cheat-Engine|manually adding them to Luma}}, this menu shows the selected cheats. Press A on a cheat to change the <code>( )</code> to a <code>(x)</code>, at which point they will be activated when you leave Rosalina.
If the title you are currently in has no cheats selected for it, the menu will instead display <code>No suitable title found</code>.

===Plugin Loader===
When enabled, this option will [[3DS:Game plugins/3GX|allow for the use of .3GX plugins in games.]]

===Process list===
{{warning|Be very careful when editing system memory, as unintended consequences may happen.}}
Shows a list of all system processes currently running, and allows you to view & edit their memory by pressing A on a process name.

===Debugger options...===
{{Section WIP|notes=Information on how the debugger works.}}
{{warning|This option can potentially cause system instability or even crashes - don't use it unless you know what you're doing and why.}}
Allows you to enable/disable a debugger for apps, including forcibly debugging the next application launched. Also shows the system's local IP address in Rosalina while enabled.

===System configuration...===
Allows you to control various elements of the system's hardware.

====Control Wireless connection====
Forcibly enables a connection to a chosen WiFi slot - once active, this connection will not drop unless the signal becomes unavailable until manually disabled.

====Toggle LEDs====
{{Section WIP|notes=Make sure the list of disabled LEDs is accurate, and verify if the info regarding closing the system is actually erroneous or just bugged on one system.}}
When first pressed, disables the power LED and wireless LED until re-enabled manually or the system is closed while in the POWER button menu. The menu states that entering sleep mode by closing the system will always reset the LED state, but this is erroneous.

====Toggle Wireless====
Toggles the 3DS' ability to connect to WiFi networks. While toggled off, this stops <code>Control Wireless connection</code> from connecting to a slot. This setting's chosen option is saved and reapplied on next boot automatically.

====Toggle power button====
Toggles the power button's ability to enter the power-off menu. While toggled off, the power button can still be held for ~7 seconds to forcibly power off the system.

====Toggle power to card slot====
Toggles the 3DS' ability to read cartridges while active. This prevents the passive power drain from having a cartridge inserted, but requires you re-enable this setting or remove and reinsert the cartridge to be able to play it again.

===Screen filters===
Allows you to enable a blue-light filter with settings at certain degrees Kelvin, the default setting being 6500K and the range being from 1200K-10000K - if edited through <code>config.ini</code> instead, the range is 1000K-25100K. This setting's chosen option will be saved and applied on boot if you choose <code>Save settings</code> under <code>Miscellaneous options...</code> or edit it via the <code>config.ini</code>.

===New 3DS Menu...===
{{info|This option can only be used on a New 3DS/2DS.}}
Allows you to manually change how much CPU and L2 cache is given to the active title - this can also be changed in Luma3DS Configuration for all games. Enabling both extra clock speed and L2 cache may reveal hidden bugs in games, to unknown effect.

===Miscellaneous options...===
Allows for various system tweaks. Three of these, which will be noted as they appear for reference, are used on our custom firmware installation guide.

====Switch the hb. title to the current app.====
When inside a title, changes the active title's HOME Menu icon to open the Homebrew Launcher instead until another title is chosen or the system reboots. This is used in our custom firmware guide as a part of [[3dsguide:finalizing-setup|Finalizing Setup]] to access the Homebrew Launcher, though most system apps will work for this purpose and it is unneeded after the Homebrew Launcher Wrapper is installed.

====Change the menu combo====
Changes the keycombo used to access Rosalina. The change will not be preserved across a reboot unless you use the <code>Save settings</code> button.

====Start InputRedirection====
Starts the InputRedirection service to [[3DS:Input_redirection|allow for the use of external controllers.]]

====Update date and time via NTP====
Connects to a time server to remotely sync the 3DS' date and time, after a UTC offset in the form of<code>+0000</code> is chosen. The chosen time zone can be saved to Luma3DS Configuration via the <code>Save settings</code> option.

====Nullify user time offset====
Changes the 3DS' current date and time to match the embedded RTC clock. This is done in our custom firmware guide as a part of [[3dsguide:finalizing-setup|Finalizing Setup]].

====Dump DSP firmware====
Copies the file <code>dspfirm.cdc</code> to <code>sd:/3ds</code> to allow homebrew apps to use the 3ds' audio. This is done in our custom firmware guide as a part of [[3dsguide:finalizing-setup|Finalizing Setup]].

====Save settings====
Saves the current NTP time zone, the active screen filter, and any changes to the Rosalina keycombo to <code>sd:/luma/config.ini</code>.

===Power off===
After a confirmation, powers off your console. Note that the console takes longer to fully shut down this way compared to doing it from the POWER button menu.

===Reboot===
After a confirmation, reboots your console. Notably, this takes far less time than both the <code>Power off</code> Rosalina option and manually rebooting via the POWER button.

===Credits===
Displays a credits page for the creation of Luma3DS and all its contributors.

==Rosalina Info==
In addition to system functionality, Rosalina also displays multiple pieces of system information.
At the bottom of the Rosalina menu, in order from left-to-right, the following are displayed:
* The Luma3DS version number
:* Unlike the Luma3DS configuration menu, this will not display the full commit name for [[3DS:Luma3DS forks|Luma3DS forks]]
* The current battery temperature, in °C
* The current battery voltage
* The current charge percentage, displayed to the nearest 0.1%

Hacks Guide Wiki - User contributions [en]

3DS:Game plugins/3GX

3DS:Luma3DS/Rosalina