Skip to content

README.md

Latest commit

 

History

History
64 lines (51 loc) · 1.97 KB

README.md

File metadata and controls

64 lines (51 loc) · 1.97 KB

rom-decomp-64

A tool to extract assets from Super Mario 64 style ROMs, with a heavy focus on compatibility with romhacks, especially romhacks that are less deterministic like romhacks built with the SM64 decomp project. More recently, it's output is also targetted towards being compatible with sm64coopdx.

Prerequisites

  • Python 3: Main language the program was written in.
  • Bun: JavaScript runtime. Used to run n64js for headless emulation. https://bun.com/get

Installation

  1. Clone the repository with submodules: 
    git clone --recurse-submodules https://github.com/Isaac0-dev/rom-decomp-64.git
  2. Install Python dependencies: 
    pip install -r requirements.txt

Usage

Standard GUI Extraction

Launch the GUI with:

python3 gui_extract.py

CLI Extraction

Extract a single ROM:

python3 extract.py path/to/rom.z64

If no path is provided, defaults to baserom.us.z64 in the current directory.

Batch Extraction (for testing)

Extract all .z64 files in the current directory:

python3 main.py

Output Structure

Extracted assets are organized in out/<rom_filename>/:

  • levels/: Identified level scripts (e.g. bob/, ccm/)
  • misc/: Unidentified or global scripts
  • sound/: Sequences (.m64) and samples
  • textures/: Textures folder
    • segment2/: Textures from segment 2
    • skybox_tiles/: Skybox textures
  • main.lua: sm64coopdx mod script
  • raw.log: Complete extraction log with debug info

Contributors

  • Isaac0-dev
  • Sunk

Credits

  • n64js by hulkholden - ROM emulation for deterministic data tracing
  • djoslin0 - for his research and prototypes on rom2c, a private tool.
  • SM64 Decomp
  • RNC ProPack decompressor - RNC decompression
  • Quad64 - Reference for display list parsing