nxdumptool/README.md

nxdumptool

Nintendo Switch Dump Tool

Temporary branch used for the development of the nxdumptool rewrite. Highly experimental, use at your own risk.

If a nxdumptool build from the releases page isn't working for whatever you're trying to do (e.g. RomFS dumping), odds are it will work with a experimental proof-of-concept build from this particular branch. The old branch will not receive any further updates.

A GitHub workflow is used to automatically build each new commit -- feel free to check it out. For additional information, please reach us at our Discord server.

This readme will be updated whenever the rewrite branch is ready for a proper release.

Currently planned changes for this branch include:

• USB ABI (dump data directly to a PC). ✅
• USB Mass Storage device support (FAT, NTFS, EXT). ✅
• Gamecard header dumps. ✅
• Gamecard CardInfo area dumps. ✅
• Gamecard InitialData area dumps. ✅
• Individual NCA dumps (select and dump a specific NCA from a title). ✅
• Individual NCA FS section dumps (select and dump a specific FS section from a specific NCA belonging to a title, in both extracted and raw image forms) (this includes patched RomFS images). ✅
• System title support (e.g. dump qlaunch, shared fonts and much, much more at runtime). ✅
• Volatile ticket dumping. ✅
• Better memory handling while dealing with compressed NRO binaries. ✅
• Event-driven background threads to manage gamecard insertions/ejections, gamecard application metadata parsing (e.g. the game would be properly identified even if it's gamecard has never been used on your console), USB ABI sessions and USB Mass Storage devices. ✅
• Improved support for multigame gamecards and titles with more than one Program NCA (e.g. SM3DAS). ✅
• Control.nacp patching while dumping NSPs (lets you patch screenshot, video, user account and HDCP restrictions). ✅
• Full system update dumps. ❌
• New UI using a customized borealis fork. ⚠️

Legend:

• ✅ - Implemented
• ⚠️ - Partially implemented
• ❌ - Not implemented