diff --git a/README.md b/README.md index 373641d..d17b560 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,13 @@ Nintendo Switch Dump Tool -Temporary branch used for the development of the nxdumptool rewrite. Highly experimental, use at your own risk. +### Official Discord server: https://discord.gg/SCbbcQx -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 experimental proof-of-concept build from this particular branch. The old branch will not receive any further updates. +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. -A [GitHub workflow](https://github.com/DarkMatterCore/nxdumptool/actions) is used to automatically build each new commit -- feel free to check it out. For additional information, please reach us at our [Discord server](https://discord.gg/SCbbcQx). +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. This readme will be updated whenever the rewrite branch is ready for a proper release. @@ -20,9 +22,10 @@ Currently planned changes for this branch include: * 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: -* Volatile ticket dumping. :white_check_mark: +* 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: * Better memory handling while dealing with compressed NRO binaries. :white_check_mark: -* 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. :white_check_mark: +* 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: * 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: