Leahnaya/pkNX
1
0
Fork 0
mirror of https://github.com/kwsch/pkNX.git synced 2026-04-24 06:46:48 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity
Pokémon (Nintendo Switch) ROM Editor & Randomizer
577 Commits 5 Branches 0 Tags 26 MiB
C# 100%
38b784e19b
Go to file
Kurt 38b784e19b Add handling for S/V load and data ripping 
Co-Authored-By: SciresM <8676005+SciresM@users.noreply.github.com>
Co-Authored-By: Matt <17801814+sora10pls@users.noreply.github.com>
Co-Authored-By: Lusamine <30205550+Lusamine@users.noreply.github.com>
2022-11-24 15:30:03 -08:00
pkNX.Containers Add handling for S/V load and data ripping 2022-11-24 15:30:03 -08:00
pkNX.Game Add handling for S/V load and data ripping 2022-11-24 15:30:03 -08:00
pkNX.Randomization Add handling for S/V load and data ripping 2022-11-24 15:30:03 -08:00
pkNX.Structures Add handling for S/V load and data ripping 2022-11-24 15:30:03 -08:00
pkNX.Structures.FlatBuffers Add handling for S/V load and data ripping 2022-11-24 15:30:03 -08:00
pkNX.Tests Add handling for S/V load and data ripping 2022-11-24 15:30:03 -08:00
pkNX.WinForms Add handling for S/V load and data ripping 2022-11-24 15:30:03 -08:00
.editorconfig Refactoring 2022-10-01 12:44:47 -07:00
.gitattributes 💥🐫 Added .gitattributes & .gitignore files 2018-11-13 19:41:53 -08:00
.gitignore 💥🐫 Added .gitattributes & .gitignore files 2018-11-13 19:41:53 -08:00
azure-pipelines.yml Update azure-pipelines.yml (#181), fixes automatic build 2022-02-04 21:07:04 -08:00
Directory.Build.props Update dependencies, nullable all csproj 2022-10-25 17:05:12 -07:00
LICENSE Initial Commit 2018-11-13 19:44:43 -08:00
pkNX.sln Handle FlatBuffers in-process with FlatSharp, and add more flatbuffer editors. (#166) 2021-09-02 19:47:41 -07:00
README.md Update README.md 2022-10-22 15:51:18 +02:00

README.md

pkNX

License

pkNX: A package of Pokémon (Nintendo Switch) ROM Editing Tools, programmed in C#.

Similar to pk3DS for the Nintendo 3DS, pkNX provides an editing environment to manipulate game binary assets such as stats, learnsets, trainers, and more!

Main Window

Download

Download the latest version here.

(click on latest run at the top, then click Artifacts - published, and download the folder)

Note: To run the app it is required to have the .NET Desktop Runtime installed

Features

Supports the following games:

  • Let's Go, Pikachu! / Let's Go, Eevee!
  • Sword / Shield
  • Legends Arceus

For Sword and Shield, pkNX operates under the assumption that your dumped ROM includes the Ver. 1.3.0 patch.

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.
  • 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.

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 for Windows.

The executable can be built with any compiler that supports C# 10.

Dependencies

pkNX's shiny sprite collection is taken from pokesprite, which is licensed under the MIT license.