Code Monkey home page Code Monkey logo

pyromhackit's Introduction

Python ROM Hacking Toolkit (pyromhackit)

This is a little Python utility providing my tools for doing ROM hacks, primarily geared towards script replacement. This is still largely a work in progress.

Build Status Code Health Coverage Status

Install

TODO

Dependencies

  • Python 3

Install the dependencies like so:

$ pip install -r requirements.txt

Usage

reader.py provides a kind of pipeline interface for processing a ROM. More information to come...

$ ./reader.py -h
usage: reader.py [-h]
                 [--transliteration TRANSLITERATION [TRANSLITERATION ...]]
                 [--width WIDTH] [--outfile OUTFILE]
                 infile {bin,hex}
                 [{odd,hex,text,map,replace,pack,join,table,label} [{odd,hex,text,map,replace,pack,join,table,label} ...]]

Read a ROM and process it.

positional arguments:
  infile                Path to the file to be read.
  {bin,hex}             Encoding of the read file.
  {odd,hex,text,map,replace,pack,join,table,label}
                        Apply processing rules to the out-encoded stream.

optional arguments:
  -h, --help            show this help message and exit
  --transliteration TRANSLITERATION [TRANSLITERATION ...], -t TRANSLITERATION [TRANSLITERATION ...]
                        YAML file mapping a set of symbols to another set of
                        symbols.
  --width WIDTH, -w WIDTH
                        Number of columns in the output.
  --outfile OUTFILE, -o OUTFILE
                        Output to file instead of to console.

Examples

$ ./reader.py majin-tensei-ii/mt2.sfc bin map text -t majin-tensei-ii/hexmap.yaml -o out.txt

Testing

$ pytest pyromhackit

Features

Functional requirements:

  • Palette formatter
  • ROM file reader module providing a pipeline interface to the ROM file.

Quality requirements:

  • Platform independence
  • Free software license

Status

Romhacks I am considering or lightly working on at the moment:

  • Majin Tensei II translation. Aeon Genesis has called dibs on this one, but progress on the prequel has been stuck at 40 % since forever.
  • Actraiser 2 retranslation/decensoring. Decent warmup project.
  • Devil Summoner translation. A script exists but development with hacking the ISO appears to be stuck in limbo.
  • Persona (PSP) soundtrack patch. There exists one, but it is far from perfect.

License

The software is licensed under GPLv3. See LICENSE.md for details.

pyromhackit's People

Contributors

sebelino avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.