From bb443d2cd809c9785590d2a8086c6d53dd9a0422 Mon Sep 17 00:00:00 2001 From: Kurt Date: Thu, 21 Feb 2019 10:34:59 -0800 Subject: [PATCH] Update README.md Adds brief feature explanation --- README.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f16cd451..f54096bb 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,26 @@ # pkNX -pkNX... for lack of a better name! + +![License](https://img.shields.io/badge/License-GPLv3-blue.svg) + +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 Nintedo 3DS, pkNX provides an editing environment to manipulate game binary assets such as stats, learnsets, trainers, and more! + +## Features +Supports the following games: +* Let's Go, Pikachu! / Let's Go, Eevee! + +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 Framework v4.6](https://www.microsoft.com/en-us/download/details.aspx?id=48137). + +The executable can be built with any compiler that supports C# 7.