Feature request: better readme.

[svnv-svsv-jm]

There are no usage instructions in the README.md. I think is a bad choice. People coming here should find the usage instructions in the same place :)

For example:

I'd like to use this tool to dump SV, but how?

[kwsch]

The readme already says:

Editors can be launched from the program's main window after opening a dumped & unpacked ROM.

The program requires you to dump your copy of the game and unpack the filesystem; this is a common step for editing/viewing content for all Nintendo Switch games. The vagueness of "bring your own files" is because the steps/tooling to do so is unrelated to the repo, and we don't want to suggest specific ways in the event those tools/methodologies change.

[svnv-svsv-jm]

Hello, thanks for replying.

I get it, but (maybe wrongly) I was told that this tool can also be used to dump a copy of SV. If this is the case, then why can't I find instructions to do so anywhere? Or is this information wrong?

Thanks for your time!

[kwsch]

Once you've ripped the xci/nca from the console/cart, you can use tools like hactool/nxdumptool to unpack into romfs/exefs files.

https://github.com/DarkMatterCore/nxdumptool https://github.com/SciresM/hactool https://github.com/Atmosphere-NX/hac2l

There should be guides on the internet.

pkNX "dumps" by further processing the game files into something human readable/reusable. The initial setup can be done by other tools, so it's less things for pkNX to maintain/update if it only needs to handle the unpacked romfs. I don't want to have to maintain guides when other tools update 🥲

[svnv-svsv-jm]

Yes, I totally understand it.

Last thing, then: you say

pkNX "dumps" by further processing the game files into something human readable/reusable

But where/how? Perhaps this is what I've heard around, but never seen a doc for this. I used pkNX mostly to edit PLA.

[kwsch]

Every game has a Master Dump button which brings up a secondary window to export specific dumps relevant to datamining the game.