rom-tools

README

rom-tools

A suite of utilities for working with video game ROMs for classic platforms.

The project is a work in progress and portions are AI-generated. See the maturity legend to understand the quality of the components listed in this README:

• 🔴 Vibe coded AI slop with little or no human review; very rough
• 🟡 Reviewed or written by a human; experimental but usable
• 🟢 Tested on my real game library; no longer slop

CLI

Install the CLI:

go install github.com/sargunv/rom-tools/cmd/rom-tools

• 🔴 rom-tools screenscraper: CLI client for the ScreenScraper API.
• 🔴 rom-tools identify: Hash roms and parse their metadata.
• 🔴 rom-tools scrape: Scrape metadata for frontends from a list of roms.

See the CLI documentation for complete usage information.

Packages

Metadata sources

• 🟡 ./lib/screenscraper: OpenAPI spec and generated client for the ScreenScraper API.
• Hasheous: TODO
• Launchbox: TODO

Metadata destinations

• 🟡 ./lib/esde: Implementation of the ES-DE gamelist.xml format.
• MuOS: TODO
• MinUI/NextUI: TODO

General utilities

• 🟡 ./lib/identify: Utility to identify the title, serial, and other info of a ROM.
• 🟢 ./lib/datfile: Implementation of the Logiqx DAT XML format with No-Intro extensions.
• 🟡 ./lib/chd: Implementation of the CHD (Compressed Hunks of Data) disc image format.
• 🟡 ./lib/iso9660: ISO 9660 filesystem image parsing for optical disk platforms.

Nintendo formats

• 🟢 ./lib/roms/nintendo/nes: NES ROM parsing for iNES and NES 2.0 formats.
• 🟢 ./lib/roms/nintendo/sfc: Super Nintendo ROM header parsing with LoROM/HiROM detection.
• 🟢 ./lib/roms/nintendo/n64: Nintendo 64 ROM parsing with support for Z64, V64, and N64 byte orders.
• 🟢 ./lib/roms/nintendo/gcm: GameCube and Wii disc header parsing.
• 🟢 ./lib/roms/nintendo/rvz: RVZ/WIA compressed disc image parsing.
• 🟢 ./lib/roms/nintendo/gb: Game Boy and Game Boy Color ROM header parsing.
• 🟢 ./lib/roms/nintendo/gba: Game Boy Advance ROM header parsing.
• 🟢 ./lib/roms/nintendo/nds: Nintendo DS ROM header parsing.
• 🟢 ./lib/roms/nintendo/n3ds: Nintendo 3DS CCI/NCSD ROM parsing with New 3DS detection.
• Wii U: TODO

Sega formats

• 🟢 ./lib/roms/sega/sms: Sega Master System and Game Gear ROM header parsing.
• 🟢 ./lib/roms/sega/md: Sega Mega Drive (Genesis), 32X, and Sega CD ROM header parsing, including SMD deinterleaving.
• 🟢 ./lib/roms/sega/saturn: Sega Saturn disc identification from system area headers.
• 🟢 ./lib/roms/sega/dreamcast: Sega Dreamcast disc identification from IP.BIN headers.

Sony formats

• 🟢 ./lib/roms/playstation/cnf: SYSTEM.CNF parsing for PlayStation 1/2 discs.
• 🟢 ./lib/roms/playstation/sfo: PARAM.SFO parsing for PSP, PS3, and PS Vita content.
• 🟢 ./lib/roms/playstation/pkg: PKG header parsing for PSP, PS3, and PS Vita content.

Xbox formats

• 🟢 ./lib/roms/xbox/xbe: Original Xbox XBE executable parsing.
• 🟢 ./lib/roms/xbox/xiso: Original Xbox XISO disc image parsing.
• Xbox 360: TODO

Other formats

• Neo Geo: TODO
• Atari 7800: TODO
• Atari Lynx: TODO
• Wonderswan and Color: TODO

Test Data

ROM files in **/testdata/ are sourced from:

• XboxDev/cromwell (LGPL-2.1)
• Zophar's Domain PD ROMs (public domain)

These files are used as sample data for automated tests.