TimoVesalainen / Nintenlord-UPS-patcher

UPS patcher creator and applier.
9 stars 1 forks source link

CLI (Command Line Interface) #2

Open Europia79 opened 1 year ago

Europia79 commented 1 year ago

Currently, NUPS only has a GUI, so we're forced to create & apply patches one at a time.

Hopefully, you can add a CLI for NUPS, since some of the other patching programs provide this: It's a nice convenience for being able to create & apply thousands of patches at once (via script).

Here's an example --help section:

NUPS: A fast & efficient UPS patching implementation by Nintenlord.
      UPS is a direct replacement for IPS that offers (1) much greater file sizes, 
      (2) automatic error detection, & (3) bi-directional patching.

Usage:
  ./NUPS.exe [options] [--] <parameters>

Options:
  -c, --create            create patch
  -a, --apply             apply patch
  -b, --get-base-crc32    print crc32 checksum for Baserom
  -k, --get-hack-crc32    print crc32 checksum for Hack/Translation
  -p, --get-patch-crc32   print crc32 checksum for Patch file
  -z, --get-crc32         calculate crc32 checksum for given <File>
  -h, --help              display help
  -v, --version           display version

Example: Create Patch:
  ./NUPS.exe -c Baserom.nes Hack.nes Patch.bps

Example: Apply Patch:
  ./NUPS.exe -a Patch.bps Baserom.nes Hack.nes

It's just a (1) basic Description with (2) general Usage, (3) command line Options, and (4) a couple Examples.

This one here is similar to the CLI for Floating IPS (flips): However, they can vary.

For example, this is the CLI for beat by byuu:

beat v01
author: byuu
license: GPLv3

usage 1: beat -apply -p patch -o output input
usage 2: beat -create [-delta] [-m manifest] -p patch -o output input

It has a completely different usage, but the main philosophy here is that it's easier to archive & preserve thousands upon thousands of romhacks & translations if there's a command line interface to help automate the process.

Thanks !!!