cleaninty EShopDelete -C soap_target.json
Developer(s) | luigoalma |
---|---|
Platform | Microsoft Windows, macOS, Linux |
Version | 0.1.3 (March 18, 2023; 18 months ago (2023-03-18)) |
Links | |
GitHub | luigoalma/cleaninty |
Download | |
cleaninty is a PC tool used to communicate with Nintendo's SOAP servers. For a 3DS, these servers deal with managing eShop accounts, downloading eShop titles, and system transfers. It is also the tool used for what is informally known as a "SOAP transfer".
There are two pieces of data a 3DS that give it a unique ID to Nintendo's eShop servers: its serial number and its otp.bin
. If these are copied out of the console and used somewhere else, they can be used to imitate the console - meaning Nintendo's servers can act on commands without the console doing anything on its end.
However, the files cannot communicate on their own, and a connection to Nintendo's servers that acts identically to a console is still needed. This part is where cleaninty comes in.
The reason this allows for changing eShop regions easily, and at infinite range, are as follows:
When the required constants have been supplied through SetupConstants
and you have the unique data (otp.bin
and either SecureInfo.bin
or the serial number) of a console, cleaninty can act as that console and do the following:
GenJson
: Compiles the console's data into a single JSON file. This JSON is required for all other commands except RecoverIVS
.CheckReg
: Obtains the console's eShop status, eShop region, and any titles attached to its eShop account, then updates the JSON file if any differences in the data are found.SysTransfer
: Moves the eShop titles of the source console to the target console. This is the only part of a SOAP transfer if the console has region-locked tickets, as it will do an EShopDelete
as part of the transfer.
NNIDTransfer
: (Still experimental. Use with caution.) Moves only the NNIDs of the source console to the target console. This is not affected by system transfer cooldowns and does not trigger one.LastTransfer
: Provides the date&time of the given console's last system transfer, the number of transfers it has ever done, and the time at which the current transfer cooldown will expire if there is one active.GetIVS
: Downloads the console's movable.sed
from the SOAP servers, if the servers have a stored copy.SetIVS
: Uploads the chosen JSON's stored movable.sed
to the SOAP servers. This will overwrite the current stored movable.RecoverIVS
: Tries to recover a console's movable.sed
from only its raw otp.bin
and eShop region data.EShopDelete
: Deletes the target console's eShop account. This is the secondary part of a SOAP transfer, as the console will then automatically register an account in the correct region when it next accesses the eShop.EShopRegionChange
: Attempts to delete and then recreate the target console's eShop account for the entered region. This is the main part of a SOAP transfer if the console has no region-locked tickets, but an EShopDelete
should still be done afterward.ETickets
/ETicketDownload
/ETikTitleDownload
: Lists all owned eShop tickets / downloads all tickets / downloads the titles attached to all tickets, respectively, from the given console's eShop account.
Instructions for installation & setup are on the GitHub page, but the installation instructions may need to be interpreted for your OS.
Regardless of your OS, you will need a 3DS with both custom firmware and GodMode9 installed to dump all of the files required to do SetupConstants
. The vast majority of them are dumped using ExtractSystemElements.gm9, but the the AES Constant "C" is found using the full set of instructions on this page.
The AES Constant, along with all other constants used by cleaninty, are copyrighted data. Obtaining them from your own console(s) is fine, but do not share the constants with anyone else. |
These constants are the same on all consoles. Once one set is dumped, you will not need to redump in the future unless you lose access to them. |
Don't bother trying to install cleaninty on Windows directly. Windows has OpenSSL disabled in its curl.exe
, but cleaninty requires OpenSSL to function. Working around this issue manually is obnoxious and not worth the time spent.
Instead, there are two options:
To install cleaninty inside msys2, open the terminal mingw64.exe
that is inside the msys2 installation folder, then run the following two commands one at a time:
pacman -Syu mingw-w64-x86_64-python mingw-w64-x86_64-python-defusedxml mingw-w64-x86_64-python-cryptography mingw-w64-x86_64-python-pycurl
python -m pip install cleaninty
Once this is completed, from here on out you will need to open the msys2 mingw64.exe
terminal to use cleaninty.
Be aware that when using cleaninty through msys2, the place it will look in to find boot9.bin , SSLCertificates , and ctr_constants.json is a folder named 3ds inside your msys2 home folder. |
First, ensure you have Python 3.7 or newer. You can check if your Python version is new enough by opening a terminal and running the command python3 --version
. If you do not, install a compatible version from either your package manager or the Python website.
Then, either install cleaninty directly from pip
or clone its repo via the command git clone https://github.com/luigoalma/cleaninty.git
and then run the setup.py
script.
Make sure the files for all consoles you compile into a json are accurate before using them in cleaninty, or else the commands may affect a different console than they "should be".
The easiest way to do this is by checking the serial sticker(s) on the console against the copy of the serial in SecureInfo_A. |
There is no graphical interface for cleaninty. All commands are ran through the command line.
The commands are the same on all operating systems. Run cleaninty ctr (command) --help
for information on an individual command's syntax.
As an example, the minimum list of commands needed to set up two consoles' data and perform a SOAP transfer between them would be as follows:
cleaninty ctr GenJson --otp otp.bin --secureinfo secinfo.bin --out soap_donor.json
cleaninty ctr GenJson --otp otp1.bin --secureinfo secinfo1.bin --out soap_target.json
cleaninty ctr CheckReg -C soap_donor.json
cleaninty ctr CheckReg -C soap_target.json
cleaninty ctr EShopRegionChange -C soap_target.json -r (eShop region) -c (eShop country - not required if region is JPN/KOR/CHN)
soap_target.json
's CheckReg
.
cleaninty EShopDelete -C soap_target.json
cleaninty ctr SysTransfer -s soap_target.json -t soap_donor.json
If you are inexperienced with the command line or just don't want to type the commands manually every time, there is a SOAP bash script made by StarlitSkies that heavily simplifies the process.
Read the instructions on its page for setup and usage.