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
Cominou (talk | contribs)
fix test
Marked this version for translation
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<languages/>{{shortcut|3DS:3GX|3GX}}
<languages/>{{shortcut|3DS:3GX|3GX}}
<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>
<translate>
<!--T:1-->
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 == <!--T:2-->
</translate>


<tabber>
<tabber>
|-|Universal-Updater=
|-|Universal-Updater=
==== <translate>What you need</translate> ====
<translate>
==== What you need ==== <!--T:3-->
</translate>


* [[3DS:Universal-Updater|Universal-Updater]]
* {{ml|3DS:Universal-Updater|Universal-Updater}}
 
==== <translate>Installation</translate> ====


<translate>
<translate>
# Power on your console
==== Installation ==== <!--T:4-->
# 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'''
# 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
# 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
</translate>
</translate>
|-|<translate>Manually</translate>=


==== <translate>What you need</translate> ====
<ol>
<li><translate><!--T:5--> Power on your console</translate></li>
<li><translate><!--T:6--> Launch <tvar name="1">'''Universal-Updater'''</tvar> from the HOME Menu, or from the Homebrew Launcher</translate></li>
<li><translate><!--T:7--> Select the magnifying glass on the bottom screen, then search for '''Luma3DS'''</translate></li>
<li><translate><!--T:8--> Press <tvar name="2">{{B|A}}</tvar> while hovering over '''Luma3DS''' from the list of homebrew</translate></li>
<li><translate><!--T:9--> Choose <code>boot.firm</code> and wait for the install to finish</translate></li>
<li><translate><!--T:10--> Reboot your console</translate></li>
<li><translate><!--T:11--> If you see the Luma3DS configuration menu, enable any options that you need, then press Start</translate></li>
<ul><li><translate><!--T:12--> Hint: If you don't know what the options are, you don't need them</translate>
</li></ul>
</ol>
|-|<translate><!--T:13--> Manually</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>
==== What you need ==== <!--T:14-->
</translate>


==== <translate>Installation</translate> ====
* <translate><!--T:15--> The latest release of <tvar name="3">[https://github.com/LumaTeam/Luma3DS/releases/latest Luma3DS]</tvar> (the Luma3DS <code>.zip</code> file)</translate>


<translate>
<translate>
# Insert your SD card into your computer
==== Installation ==== <!--T:16-->
# 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
# 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
</translate>
</translate>
<ol>
<li><translate><!--T:17--> Insert your SD card into your computer</translate></li>
<li><translate><!--T:18--> 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</translate></li>
<li><translate><!--T:19--> Reinsert your SD card into your console and power on</translate></li>
<li><translate><!--T:20--> If you see the Luma3DS configuration menu, enable any options that you need, then press Start</translate></li>
<ul><li><translate><!--T:21--> Hint: If you don't know what the options are, you don't need them</translate>
</li></ul>
</ol>


</tabber>
</tabber>


== <translate>Using 3GX plugins</translate> ==
<translate>
=== <translate>Plugin location</translate> ===
== Using 3GX plugins == <!--T:22-->
</translate>
<translate>
=== Plugin location === <!--T:23-->
</translate>


<translate>
<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.
<!--T:24-->
* 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 3GX plugin loader will look for plugins in the <tvar name="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.
* 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
* You can get the game's title ID from [<tvar name="5">http://3dsdb.com/</tvar> here] (cartridges), [<tvar name="6">https://hax0kartik.github.io/3dsdb/</tvar> here] (digital games), or from the <tvar name="7"><code>FBI -> Titles</code></tvar> menu. For example, <tvar name="8">Taiko no Tatsujin: Dokodon! Mystery Adventure</tvar>'s title ID is <tvar name="9"><code>0004000000190E00</code></tvar>, so if you wanted to use a plugin for that game, you'd create a folder named <tvar name="10"><code>0004000000190E00</code></tvar>
* 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
* 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 name="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 name="12"><code>plugins</code></tvar> folder
</translate>
</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><!--T:25-->
An example directory for a plugin affecting one game would be <tvar name="13"><code>luma</code> -> <code>plugins</code></tvar> -> <tvar name="14"><code>0004000000190E00</code></tvar> -> <tvar name="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>
<!--T:26-->
An example directory for a plugin affecting all games would be <tvar name="16"><code>luma</code> -> <code>plugins</code></tvar> -> <tvar name="17"><code>default.3gx</code></tvar>.</translate>


=== <translate>Launching 3GX plugins</translate><span class="anchor" id="Using 3GX plugins"></span> ===
<translate>
=== Launching 3GX plugins<tvar name="anchor"><span class="anchor" id="Using 3GX plugins"></span></tvar> === <!--T:27-->
</translate>


<ol>
<li><translate><!--T:28--> Open the Rosalina menu <tvar name="18">({{B|Left Shoulder|D-Pad Down|SELECT}}</tvar> by default)</translate></li>
<li><translate><!--T:29--> Scroll down to the plugin loader option, then press <tvar name="19">{{B|A}}</tvar> to enable it</translate></li>
<li><translate><!--T:30--> Press <tvar name="20">{{B|B}}</tvar> to exit the Rosalina menu </translate></li>
<li><translate><!--T:31--> Open your game of choice</translate></li>
<ul><li><translate><!--T:32--> The screen should flash another color to indicate that the plugin has successfully loaded</translate>
</li></ul>
<li><translate><!--T:33--> Look at the information on the plugin's webpage/README for usage instructions - usage will differ for each plugin</translate></li>
</ol>
<translate>
<translate>
# Open the Rosalina menu <tvar="rlcombo">({{B|Left Shoulder|D-Pad Down|SELECT}}</tvar> by default)
=== Usage notes === <!--T:34-->
# 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
#* 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
</translate>
</translate>
=== <translate>Usage notes</translate> ===
* <translate><!--T:35--> Most plugins have a menu that can be opened by pressing <tvar name="21">{{B|SELECT}}</tvar> while the plugin is loaded</translate>
* <translate>Most plugins have a menu that can be opened by pressing <tvar="SELECT">{{B|SELECT}}</tvar> while the plugin is loaded</translate>