3DS:Game plugins: Difference between revisions

From Hacks Guide Wiki
m (proper wiki link)
(change into generalized page with links to more in-depth articles)
Line 5: Line 5:
* Create your own cheat codes ([https://gbatemp.net/threads/ctrpluginframework-blank-plugin-now-with-action-replay.487729/ CTRPluginFramework blank plugin])
* Create your own cheat codes ([https://gbatemp.net/threads/ctrpluginframework-blank-plugin-now-with-action-replay.487729/ CTRPluginFramework blank plugin])


Plugins most commonly come in two formats: the '''PLG''' format and the '''3GX''' format. PLG format plugins are generally older and may not work as expected on the latest firmware.
Plugins most commonly come in two formats: the '''3GX''' format and the '''PLG''' format. PLG format plugins are generally older and may not work as expected on the latest firmware.


This page serves as a general tutorial for running plugins - it is ''not'' a tutorial on how to use these plugins. For information on specific plugins, check the page for [[:Category:Nintendo 3DS games|the game in question]].
The pages below serve as a general tutorial for running plugins - they do ''not'' server as a tutorial on their usage. For information on specific plugins, check the page for [[:Category:Nintendo 3DS games|the game in question]].


== Installing PLG format plugins ==
* [[3DS:Game plugins/3GX|Using 3GX-format plugins]]
 
* [[3DS:Game plugins/NTR|Using PLG-format plugins]]
=== What you need ===
 
* The latest release of {{GitHub|Nanquitas/BootNTR/releases/latest|BootNTR}} (one of the <code>.cia</code> files)
** The banner doesn't matter - get the one that you think looks nicer.
** If you have an Old3DS, you'll need the Mode3 version of BootNTR if you want to use plugins on extended memory mode games (such as the seventh-generation Pokémon games).
* The latest release of {{GitHub|Nanquitas/Luma3DS/releases/latest|Luma3DS 3GX Loader}} (<code>boot.firm</code>)
** Even though we're running PLG format plugins, we currently require the 3GX loader version of Luma3DS for BootNTR Selector to work. You won't actually be using the 3GX loading component (unless, of course, you're using any 3GX plugins).
* Your PLG-format plugin of choice
 
=== Section I: Prep Work ===
 
# Put your SD card into your computer
# Copy the BootNTR Selector <code>.cia</code> file(s) to the <code>cias</code> folder on your SD card
#* Create it if it doesn't exist - it's just for organizational purposes
# Copy <code>boot.firm</code> to the root of the SD card, replacing the existing one
# Create a folder named <code>plugin</code> on the root of your SD card if it does not already exist
# Inside the <code>plugin</code> folder, create a folder named with the title ID of the game
#* 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 you'd create a folder named <code>0004000000190E00</code>
#* The creator of the plugin may have already done this for you, in which case you can just copy the title ID folder from the plugin's <code>.zip</code> file to the <code>plugin</code> folder
#* If you want the plugin to run for ''all'' games (for example, for an FPS overlay), create a folder called <code>game</code> inside of the <code>plugin</code> folder
# Put your SD card into your 3DS
 
=== Section II: Installing CIAs ===
 
{{info|text=You only need to do this if BootNTR Selector hasn't been installed yet, or if BootNTR Selector is outdated.}}
 
# Power on your device
# Open the FBI application
# Navigate to <code>SD Card</code> -> <code>cias</code>
# Select the BootNTR Selector <code>.cia</code> file(s), then select "Install and delete CIA"
# Allow the CIA(s) to install
# Exit the FBI application
 
=== Section III: BootNTR Selector ===
 
# Open the BootNTR Selector application (the rocket icon)
#* If you have an Old3DS ''and'' you want to run an extended memory mode game, open the Mode3 version; otherwise, open the normal one
# If prompted to setup the application, select "Use default"
#* If you mess up here, you can reset BootNTR Selector's config by holding (Select) while opening the application
# Select Version 3.6
#* The screen should flash a color, then kick you back to HOME Menu
# Open your game of choice
#* The screen should flash another color to indicate that the plugin has successfully loaded
 
{{success|text=Your NTR plugin has been successfully loaded! Refer to the plugin's documentation to figure out what key(s) you need to press to access the plugin's settings.}}
 
== Installing 3GX format plugins ==
 
=== What you need ===
 
* The latest release of {{GitHub|Nanquitas/Luma3DS/releases/latest|Luma3DS 3GX Loader}} (<code>boot.firm</code>)
* Your 3GX-format plugin of choice
 
=== Section I: Prep Work ===
 
# Put your SD card into your computer
# Copy <code>boot.firm</code> to the root of the SD card, replacing the existing one
# Open the <code>luma</code> folder, then create a folder named <code>plugins</code> inside it
# Inside the <code>plugins</code> folder, create a folder named with the title ID of the game
#* 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 you'd create a folder named <code>0004000000190E00</code>
#* The creator of the plugin may have already done this for you, in which case you can just copy the title ID folder from the plugin's <code>.zip</code> file 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
# Put your SD card into your 3DS
 
=== Section II: Installing CIAs ===
 
# Power on your device
# 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
 
{{success|text=Your 3GX plugin has been successfully loaded! Refer to the plugin's documentation to figure out what key(s) you need to press to access the plugin's settings.}}

Revision as of 10:34, 11 August 2022

On the Nintendo 3DS, game plugins are add-ons that run with specific games. They can often be used to:

Plugins most commonly come in two formats: the 3GX format and the PLG format. PLG format plugins are generally older and may not work as expected on the latest firmware.

The pages below serve as a general tutorial for running plugins - they do not server as a tutorial on their usage. For information on specific plugins, check the page for the game in question.