Toggle menu
Toggle preferences menu
Toggle personal menu
Not logged in
Your IP address will be publicly visible if you make any edits.

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

From Hacks Guide Wiki
(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)
m (update 3gx search term and link)
(5 intermediate revisions by 5 users not shown)
Line 3: Line 3:
*Usage notes (if any) are missing.
*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.
The 3GX file format is an evolution of the old PLG file format that is used in newer game plugins. You can run them by using a fork of Luma3DS that has a plugin loader built-in.


== Installation ==
== Installation ==
Line 15: Line 15:
==== Installation ====
==== Installation ====


# Search for <code>Luma3DS</code> in Universal Updater, and download the <code>boot.firm</code> file
# Search for <code>Luma3DS (3GX)</code> in Universal Updater, and download the <code>boot.firm</code> file
# Reboot your system
# Reboot your system
# In the Luma configuration screen, select any options you need, then press START
# In the Luma configuration screen, select any options you need, then press START
Line 24: Line 24:
==== What you need ====
==== What you need ====


* The latest release of [https://github.com/LumaTeam/Luma3DS/releases/latest Luma3DS]
* [https://github.com/PabloMK7/Luma3DS_3GX/releases/latest The 3GX loader fork of Luma3DS]


==== Installation ====
==== Installation ====


# Copy the <code>boot.firm</code> to the root of the SD card, replacing the <code>boot.firm</code> already there
* Copy the <code>boot.firm</code> from the 3GX loader fork of Luma 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
* 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
* 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
** Hint: If you don't know what the options are, you don't need them
</tabber>
</tabber>
== Using 3GX plugins ==
== Using 3GX plugins ==


Line 46: Line 45:
An example directory for a plugin affecting all games would be <code>luma</code> -> <code>plugins</code> -> <code>default.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> ===
=== Using 3GX plugins ===


# Open the Rosalina menu ({{B|Left Shoulder|D-Pad Down|SELECT}} by default)
# Open the Rosalina menu ([Left Shoulder] + [Down D-Pad] + [Select] by default)
# Scroll down to the plugin loader option, then press {{B|A}} to enable it
# Scroll down to the plugin loader option, then press (A) to enable it
# Exit the Rosalina menu by pressing {{B|B}} a couple of times
# Exit the Rosalina menu by pressing (B) a couple of times
# Open your game of choice
# Open your game of choice
#* The screen should flash another color to indicate that the plugin has successfully loaded
#* The screen should flash another color to indicate that the plugin has successfully loaded
Line 56: Line 55:


=== Usage notes ===
=== Usage notes ===
* Most plugins have a menu that can be launched by pressing {{B|SELECT}} while the plugin is loaded
WIP
WIP

Revision as of 17:26, 26 April 2023

The 3GX file format is an evolution of the old PLG file format that is used in newer game plugins. You can run them by using a fork of Luma3DS that has a plugin loader built-in.

Installation

What you need

Installation

  1. Search for Luma3DS (3GX) in Universal Updater, and download the boot.firm file
  2. Reboot your system
  3. 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

What you need

Installation

  • Copy the boot.firm from the 3GX loader fork of Luma 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.

Using 3GX plugins

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

Usage notes

WIP