README.md

Rom Patcher JS

A ROM patcher made in Javascript.

Features:

• Supported formats:
  • IPS
  • UPS
  • APS (N64/GBA)
  • BPS
  • RUP
  • PPF
  • Paper Mario Star Rod (.mod)
  • VCDiff (.xdelta, .vcdiff)
• can patch and create patches
• shows ROM CRC32, MD5 and SHA-1 before patching
• can remove headers before patching
• unzips files automatically
• made in Vanilla JS
• can be run in any modern web browser (including mobile) and Node.js
• can be customized and embeded into your website for a custom patcher

 

Embedding Rom Patcher JS in your site

Modders and hackers can embed Rom Patcher JS in their websites to provide an online ROM patcher for their patches, allowing users to patch ROMs without downloading any files.

• File index_template.html includes a simple working example
• Read the wiki for more detailed instructions

 

Using Rom Patcher JS in Node CLI

Install dependencies:

npm install

Patch a ROM:

node index.js patch "my_rom.bin" "my_patch.ips"

Create an IPS patch:

node index.js create "original_rom.bin" modified_rom.bin"

Show all options:

node index.js patch --help
node index.js create --help

 

Known sites that use Rom Patcher JS

• Romhacking.net
• Smash Remix
• Radical Red
• Rocket Edition
• SnapCameraPreservation
• Pokemon Clover
• ZeldaHacking Wiki for The Legend of Zelda: Oracle of Ages and Seasons
• Pokemon Elite Redux

 

Resources used

• zip.js by Gildas Lormeau
• Octicons by GitHub Inc.