mirrors/nxdumptool
1
0
Fork 0
mirror of https://github.com/DarkMatterCore/nxdumptool.git synced 2024-12-23 00:52:10 +00:00
Code Issues Releases Activity
Generates XCI/NSP/HFS0/ExeFS/RomFS/Certificate/Ticket dumps from Nintendo Switch gamecards and installed SD/eMMC titles.
597 commits 3 branches 26 tags 4.3 MiB
C 92.9%
C++ 5.2%
Python 1.6%
Makefile 0.2%
Find a file
Pablo Curiel 5cc387c9b6 title: migrate application metadata filtering logic to background thread 
titleGetApplicationMetadataEntries() and titleGetGameCardApplicationMetadataEntries() will now return dynamically allocated copies of internal pre-filtered / pre-processed arrays, which are generated using the background gamecard thread. This results in less overhead for any potential calls to these functions.

Other changes include:

* title: rename TitleGameCardApplicationMetadataEntry -> TitleGameCardApplicationMetadata.
* title: add `has_patch` field to TitleGameCardApplicationMetadata struct.
* title: declare internal TitleApplicationMetadata arrays to hold pre-filtered application metadata.
* title: declare internal TitleGameCardApplicationMetadata array to hold pre-processed gamecard application metadata.
* title: move filtering logic from titleGetApplicationMetadataEntries() to a new function: titleGenerateFilteredApplicationMetadataPointerArray().
* title: move processing logic from titleGetGameCardApplicationMetadataEntries() to a new function: titleGenerateGameCardApplicationMetadataArray().
* title: rename titleGetPatchVersionString() -> titleGetDisplayVersionString().
* title: add extra debug log messages to some functions.
* title: update titleFreeApplicationMetadata() to also free the new internal metadata arrays.
* title: update background thread logic in titleGameCardInfoThreadFunc() to also regenerate the pre-filtered application metadata and gamecard application metadata arrays right after a successful call to titleRefreshGameCardTitleInfo().
* title: update titleGetDisplayVersionString() to also support base application titles.
* title: simplify string generation logic in titleGenerateGameCardFileName() by using the cached gamecard application metadata array.

* GameCardStatusTask: add GetGameCardStatus() method.

* GameCardTab: fix callback argument type in class constructor.
* GameCardTab: update ProcessGameCardStatus() to block user inputs while processing the new gamecard status.

* RootView: add GetGameCardStatus() method.

* StatusInfoTask: turn IsInternetConnectionAvailable() into an inline method.

* TitleMetadataTask: turn GetApplicationMetadata() into an inline method.
* TitleMetadataTask: move debug log messages around.

* TitlesTab: update PopulateList() to block user inputs while updating the titles list.

* UmsTask: turn GetUmsDevices() into an inline method.

* UsbHostTask: turn GetUsbHostSpeed() into an inline method.
2024-05-05 21:42:32 +02:00
.github Remove all references to NSWDB. 2024-05-02 15:38:39 +02:00
code_templates Improve directory layout while we still can. 2024-04-30 23:01:42 +02:00
host [skip ci] Update copyright year. 2024-04-12 11:49:03 +02:00
include title: migrate application metadata filtering logic to background thread 2024-05-05 21:42:32 +02:00
libs title: migrate application metadata filtering logic to background thread 2024-05-05 21:42:32 +02:00
romfs Remove all references to NSWDB. 2024-05-02 15:38:39 +02:00
source title: migrate application metadata filtering logic to background thread 2024-05-05 21:42:32 +02:00
.gitignore host: drop Nuitka's "--onefile" arg 2024-01-20 23:11:21 +01:00
.gitmodules libs: update libusbhsfs. 2022-03-04 13:24:28 +01:00
build.sh workflow: fix issues + remove ccache support 2024-05-02 14:27:32 +02:00
LICENSE.md Change project layout + upgrade license to GPLv3. 2021-03-25 15:26:58 -04:00
Makefile [ci skip] Update Makefile 2024-05-01 21:18:05 +02:00
README.md Update README.md 2023-12-31 18:33:49 +01:00
todo.txt Remove all references to NSWDB. 2024-05-02 15:38:39 +02:00

README.md

nxdumptool

Nintendo Switch Dump Tool

Official Discord server: https://discord.gg/SCbbcQx

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.

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 PoC 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. Furthermore, the assets from the rewrite-prerelease tag are automatically updated by this workflow, so you can always find the latest NRO binary there.

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) via libusbhsfs. ✅
  • NX Card Image (XCI) gamecard dumps, with optional KeyArea prepending and certificate removal. ✅
  • Gamecard header dumps. ✅
  • Gamecard certificate dumps. ✅
  • Plaintext gamecard CardInfo area dumps. ✅
  • Gamecard InitialData area dumps. ✅
  • Gamecard CardIdSet dumps. ✅
  • Gamecard Hash FS partition dumps (in both extracted and raw inage forms). ✅
  • Lotus ASIC firmware (LAFW) blob dumping from RAM. ✅
  • Properly detect if an inserted gamecard requires a LAFW update. ✅
  • Nintendo Submission Package (NSP) dumps for both digital and gamecard-based titles.
  • Individual Ticket dumps from digital titles, with support for temporary/volatile tickets with AES-128-CTR crypto data kept in RAM.
  • Individual Nintendo Content Archive (NCA) dumps from a specific title. ✅
  • Individual NCA filesystem section (Partition FS / ExeFS, RomFS, Patch RomFS) dumps from a specific NCA belonging to a specific title, in both extracted and raw image forms. ✅
  • Better support for NCA BucketTree storages (Indirect, AesCtrEx, Sparse, Compressed), as well as better handling of multi-layered reads in combination with game updates. ✅
  • System title support (e.g. dump qlaunch, shared fonts and much, much more at runtime). ✅
  • 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 its 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). ✅
  • Partition FS / Hash FS / RomFS browser using custom devoptab wrappers. ✅
  • Full system update dumps. ❌
  • Batch NSP dumps. ❌
  • FsFileSystem + FatFs based eMMC browser using a custom devoptab wrapper (allows copying files protected by the FS sysmodule at runtime). ❌
  • New UI using a customized borealis fork. ⚠️

Legend:

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