Rom Patcher JS

A ROM patcher made in Javascript. This is the npm module implementation, for a web version go here.

Highlights

• Supported formats:
  • IPS
  • UPS
  • APS (N64/GBA)
  • BPS
  • RUP
  • PPF
  • Paper Mario Star Rod (.mod)
  • VCDiff (.xdelta, .vcdiff)
• can patch and create patches
• can fix internal headers after patching (Sega Mega Drive/Genesis, Game Boy)
• can remove headers before patching

Install

npm install -g rom-patcher

Usage

Apply a patch to a ROM file

RomPatcher patch "my_rom.bin" "my_patch.ips"

For more options:

RomPatcher patch --help

Options explanation:

• --validate-checksum: should validate checksum
• --add-header: adds a temporary header to the provided ROM for patches that require headered ROMs
• --remove-header: removes ROM header temporarily for patches that require headerless ROMs
• --fix-checksum: fixes any known ROM header checksum if possible
• --output-suffix: add a (patched) suffix to output ROM file name

Create a patch from two ROM files

RomPatcher create "original_rom.bin" "modified_rom.bin"

By default, the patch will be created in IPS format. You can specify your desired format:

RomPatcher create "original_rom.bin" "modified_rom.bin" --format bps 

Allowed values: ips, bps, ppf, ups, aps, rup (default: ips)