snespatcher/README.md

# SNES Patcher
Create patched copies of Super Nintendo ROMs with IPS or BPS patches.

## Features
- Native GTK 4 interface designed for GNOME
- Safe workflow that preserves the original ROM
- IPS records, RLE records, and optional truncation support
- BPS actions, metadata, and checksum validation

## What is this?
SNES Patcher is a small GTK 4 application for applying IPS and BPS patches to SNES ROMs. Choose a patch format, select a ROM and patch, then choose where to save the result. The original ROM remains untouched.

## Why?
The idea to build this application came from the [Super Mario World widescreen patch](https://github.com/VitorVilela7/wide-snes) built by [Victor Vilela](https://github.com/VitorVilela7/). Being a big fan of Super Mario World, I was eager to try it out. I happened to find FLIPS, another IPS/BPS patching utility. Functionally, FLIPS worked but aesthetically, FLIPS looked horrible. I decided to scratch my own itch and built the same utility, but from scratch. Thus, SNES Patcher was born.

## Where can I download it?
Currently, you can build from source by downloading `rustup`, thusly downloading `rustc` and `cargo`. Packages coming soon!

## Building
Install the GTK 4 development files and GLib resource compiler, then run:

```sh
cargo run
```