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

{{shortcut|3DS:3GX|3GX}}

== Installation ==

|-|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]

== Using 3GX plugins ==

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>.

=== Launching 3GX plugins<span class="anchor" id="Using 3GX plugins"></span> ===

# Open the Rosalina menu ({{B|Left Shoulder|D-Pad Down|SELECT}} by default)

# Scroll down to the plugin loader option, then press {{B|A}} to enable it

# Exit the Rosalina menu by pressing {{B|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 {{B|SELECT}} while the plugin is loaded