3DS:Game plugins/3GX: Difference between revisions
From Hacks Guide Wiki
More actions
m page complete Tags: Mobile edit Mobile web edit |
added translation marks |
||
| Line 1: | Line 1: | ||
{{shortcut|3DS:3GX|3GX}} | <languages/>{{shortcut|3DS:3GX|3GX}} | ||
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. | <translate>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.</translate> | ||
== Installation == | == <translate>Installation</translate> == | ||
<tabber> | <tabber> | ||
|-|Universal-Updater= | |-|Universal-Updater= | ||
==== What you need ==== | ==== <translate>What you need</translate> ==== | ||
* [[3DS:Universal-Updater|Universal-Updater]] | * [[3DS:Universal-Updater|Universal-Updater]] | ||
==== Installation ==== | ==== <translate>Installation</translate> ==== | ||
<translate> | |||
# Power on your console | # Power on your console | ||
# Launch '''Universal-Updater''' from the HOME Menu, or from the Homebrew Launcher | # Launch <tvar=UU>'''Universal-Updater'''</tvar> from the HOME Menu, or from the Homebrew Launcher | ||
# Select the magnifying glass on the bottom screen, then search for '''Luma3DS''' | # Select the magnifying glass on the bottom screen, then search for '''Luma3DS''' | ||
# Press {{B|A}} while hovering over '''Luma3DS''' from the list of homebrew | # Press <tvar=A>{{B|A}}</tvar> while hovering over '''Luma3DS''' from the list of homebrew | ||
# Choose <code>boot.firm</code> and wait for the install to finish | # Choose <code>boot.firm</code> and wait for the install to finish | ||
# Reboot your console | # Reboot your console | ||
# If you see the Luma3DS configuration menu, enable any options that you need, then press Start | # 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 | #* Hint: If you don't know what the options are, you don't need them | ||
</translate> | |||
|-|<translate>Manually</translate>= | |||
==== <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>Installation</translate> ==== | |||
<translate> | |||
# Insert your SD card into your computer | # Insert your SD card into your computer | ||
# Copy <code>boot.firm</code> from the Luma3DS <code>.zip</code> to the root of your SD card, replacing <code>boot.firm</code> if it is already there | # Copy <code>boot.firm</code> from the Luma3DS <code>.zip</code> to the root of your SD card, replacing <code>boot.firm</code> if it is already there | ||
| Line 34: | Line 36: | ||
# If you see the Luma3DS configuration menu, enable any options that you need, then press Start | # 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 | #* Hint: If you don't know what the options are, you don't need them | ||
</translate> | |||
</tabber> | </tabber> | ||
== Using 3GX plugins == | == <translate>Using 3GX plugins</translate> == | ||
=== <translate>Plugin location</translate> === | |||
<translate> | |||
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. | 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. | ||
* 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> | * 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> | ||
* 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 | * 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 | ||
* 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 | * 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 | ||
</translate> | |||
An example directory for a plugin affecting one game would be <code>luma</code> -> <code>plugins</code> -> <code>0004000000190E00</code> -> <code>plugin.3gx</code>. | <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>. | ||
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 <tvar=luma_pl_path><code>luma</code> -> <code>plugins</code></tvar> -> <tvar=def3gx><code>default.3gx</code></tvar>.</translate> | ||
=== Launching 3GX plugins<span class="anchor" id="Using 3GX plugins"></span> === | === <translate>Launching 3GX plugins</translate><span class="anchor" id="Using 3GX plugins"></span> === | ||
# Open the Rosalina menu ({{B|Left Shoulder|D-Pad Down|SELECT}} by default) | <translate> | ||
# Scroll down to the plugin loader option, then press {{B|A}} to enable it | # Open the Rosalina menu <tvar="rlcombo>({{B|Left Shoulder|D-Pad Down|SELECT}}</tvar> by default) | ||
# Press {{B|B}} to exit the Rosalina menu | # Scroll down to the plugin loader option, then press <tvar=a>{{B|A}}</tvar> to enable it | ||
# Press <tvar=b>{{B|B}}</tvar> to exit the Rosalina menu | |||
# 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 | ||
# Look at the information on the plugin's webpage/README for usage instructions - usage will differ for each plugin | # Look at the information on the plugin's webpage/README for usage instructions - usage will differ for each plugin | ||
</translate> | |||
=== Usage notes === | === <translate>Usage notes</translate> === | ||
* Most plugins have a menu that can be opened by pressing {{B|SELECT}} while the plugin is loaded | * <translate>Most plugins have a menu that can be opened by pressing <tvar=select>{{B|SELECT}}</tvar> while the plugin is loaded</translate> | ||