Approver
518
edits
overhaul of page adding →Config file: and →SD file layout: sections . Reworded several sections and removed some unnecessary troubleshooting.
(moved "Using real figurines" section out of troubleshooting) |
(overhaul of page adding →Config file: and →SD file layout: sections . Reworded several sections and removed some unnecessary troubleshooting.) |
||
| Line 2: | Line 2: | ||
| title = Wumiibo | | title = Wumiibo | ||
| image = Wumiibo-Helper-banner.png | | image = Wumiibo-Helper-banner.png | ||
| imagealt = WumiiboHelper banner | | imagealt = WumiiboHelper's Home Menu banner | ||
| for3ds = 1 | | for3ds = 1 | ||
| developers = hax0kartik | | developers = hax0kartik | ||
| Line 11: | Line 11: | ||
| universaldb = 3ds/wumiibo | | universaldb = 3ds/wumiibo | ||
}} | }} | ||
'''Wumiibo''' is a rewrite of the 3DS' | '''Wumiibo''' is a rewrite of the 3DS' NFC module, that allow for the emulation of amiibo. As Wumiibo does not actually use the NFC hardware, this allows it you work on "old" 3DS family consoles, or consoles with Wireless Communication turned off or disabled. | ||
=Installation= | == Installation == | ||
<tabber> | <tabber> | ||
|-|Universal Updater= | |-|Universal Updater= | ||
<span> | <span> | ||
=== | === What you need === | ||
* A working internet connection | * A working internet connection | ||
* [[3DS:Universal-Updater|Universal Updater]] installed on your console | * [[3DS:Universal-Updater|Universal Updater]] installed on your console | ||
* [[3DS:luma3DS|Luma3DS]] updated to 13.0+ | * [[3DS:luma3DS|Luma3DS]] updated to 13.0+ | ||
=== | === Instructions === | ||
# Power on | # Power on your console | ||
# Launch '''Universal | # Launch '''Universal Updater''' | ||
# | # Select the magnifying glass on the bottom screen, then search for '''wumiibo''' | ||
# Press {{B|A}} while hovering over '''wumiibo''' from the list of homebrew | # Press {{B|A}} while hovering over '''wumiibo''' from the list of homebrew | ||
# Choose <code>wumiibohelper.cia</code> | # Choose <code>wumiibohelper.cia</code> | ||
# Wait until the app | # Wait until the app finishes installing | ||
# Close '''Universal | # Close '''Universal Updater''' | ||
# Launch '''Wumiibo | # Launch '''Wumiibo''' and select <code>Download Wumiibo</code> | ||
# Wait for it to download and reboot, then press {{B|B}} to exit the app | # Wait for it to download and reboot, then press {{B|B}} to exit the app | ||
# Power off your | # Power off your console | ||
# While holding {{B|SELECT}}, power on your console to enter Luma3DS configuration | # While holding {{B|SELECT}}, power on your console to enter [[3DS:Luma3DS/Configuration|the Luma3DS configuration menu]] | ||
# | # Turn on '''Enable loading external FIRMs and modules''' and '''Enable game patching''' if they are not already enabled | ||
# Press {{B|START}} to save and exit | # Press {{B|START}} to save and exit | ||
</span> | </span> | ||
|-|Manual= | |-|Manual= | ||
<span> | <span> | ||
=== | === What you need === | ||
* | * The latest release of {{GitHub|hax0kartik/Wumiibo/releases/latest|'''Wumiibo'''}} (the <code>0004013000004002.cxi</code> and <code>wumiibohelper.cia</code> files) | ||
* [[3DS:FBI|FBI]] installed on your console | * [[3DS:FBI|FBI]] installed on your console | ||
* [[3DS:luma3DS|Luma3DS]] | * A v13.0 or higher version of [[3DS:luma3DS|Luma3DS]]' <code>boot.firm</code> on the root of your SD card | ||
===Instructions=== | === Instructions === | ||
# Copy <code>0004013000004002.cxi</code> to <code>sd:/luma/sysmodules/</code> | # Copy <code>0004013000004002.cxi</code> to <code>sd:/luma/sysmodules/</code> | ||
#* Create the folder <code>sysmodules</code> if it doesn't exist | #* Create the folder <code>sysmodules</code> if it doesn't exist | ||
# Copy <code> | # Copy <code>Wumiibohelper.cia</code> to the root of your SD card | ||
# Reinsert your SD card into your console | # Reinsert your SD card into your console | ||
# Launch '''FBI''' and select <code>SD</code> -> <code> | # Launch '''FBI''' and select <code>SD</code> -> <code>Wumiibohelper.cia</code> -> <code>Install and delete CIA</code> | ||
# Press {{B|A}} and wait for the CIA to install, then exit '''FBI''' | # Press {{B|A}} and wait for the CIA to install, then exit '''FBI''' | ||
# Power off your | # Power off your console | ||
# While holding {{B|SELECT}}, power on your console to enter Luma3DS configuration | # While holding {{B|SELECT}}, power on your console to enter [[3DS:Luma3DS/Configuration|the Luma3DS configuration menu]] | ||
# | # Turn on '''Enable loading external FIRMs and modules''' and '''Enable game patching''' if they are not already enabled | ||
# Press {{B|START}} to save and exit | # Press {{B|START}} to save and exit | ||
</span> | </span> | ||
</tabber> | </tabber> | ||
==Generating amiibo== | ==Usage== | ||
# Launch '''Wumiibo | ===Generating amiibo=== | ||
# Power on your console | |||
# Launch '''Wumiibo''' from the HOME Menu | |||
# Select "'''Generate amiibos for game'''" | # Select "'''Generate amiibos for game'''" | ||
# Select a game from the list and then select an amiibo to generate | # Select a game from the list and then select an amiibo to generate | ||
# The amiibo will be generated and is now ready to be used | # The amiibo will be generated and is now ready to be used | ||
==Registering amiibo== | ===Registering amiibo=== | ||
''This section is not necessary for all games, but is recommended for full compatibility'' | ''This section is not necessary for all games, but is recommended for full compatibility'' | ||
# Select HOME Menu Settings by tapping on the wrench icon in the top left | # Select HOME Menu Settings by tapping on the wrench icon in the top left | ||
# Scroll down and tap on "'''amiibo Settings'''" | # Scroll down and tap on "'''amiibo Settings'''" | ||
# Select "'''Register Owner and Nickname'''" | # Select "'''Register Owner and Nickname'''" | ||
# Press {{B|L | # Press {{B|L|DOWN|START}} to open the '''Wumiibo Menu''' | ||
# Select <code>Select a figure.</code> -> <code><TitleID></code> -> <code><amiibo name>.bin</code> | # Select <code>Select a figure.</code> -> <code><TitleID></code> -> <code><amiibo name>.bin</code> | ||
# Fill in the required details and press {{B|Y}} to save | # Fill in the required details and press {{B|Y}} to save | ||
# Wait for the amiibo to save and then press {{B|L | # Wait for the amiibo to save and then press {{B|L|DOWN|START}} to open the '''Wumiibo Menu''' again | ||
# Select <code>Force Stop Emulation.</code> | # Select <code>Force Stop Emulation.</code> | ||
#* Repeat steps 3 | #* Repeat steps 3 through 8 for the rest of the amiibo you want to register | ||
==Using amiibo in games== | ===Using amiibo in games=== | ||
# Launch an amiibo compatible game and navigate to the screen that asks you to place your amiibo on the screen | # Launch an amiibo compatible game and navigate to the screen that asks you to place your amiibo on the screen | ||
# Press {{B|L | # Press {{B|L|DOWN|START}} to open the '''Wumiibo Menu''' | ||
# Select <code>Select a figure.</code> -> <code><TitleID></code> -> <code><amiibo name>.bin</code> | # Select <code>Select a figure.</code> -> <code><TitleID></code> -> <code><amiibo name>.bin</code> | ||
# The amiibo will now be emulated, and act as though its always "''on''" the nfc reader | # The amiibo will now be emulated, and act as though its always "''on''" the nfc reader | ||
# If the game asks to remove the amiibo, relaunch the '''Wumiibo Menu''' and select <code>Force Stop Emulation.</code> | # If the game asks to remove the amiibo, relaunch the '''Wumiibo Menu''' and select <code>Force Stop Emulation.</code> | ||
==Using real figurines== | ===Using real figurines=== | ||
Wumiibo doesn't work with real figurines, in order to use | Wumiibo doesn't work with real figurines, toggle Wumiibo off in order to use them again | ||
# Launch '''Wumiibo | # Launch '''Wumiibo''' from the HOME Menu | ||
# Select <code>Toggle Wumiibo State</code> | # Select <code>Toggle Wumiibo State</code> | ||
# Press {{B|B}} to reboot | # Press {{B|B}} to reboot | ||
| Line 94: | Line 98: | ||
# Repeat steps 1-3 to toggle Wumiibo back on | # Repeat steps 1-3 to toggle Wumiibo back on | ||
=Troubleshooting= | ==Configuration== | ||
===Config file=== | |||
Wumiibo may be configured with a config file placed at <code>sd:/wumiibo.ini</code>. This can be used to change the button combo needed to open the Wumiibo Menu, or turn on debug mode. A sample config with the button combo set to {{B|R|DOWN|START}} can be found {{GitHub|hax0kartik/wumiibo/blob/v4.2/wumiibo.ini|here}}. | |||
===SD file layout=== | |||
{{Tree list}} | |||
* {{Tree icon|sd}} (root) | |||
** {{Tree icon|d}} luma | |||
*** {{Tree icon|d}} sysmodules | |||
**** {{Tree icon|f}} 0004013000004002.cxi | |||
** {{Tree icon|d}} wumiibo | |||
*** {{Tree icon|d}} <title ID> | |||
**** {{Tree icon|f}} <amiibo name>.bin | |||
**{{Tree icon|f}} wumiibo.ini | |||
{{Tree list/end}} | |||
==Troubleshooting== | |||
===Workaround for freezing games=== | ===Workaround for freezing games=== | ||
If the game freezes or lags when trying to scan amiibo, | If the game freezes or lags when trying to scan amiibo, try the following workaround: | ||
# Navigate to the screen that asks you to place your amiibo on the screen | # Navigate to the screen that asks you to place your amiibo on the screen | ||
# Press {{B|HOME}} to suspend the game | # Press {{B|HOME}} to suspend the game | ||
# Press {{B|L | # Press {{B|L|DOWN|START}} to open the '''Wumiibo Menu''' and select your amiibo | ||
# Reopen the suspended game | # Reopen the suspended game | ||
===Conflicting Wumiibo versions=== | ===Conflicting Wumiibo versions=== | ||
With the release of {{GitHub|hax0kartik/wumiibo/releases/tag/v4.2|Wumiibo 4.2}}, Wumiibo has been updated to use CXI-based patching introduced in {{GitHub|LumaTeam/Luma3DS/releases/tag/v13.0|Luma3DS 13.0}}, this means you may have two versions of Wumiibo installed to your system: | |||
* If you've installed Wumiibo previously, delete the <code>0004013000004002</code> folder in <code>sd:/luma/titles/</code> | * If you've installed Wumiibo previously, delete the <code>0004013000004002</code> folder in <code>sd:/luma/titles/</code> | ||
==Resources== | ==Resources== | ||