Wumiibo 3DS: Difference between revisions

From GameBrew
(Created page with "{{Infobox 3DS homebrew | title = Wumiibo | image = https://dlhb.gamebrew.org/3dshomebrew/Wumiibo.jpg|250px | type = Utilities | version = v3.0 | licence = Mixed | author = hax...")
 
No edit summary
Line 10: Line 10:
| source = https://dlhb.gamebrew.org/3dshomebrew/Wumiibo.rar
| source = https://dlhb.gamebrew.org/3dshomebrew/Wumiibo.rar
}}
}}
<youtube>-TT6E6JAqW8</youtube>
= Wumiibo =
[[File:https://img.shields.io/badge/License-GPLv3-blue.svg|License]] [https://github.com/hax0kartik/wumiibo/releases/latest/ [[File:https://img.shields.io/github/release/hax0kartik/wumiibo.svg|GitHub release]]] [https://GitHub.com/hax0kartik/wumiibo/releases/latest/ [[File:https://img.shields.io/github/downloads/hax0kartik/wumiibo/total.svg|Github all releases]]] <img src="wumiibohelper/gfx/icon.png"/> Amiibo Emulation for 3ds.


== How To Use ==
Wumiibo is a Amiibo Emulation for 3ds. This is a rewrite of the 3ds's nfc module to enable amiibo emulation.


==How To Use==
You need to have the latest luma for this to work correctly.
You need to have the latest luma for this to work correctly.
* Put the <code>0004013000004002</code> folder in <code>luma/titles/</code>.
* Download the amiibo you want to emulate from [https://hax0kartik.github.io/amiibo-generator here]. All this website does is produce a bin file with amiiboID in it, so the produced file can be shared freely.
* Put the downloaded bins in a folder and put that folder in <code>sd:/wumiibo</code>. You can also place the bins directly inside <code>sd:/wumiibo</code>. You can have upto 49 folders and inside every folder you can have more subfolders. So if you sort your bins correctly, there is no limit on how many amiibos you can have at a time.
* Enable Title patching from luma menu (as shown [https://github.com/LumaTeam/Luma3DS/wiki/Optional-features here]).


* Put the <code>0004013000004002</code> folder in <code>luma/titles/</code>
==User guide==
* Download the amiibo you want to emulate from [https://hax0kartik.github.io/amiibo-generator here]. All this website does is produce a bin file with amiiboID in it, so the produced file can be shared freely!
Open your game and reach to the screen where it tells you to place your amiibo.
* Put the downloaded bins in a folder and put that folder in <code>sd:/wumiibo</code>. You can also place the bins directly inside <code>sd:/wumiibo</code>. You can have upto 49 folders and inside every folder you can have more subfolders. So if you sort your bins correctly, there is no limit on how many amiibos you can have at a time.
* Enable Title patching from luma menu. (As shown here: https://github.com/LumaTeam/Luma3DS/wiki/Optional-features)
* Open your game and reach to the screen where it tells you to place your amiibo.
* Press L + DOWN + START to bring up Wumiibo Menu and select the amiibo you wish to emulate.
* If everything went successfully, your amiibo should be emulated now. If you want to use your real amiibos, you'll need to disable wumiibo by disabling game patching from luma menu.


== Workaround for games which freeze ==
Press L+Down+Start to bring up Wumiibo Menu and select the amiibo you wish to emulate.


Some games freeze after closing wumiibo menu, check the [https://github.com/hax0kartik/wumiibo/wiki/Compatibility-List compatibility list] for these games. The following workaround can be used to emulate amiibos in such games.
If everything went successfully, your amiibo should be emulated now. If you want to use your real amiibos, you'll need to disable wumiibo by disabling game patching from luma menu.


===Compatibility game list===
Some games freeze after closing wumiibo menu, check the [https://github.com/hax0kartik/wumiibo/wiki/Compatibility-List compatibility list] for these games. The following workaround can be used to emulate amiibos in such games:
* After you have opened your game, press home button.
* After you have opened your game, press home button.
* Open wumiibo menu and choose what you want to do.
* Open wumiibo menu and choose what you want to do.
* Open the game again. Do not try to open wumiibo menu in such games.
* Open the game again. Do not try to open wumiibo menu in such games.


== Reporting bugs ==
===How to Compile===
Get devkitpro, ctrulib and makerom and then <code>make -j</code> to compile.


Please use github issues to report any games which don't work.
==Media==
<youtube>-TT6E6JAqW8</youtube>


== How to Compile ==
==Changelog==
'''v3.0 18 Dec 2020'''
* Fix wumiibo not recognizing some amiibos correctly.
** This was fixed by commit 069eff6. See issue #28 for more details.
* All 47 games are now compatible with wumiibo.
** With some games you still need to do the workaround for them to not freeze. Check the compatibilty list for such games.
* File limit bumped to 400 per directory.
* Introduce WumiiboHelper.
** WumiiboHelper is an easy to to use HB app. You can automatically download and install wumiibo from wumiibohelper.
** umiiboHelper has an option Generate amiibos for a game which can be used to produce compatible amiibos for a compatible game right from your 3ds.
** Note: This app is not well tested, please open an issue if you encounter any error. Amiibos can also be generated manually by using this website:- https://hax0kartik.github.io/amiibo-generator/
Minor improvements have been made.
* Note: Signal TagInRange and TagOutofRange are debug features, you shouldn't need them.


Get devkitpro, ctrulib and makerom and then <code>make -j</code> to compile.
'''v2.0 25 Sept 2020'''
* Proper UID assignment and UID Randomization has been added.
** Wumiibo no longer uses a hardcoded UID for every amiibo. It automatically assigns a new UID to every amiibo.
** Some games limit users to only one scan of a specific amiibo per 24 hours. By randomizing an amiibo's UID you can overcome this limit.
** Note: This depends on the game's logic, and may not work with every title.
* Default wumiibo menu button can now be overridden.
** This can be done by creating a wumiibo.ini file on the root of your sd card. A sample of this file is here.
* DirectoryLister code has been improved.
** You can now have upto 49 folders within the wumiibo folder. Inside every folder you can have even more subfolders or amiibos. So if you create your folders properly, there is virtually no limit on how many amiibos you can have at a time.
** As a bonus feature, if you want to have a dedicated folder for a game, you can give a folder the game's TitleID and put all relevant amiibos in there. For example, for Super Smash Bros EUR, you can create a folder sd:/wumiibo/00040000000EE000 and put the amiibos in there. Wumiibo will automatically open this folder in-game.
* Various bugs have been fixed and minor improvements have been made.


== Technical Details ==
'''v1.0 1 Sept 2020'''
* Due to popular community demand the client and module have been completely rewrote and merged, so the client is not required anymore starting this release.
* Many critical bugs have been fixed and squashed.


This is a rewrite of the 3ds's nfc module to enable amiibo emulation.
'''v0.1 23 Aug 2020'''
* First release.


== Credits ==
==Credits==
* @Luigoalma for advising and for listening to the rants.
* @HiddenRambings for noamii, which served as a base for to extend and develop upon.
* @3dbrew folks for the nicely documented nfc and amiibo pages.
* @Socram8888 for amiitool, reversing nfc, etc.
* @Luma3ds devs lots of code has been copied from rosalina.
* druivensap, loveleiz, thomas, Marcus777, k9999, Mr.Faq, MissingNerd and many others who helped testing wumiibo.


== @Luigoalma for advising me and for listening to my rants. @HiddenRambings for <code>noamii</code>, which served as a base for me to extend and develop upon. @3dbrew folks for the nicely documented nfc and amiibo pages. @Socram8888 for amiitool, reversing nfc, etc. @Luma3ds devs lots of code has been copied from rosalina druivensap, loveleiz, thomas, Marcus777, k9999, Mr.Faq, MissingNerd and many others who helped testing wumiibo. And surely many more people out there, whom I have forgotten to mention. ==
==External links==
GitHub, https://github.com/hax0kartik/wumiibo
GBAtemp, https://gbatemp.net/threads/wip-wumiibo-amiibo-emulation-for-3ds.572442


If you would like to support me you can buy me a coffee on [https://ko-fi.com/hax0kartik ko-fi] or you can [https://www.paypal.com/paypalme/preetiagarwala?locale.x=en_GB paypal] me! Thank you!
[[Category:3DS homebrew application]]
[[Category:Homebrew utility applications on 3DS]]

Revision as of 07:56, 5 July 2021

Template:Infobox 3DS homebrew

Wumiibo is a Amiibo Emulation for 3ds. This is a rewrite of the 3ds's nfc module to enable amiibo emulation.

How To Use

You need to have the latest luma for this to work correctly.

  • Put the 0004013000004002 folder in luma/titles/.
  • Download the amiibo you want to emulate from here. All this website does is produce a bin file with amiiboID in it, so the produced file can be shared freely.
  • Put the downloaded bins in a folder and put that folder in sd:/wumiibo. You can also place the bins directly inside sd:/wumiibo. You can have upto 49 folders and inside every folder you can have more subfolders. So if you sort your bins correctly, there is no limit on how many amiibos you can have at a time.
  • Enable Title patching from luma menu (as shown here).

User guide

Open your game and reach to the screen where it tells you to place your amiibo.

Press L+Down+Start to bring up Wumiibo Menu and select the amiibo you wish to emulate.

If everything went successfully, your amiibo should be emulated now. If you want to use your real amiibos, you'll need to disable wumiibo by disabling game patching from luma menu.

Compatibility game list

Some games freeze after closing wumiibo menu, check the compatibility list for these games. The following workaround can be used to emulate amiibos in such games:

  • After you have opened your game, press home button.
  • Open wumiibo menu and choose what you want to do.
  • Open the game again. Do not try to open wumiibo menu in such games.

How to Compile

Get devkitpro, ctrulib and makerom and then make -j to compile.

Media

Changelog

v3.0 18 Dec 2020

  • Fix wumiibo not recognizing some amiibos correctly.
    • This was fixed by commit 069eff6. See issue #28 for more details.
  • All 47 games are now compatible with wumiibo.
    • With some games you still need to do the workaround for them to not freeze. Check the compatibilty list for such games.
  • File limit bumped to 400 per directory.
  • Introduce WumiiboHelper.
    • WumiiboHelper is an easy to to use HB app. You can automatically download and install wumiibo from wumiibohelper.
    • umiiboHelper has an option Generate amiibos for a game which can be used to produce compatible amiibos for a compatible game right from your 3ds.
    • Note: This app is not well tested, please open an issue if you encounter any error. Amiibos can also be generated manually by using this website:- https://hax0kartik.github.io/amiibo-generator/

Minor improvements have been made.

  • Note: Signal TagInRange and TagOutofRange are debug features, you shouldn't need them.

v2.0 25 Sept 2020

  • Proper UID assignment and UID Randomization has been added.
    • Wumiibo no longer uses a hardcoded UID for every amiibo. It automatically assigns a new UID to every amiibo.
    • Some games limit users to only one scan of a specific amiibo per 24 hours. By randomizing an amiibo's UID you can overcome this limit.
    • Note: This depends on the game's logic, and may not work with every title.
  • Default wumiibo menu button can now be overridden.
    • This can be done by creating a wumiibo.ini file on the root of your sd card. A sample of this file is here.
  • DirectoryLister code has been improved.
    • You can now have upto 49 folders within the wumiibo folder. Inside every folder you can have even more subfolders or amiibos. So if you create your folders properly, there is virtually no limit on how many amiibos you can have at a time.
    • As a bonus feature, if you want to have a dedicated folder for a game, you can give a folder the game's TitleID and put all relevant amiibos in there. For example, for Super Smash Bros EUR, you can create a folder sd:/wumiibo/00040000000EE000 and put the amiibos in there. Wumiibo will automatically open this folder in-game.
  • Various bugs have been fixed and minor improvements have been made.

v1.0 1 Sept 2020

  • Due to popular community demand the client and module have been completely rewrote and merged, so the client is not required anymore starting this release.
  • Many critical bugs have been fixed and squashed.

v0.1 23 Aug 2020

  • First release.

Credits

  • @Luigoalma for advising and for listening to the rants.
  • @HiddenRambings for noamii, which served as a base for to extend and develop upon.
  • @3dbrew folks for the nicely documented nfc and amiibo pages.
  • @Socram8888 for amiitool, reversing nfc, etc.
  • @Luma3ds devs lots of code has been copied from rosalina.
  • druivensap, loveleiz, thomas, Marcus777, k9999, Mr.Faq, MissingNerd and many others who helped testing wumiibo.

External links

GitHub, https://github.com/hax0kartik/wumiibo GBAtemp, https://gbatemp.net/threads/wip-wumiibo-amiibo-emulation-for-3ds.572442

Advertising: