renamed →Using 3GX plugins 2: to avoid duplicate header names, left an anchor + switched button inputs to use {{Key press}} + add usage note about plugin menu button shortut
Line 1:
Line 1:
This places an infobox about homebrew software.
{{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=
=== Example ===
==== What you need ====
{{Infobox homebrew
* The latest release of [https://github.com/LumaTeam/Luma3DS/releases/latest Luma3DS]
| title = Checkpoint
| developers = FlagBrew
==== Installation ====
| for3ds = 1
| forswitch = 1
# Copy the <code>boot.firm</code> to the root of the SD card, replacing the <code>boot.firm</code> already there
| image = Checkpoint-Banner.png
# Insert the SD card into your system and power it on
| imagealt = Checkpoint banner on the Home Menu
# On the Luma Configuration screen, enable any options that you need, then press Start
| version = 3.8.0
#* Hint: If you don't know what the options are, you don't need them
| github = FlagBrew/Checkpoint
</tabber>
| githubtag = v3.8.0
| nocat = 1
== Using 3GX plugins ==
}}
If this were on the '''Checkpoint''' page...
=== Plugin location ===
<pre><nowiki>
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.
{{Infobox homebrew
* 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>
| for3ds = 1
* 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
| developers = FlagBrew
* 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
| forswitch = 1
| image = Checkpoint-Banner.png
An example directory for a plugin affecting one game would be <code>luma</code> -> <code>plugins</code> -> <code>0004000000190E00</code> -> <code>plugin.3gx</code>.
| imagealt = Checkpoint banner on the Home Menu
| version = 3.8.0
An example directory for a plugin affecting all games would be <code>luma</code> -> <code>plugins</code> -> <code>default.3gx</code>.
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.
Copy the boot.firm to the root of the SD card, replacing the boot.firm 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
Using 3GX plugins
Plugin location
The 3GX plugin loader will look for plugins in the luma -> plugins directory. Each plugin must be inside a folder named with the game's Title ID. Inside the folder, place your .3gx file.
You can get the game's title ID from here (cartridges), here (digital games), or from the FBI -> Titles menu. For example, Taiko no Tatsujin: Dokodon! Mystery Adventure's title ID is 0004000000190E00, so if you wanted to use a plugin for that game, you'd create a folder named 0004000000190E00
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 plugins folder
If you want the plugin to run for all games (for example, for the CTRPluginFramework blank plugin), rename the plugin to default.3gx and just leave it in the plugins folder
An example directory for a plugin affecting one game would be luma -> plugins -> 0004000000190E00 -> plugin.3gx.
An example directory for a plugin affecting all games would be luma -> plugins -> default.3gx.
Launching 3GX plugins
Open the Rosalina menu (Left Shoulder+D-Pad Down+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
Most plugins have a menu that can be launched by pressing SELECT while the plugin is loaded
