diff --git a/README.md b/README.md index 94ca97fd..45e3b712 100644 --- a/README.md +++ b/README.md @@ -4,43 +4,46 @@ pkNX: A package of Pokémon (Nintendo Switch) ROM Editing Tools, programmed in [C#](https://en.wikipedia.org/wiki/C_Sharp_%28programming_language%29). -Similar to [pk3DS](https://github.com/kwsch/pk3ds) for the Nintendo 3DS, pkNX provides an editing environment to manipulate game binary assets such as stats, learnsets, trainers, and more! +Similar to [pk3DS](https://github.com/kwsch/pk3DS) for Nintendo 3DS, pkNX provides an editing environment to manipulate game binary assets such as stats, learnsets, trainers, and more! -![Main Window](https://i.imgur.com/lSYWN4m.png) +![Main Window](https://i.imgur.com/7WiBJpn.png) ## Download + Download the latest version [here](https://dev.azure.com/project-pokemon/pkNX/_build?view=runs). -(click on latest run at the top, then click Artifacts - published, and download the folder) - - +Click on the latest run at the top, then click `# published` under `Related`, then click `Download artifacts` using the button on the right. + + -_Note: To run the app it is required to have the [.NET Desktop Runtime](https://dotnet.microsoft.com/en-us/download/dotnet/6.0) installed_ - +## Supported Games -## Features -Supports the following games: +The following games are supported: * Let's Go, Pikachu! / Let's Go, Eevee! * Sword / Shield * Legends: Arceus -* Scarlet / Violet **(Currently only for dumping information, not to edit files!)** +* Scarlet / Violet **(Only for dumping data, not to edit files!)** -**For Sword, Shield, Scarlet, and Violet, pkNX operates under the assumption that your dumped ROM includes the latest available update data.** +pkNX operates under the assumption that your dumped ROM includes the latest available update data for the following games: +* Sword / Shield (Ver. 1.3.2) +* Scarlet / Violet (Ver. 3.0.1) + +## Features Editors can be launched from the program's main window after opening a dumped & unpacked ROM. * To lessen read/write lag, data is only saved when the user cleanly quits the program. -* Edited files do not overwrite the original dumped file; instead, they are redirected to a "patch folder" for easy use with layeredFS. +* Edited files do not overwrite the original dumped file; instead, they are redirected to a "patch folder" for easy use with LayeredFS. * When the program requests to read a set of files, it will first check to see if an edited version exists, and if not, falls back to the original dump file. -With custom firmware, layeredFS functionality will selectively redirect file loading to files that are present in the patch folder, removing the need to rebuild a custom ROM. +With Custom Firmware, LayeredFS functionality will selectively redirect file loading to files that are present in the patch folder, removing the need to rebuild a custom ROM. pkNX also provides some utility to extract from supported container types, e.g. `gfpak`. Simply drag & drop a container (or many) into the main window, and pkNX will unpack all files to a new folder. ## Building -pkNX is a Windows Forms application which requires [.NET 6](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) for Windows. +pkNX is a Windows Forms application which requires [.NET 9.0](https://dotnet.microsoft.com/download/dotnet/9.0). -The executable can be built with any compiler that supports C# 12. +The executable can be built with any compiler that supports C# 13. ## Dependencies