flips.rs

Rust bindings to Flips, the Floating IPS patcher.

🗺️ Overview

Flips is a popular patcher for the IPS, BPS and UPS formats, typically used to patch ROMs of video game cartridges. It is known to create the smallest BPS and IPS files among all widely used patchers. This library provides a safe API to create and apply patches to arbitrary sources.

| Format | Apply | Create | Metadata | Study | | ------ | ----- | ------ | -------- | ----- | | UPS | ✔️ | | | | | IPS | ✔️ | ✔️ | | ✔️ | | BPS | ✔️ | ✔️ | ✔️ | |

🔌 Usage

Load a ROM and a patch from two files, apply the patch to the ROM, and then write it back to a file:

```rust extern crate flips;

// get the input ROM and patch let patch = std::fs::read("FELonelyMirrorv3_3.ups").unwrap(); let rom = std::fs::read("Fire Emblem 8.rom").unwrap();

// apply the patch and write the output let output = flips::UpsPatch::new(patch).apply(rom) .expect("could not apply patch"); std::fs::write("FE_LonelyMirror.rom", output).unwrap(); ```

Check the online documentation for more examples about how to use this library.

📝 Features

The following features are all enabled by default, but can be disabled and cherry-picked using the default-features = false option in the Cargo.toml manifest of your project:

• std: compile against the Rust standard library, adding proper integration with std::error::Error and Vec<u8>. Disable to compile in no_std mode.

📋 Changelog

This project adheres to Semantic Versioning and provides a changelog in the Keep a Changelog format.

📜 License

This library is provided under the GNU General Public License v3.0, since Flips itself is GPLv3 software.