3dsconv

3dsconv
3dsconv
General
Author	ihaveamac
Type	PC Utilities
Version	4.2
License	MIT License
Last Updated	2017/08/03
Links
	Download
	Website
	Source

3dsconv.py is a Python 3 tool that converts Nintendo 3DS game dumps (in .cci or .3ds format) into installable .cia files, the format used for installing games directly to your 3DS home menu.

It supports CCI that is decrypted, encrypted using zerokey, or the original NCCH (slot 0x2C).

Encryption requires pyaes (pip install pyaes).
Original NCCH encryption requires a dump of the protected ARM9 bootROM.

User guide

Basic use (Windows)

Just drag and drop your .3ds or .cci file onto 3dsconv.exe

(Note: For encrypted files, see the Encryption section below.)

Command line

You can run it as a standalone script or install it with:

python3 setup.py install

Basic command:

python3 3dsconv.py [options] game.3ds [game2.3ds ...]

Options:

--output=<dir> - Save converted files to a custom folder (default: current directory or output-directory variable).
- --boot9=<file> - Path to your ARM9 bootROM dump.
- --overwrite - Replace existing .cia files.
- --ignore-bad-hashes - Convert even if file hashes are invalid.
- --ignore-encryption - Treat the file as unencrypted.
- --verbose - Show detailed conversion info.
- --dev-keys - Use developer-unit keys.

Encryption requirements

To decrypt games using original NCCH encryption (slot 0x2C), you’ll need a copy of the 3DS ARM9 bootROM (either boot9.bin or boot9_prot.bin).

The file is checked in the order of:

Path set by --boot9= or boot9_path
boot9.bin (full) in the current folder
boot9_prot.bin (protected) in the current folder
~/.3ds/boot9.bin (full)
~/.3ds/boot9_prot.bin (protected)

How to dump your bootROM:

Use boot9strap (follow 3DS Guide).
Hold Start+Select+X while booting to dump to sdmc:/boot9strap/boot9.bin.

SHA-256 checksums (to verify your dump):

boot9.bin: 2f88744feed717856386400a44bba4b9ca62e76a32c715d4f309c399bf28166f
boot9_prot.bin: 7331f7edece3dd33f2ab4bd0b3a5d607229fd19212c10b734cedcaf78c1a7b98

Changelog

v4.2

Fix conversion of titles with a dlp-child but no manual (gbatemp).
Now installable using setuptools, download source code and use python3 setup.py install (#13, thanks @dr1s).
Titles can be converted for use on dev-units (not fully tested), including those encrypted with dev-unit keys. See README for usage and limitations.

v4.1

Generate Meta region, for use with FBI and other tools.
Some more code cleanup.

v4.0

Rewrite for Python 3 - 2.x is no longer supported.
Use pyaes instead of PyCrypto[dome].
bootROM keys support - see README for details on usage.
XORpad support removed.
Rewritten output messages.
Other things I might have forgotten about.

v3.21

Fix encrypted CCIs improperly being detected as zerokey encrypted (#8, thanks @putnam).
Fix bad ncchinfo.bin generation (wrong block size).

v3.2

New: Zerokey crypto support without XORpads.
- PyCrypto is required. This can be installed with pip.
- This does not decrypt the contents of the CIA. Custom firmwares today don't support zerokey, only Gateway and Nintendo developer tools/firmware at the moment. Decrypt the CIA with Decrypt9 before installing. Decryption might come later, depending if custom firmwares support zerokey anytime soon.
New: --ignorebadhash to ignore bad SHA-256 hash of the ExHeader (is this even that useful?)
Code cleanup and other things.

v3.1

Show percentage for each partition.
Other minor changes.

v3.0

Manually builds the CIA now; makerom is no longer needed.
- This should mean lower-memory computers can properly convert larger games.

v2.2

Switched dependency from make_cia -> makerom (too many issues with make_cia, not worth it anymore).
- This should fix any issues with Manual/Download Play not working (#5).

v2.16

py2exe support for building a single .exe for Windows.
Other small fixes.

v2.15

Fix ncchinfo.bin generation again (not generating sometimes with just --gen-ncchinfo unless --gen-ncch-all was used).

v2.14

Fix ncchinfo.bin generation (wrong variable used).

v2.13

Fix: close Manual/Download Play child container before deleting (only seemed to be an issue on Windows).
Fix: output folder not being created (?)
Temporary work directory can be changed (variable workdir).
make_cia more verbose if --verbose is used.
Cleanup (tabs to spaces, re-organize code order, etc.)

v2.12

Wildcard support for Windows (because the command prompt doesn't support it for some reason).
Properly close rom in case ExHeader hash check fails.

v2.11

Fix ncchinfo.bin generation (generating a bad "Counter").

v2.1

3dstool is no longer used, only make_cia is required now.
New: --overwrite - overwrite any existing converted CIA, if it exists.
New: --gen-ncchinfo - generate ncchinfo.bin for roms that don't have a valid xorpad.
- ncchinfo_gen_exheader.py is no longer included.
New: --gen-ncch-all - use with --gen-ncchinfo to generate an ncchinfo.bin for all roms.
New: --noconvert - don't convert roms, useful if you just want to generate ncchinfo.bin
Fix converting decrypted roms with both Manual and Download Play child container.
Various other changes.

v2.01

Fixes potential hanging trying to check if a command exists.
Fixes converting a .3ds to a .cia if the .cia already exists on Windows.

v2.0

First Release.

License / Credits

3dsconv.py and pyaes are under the MIT license.

For versions older than "2.0", see this Gist.

External links