1
0
Fork 0
mirror of https://github.com/DarkMatterCore/nxdumptool.git synced 2024-11-23 02:36:41 +00:00
nxdumptool/README.md

39 lines
2.9 KiB
Markdown
Raw Permalink Normal View History

2023-03-29 22:40:06 +01:00
# nxdumptool
<img width="200" src="romfs/icon/nxdumptool.jpg">
2020-04-11 06:28:26 +01:00
Nintendo Switch Dump Tool
2023-03-31 12:29:46 +01:00
### Official Discord server: https://discord.gg/SCbbcQx
2023-03-29 22:40:06 +01:00
2023-03-31 12:29:46 +01:00
This branch is used for the development of the ongoing nxdumptool rewrite. Code is highly experimental and lacks a proper UI at this time, but it has been thoroughly tested and should be safe to use. Proof-of-concept (PoC) builds are provided to test different aspects of the codebase.
2023-03-29 22:40:06 +01:00
2023-03-31 12:29:46 +01:00
If a nxdumptool build from the [releases page](https://github.com/DarkMatterCore/nxdumptool/releases) isn't working for whatever you're trying to do (e.g. RomFS dumping), odds are it will work with a PoC build from this particular branch. The [old branch](https://github.com/DarkMatterCore/nxdumptool/tree/main) will not receive any further updates.
A [GitHub workflow](https://github.com/DarkMatterCore/nxdumptool/actions) is used to automatically build each new commit -- feel free to check it out.
2023-03-29 22:40:06 +01:00
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). :white_check_mark:
* USB Mass Storage device support (FAT, NTFS, EXT). :white_check_mark:
* Gamecard header dumps. :white_check_mark:
* Gamecard CardInfo area dumps. :white_check_mark:
* Gamecard InitialData area dumps. :white_check_mark:
* Individual NCA dumps (select and dump a specific NCA from a title). :white_check_mark:
* 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). :white_check_mark:
* System title support (e.g. dump qlaunch, shared fonts and much, much more at runtime). :white_check_mark:
2023-03-31 12:29:46 +01:00
* Better support for NCA BucketTree storages (Indirect, AesCtrEx, Sparse, Compressed), as well as better handling of multi-layered reads in combination with game updates. :white_check_mark:
* Volatile ticket dumping -- temporary tickets that are downloaded and kept in RAM instead of being written to the eMMC. :white_check_mark:
2023-03-29 22:40:06 +01:00
* Better memory handling while dealing with compressed NRO binaries. :white_check_mark:
2023-03-31 12:29:46 +01:00
* Event-driven background threads to manage gamecard insertions/ejections, gamecard application metadata parsing (e.g. the game would be properly identified even if its gamecard has never been used on your console), USB ABI sessions and USB Mass Storage devices. :white_check_mark:
2023-03-29 22:40:06 +01:00
* Improved support for multigame gamecards and titles with more than one Program NCA (e.g. SM3DAS). :white_check_mark:
* Control.nacp patching while dumping NSPs (lets you patch screenshot, video, user account and HDCP restrictions). :white_check_mark:
* Full system update dumps. :x:
* New UI using a [customized borealis fork](https://github.com/DarkMatterCore/borealis/tree/nxdumptool-legacy). :warning:
Legend:
* :white_check_mark: - Implemented
* :warning: - Partially implemented
* :x: - Not implemented