3DS:Game plugins/3GX: Difference between revisions

Revision as of 17:26, 22 March 2026

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

What you need

Universal-Updater

Installation

Power on your console
Launch <tvar=1>Universal-Updater</tvar> from the HOME Menu, or from the Homebrew Launcher
Select the magnifying glass on the bottom screen, then search for Luma3DS
Press <tvar=2>A</tvar> while hovering over Luma3DS from the list of homebrew
Choose boot.firm and wait for the install to finish
Reboot your console
If you see the Luma3DS configuration menu, enable any options that you need, then press Start
- Hint: If you don't know what the options are, you don't need them

What you need

The latest release of <tvar=3>Luma3DS</tvar> (the Luma3DS .zip file)

Installation

Insert your SD card into your computer
Copy boot.firm from the Luma3DS .zip to the root of your SD card, replacing boot.firm if it is already there
Reinsert your SD card into your console and power on
If you see the Luma3DS configuration menu, 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 <tvar=4>luma -> plugins</tvar> 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 [<tvar=5>http://3dsdb.com/</tvar> here] (cartridges), [<tvar=6>https://hax0kartik.github.io/3dsdb/</tvar> here] (digital games), or from the <tvar=7>FBI -> Titles</tvar> menu. For example, <tvar=8>Taiko no Tatsujin: Dokodon! Mystery Adventure</tvar>'s title ID is <tvar=9>0004000000190E00</tvar>, so if you wanted to use a plugin for that game, you'd create a folder named <tvar=10>0004000000190E00</tvar>
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 <tvar=11>plugins</tvar> 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 <tvar=12>plugins</tvar> folder

An example directory for a plugin affecting one game would be <tvar=13>luma -> plugins</tvar> -> <tvar=14>0004000000190E00</tvar> -> <tvar=15>plugin.3gx</tvar>.

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

Launching 3GX plugins

Open the Rosalina menu <tvar=18>(Left Shoulder+D-Pad Down+SELECT</tvar> by default)
Scroll down to the plugin loader option, then press <tvar=19>A</tvar> to enable it
Press <tvar=20>B</tvar> to exit the Rosalina menu
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 opened by pressing <tvar=21>SELECT</tvar> while the plugin is loaded

@@ Line 14: / Line 14: @@
 <translate>
 # Power on your console
-# Launch <tvar="UU">'''Universal-Updater'''</tvar> from the HOME Menu, or from the Homebrew Launcher
+# Launch <tvar=1>'''Universal-Updater'''</tvar> from the HOME Menu, or from the Homebrew Launcher
 # Select the magnifying glass on the bottom screen, then search for '''Luma3DS'''
-# Press <tvar="A">{{B|A}}</tvar> while hovering over '''Luma3DS''' from the list of homebrew
+# Press <tvar=2>{{B|A}}</tvar> while hovering over '''Luma3DS''' from the list of homebrew
 # Choose <code>boot.firm</code> and wait for the install to finish
 # Reboot your console
@@ Line 26: / Line 26: @@
 ==== <translate>What you need</translate> ====
-* <translate>The latest release of <tvar="luma3dslink">[https://github.com/LumaTeam/Luma3DS/releases/latest Luma3DS]</tvar> (the Luma3DS <code>.zip</code> file)</translate>
+* <translate>The latest release of <tvar=3>[https://github.com/LumaTeam/Luma3DS/releases/latest Luma3DS]</tvar> (the Luma3DS <code>.zip</code> file)</translate>
 ==== <translate>Installation</translate> ====
@@ Line 44: / Line 44: @@
 <translate>
-The 3GX plugin loader will look for plugins in the <tvar="luma_pl_path"><code>luma</code> -> <code>plugins</code></tvar> directory. Each plugin must be inside a folder named with the game's Title ID. Inside the folder, place your <code>.3gx</code> file.
+The 3GX plugin loader will look for plugins in the <tvar=4><code>luma</code> -> <code>plugins</code></tvar> 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 [<tvar="3dsdb_cart">http://3dsdb.com/</tvar> here] (cartridges), [<tvar="3dsdb">https://hax0kartik.github.io/3dsdb/</tvar> here] (digital games), or from the <tvar="fbi_tl_path"><code>FBI -> Titles</code></tvar> menu. For example, <tvar="taikoname">Taiko no Tatsujin: Dokodon! Mystery Adventure</tvar>'s title ID is <tvar="taiko_id"><code>0004000000190E00</code></tvar>, so if you wanted to use a plugin for that game, you'd create a folder named <tvar="taiko_id"><code>0004000000190E00</code></tvar>
+* You can get the game's title ID from [<tvar=5>http://3dsdb.com/</tvar> here] (cartridges), [<tvar=6>https://hax0kartik.github.io/3dsdb/</tvar> here] (digital games), or from the <tvar=7><code>FBI -> Titles</code></tvar> menu. For example, <tvar=8>Taiko no Tatsujin: Dokodon! Mystery Adventure</tvar>'s title ID is <tvar=9><code>0004000000190E00</code></tvar>, so if you wanted to use a plugin for that game, you'd create a folder named <tvar=10><code>0004000000190E00</code></tvar>
-* 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 <tvar="plugins"><code>plugins</code></tvar> folder
+* 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 <tvar=11><code>plugins</code></tvar> 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 <tvar="plugins"><code>plugins</code></tvar> 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 <tvar=12><code>plugins</code></tvar> folder
 </translate>
-<translate>An example directory for a plugin affecting one game would be <tvar="luma_pl_path"><code>luma</code> -> <code>plugins</code></tvar> -> <tvar="taiko_id"><code>0004000000190E00</code></tvar> -> <tvar="pl3gx"><code>plugin.3gx</code></tvar>.
+<translate>An example directory for a plugin affecting one game would be <tvar=13><code>luma</code> -> <code>plugins</code></tvar> -> <tvar=14><code>0004000000190E00</code></tvar> -> <tvar=15><code>plugin.3gx</code></tvar>.
-An example directory for a plugin affecting all games would be <tvar="luma_pl_path"><code>luma</code> -> <code>plugins</code></tvar> -> <tvar="def3gx"><code>default.3gx</code></tvar>.</translate>
+An example directory for a plugin affecting all games would be <tvar=16><code>luma</code> -> <code>plugins</code></tvar> -> <tvar=17><code>default.3gx</code></tvar>.</translate>
 === <translate>Launching 3GX plugins</translate><span class="anchor" id="Using 3GX plugins"></span> ===
 <translate>
-# Open the Rosalina menu <tvar="rlcombo">({{B|Left Shoulder|D-Pad Down|SELECT}}</tvar> by default)
+# Open the Rosalina menu <tvar=18>({{B|Left Shoulder|D-Pad Down|SELECT}}</tvar> by default)
-# Scroll down to the plugin loader option, then press <tvar="A">{{B|A}}</tvar> to enable it
+# Scroll down to the plugin loader option, then press <tvar=19>{{B|A}}</tvar> to enable it
-# Press <tvar="B">{{B|B}}</tvar> to exit the Rosalina menu
+# Press <tvar=20>{{B|B}}</tvar> to exit the Rosalina menu
 # Open your game of choice
 #* The screen should flash another color to indicate that the plugin has successfully loaded
@@ Line 65: / Line 65: @@
 </translate>
 === <translate>Usage notes</translate> ===
-* <translate>Most plugins have a menu that can be opened by pressing <tvar="SELECT">{{B|SELECT}}</tvar> while the plugin is loaded</translate>
+* <translate>Most plugins have a menu that can be opened by pressing <tvar=21>{{B|SELECT}}</tvar> while the plugin is loaded</translate>