Giter VIP home page Giter VIP logo

picori's Introduction

Picori

crates.io docs.rs build coverage license

Picori (ピッコル) is a library for decompilation, modding, and rom-hacking with focus on GameCube and Wii games. It support parsing and building common file formats, e.g., Dolphin executables (DOLs).

FeaturesUsageExamplesInstallation

!!! The project is currently very early stages of development. !!!
!!! All features are not implemented and backwards compatibility is not guaranteed. !!!

Features

  • DOL (Dolphin executable)
  • REL (Relocatable module)
  • GCM (GameCube master disc)
  • CISO (Compact ISO)
  • Yaz0 compression
  • JIS X 0201 encoding
  • Shift JIS encoding

Usage

Here is a simple example of how to use Picori to parse a DOL file and print the entry point.

use std::fs::File;
use picori::Result;
fn main() -> Result<()> {
    let mut file = File::open("main.dol")?;
    let dol = picori::Dol::from_binary(&mut file)?;
    println!("entry point: {:#08x}", dol.entry_point());
    Ok(())
}

Examples

The examples directory contains a few examples of how to use Picori.

  • dol_dump - Dump information about a .dol file.
  • rel_dump - Dump information about a .rel file.
  • gcm_dump - Dump information about a .gcm/.iso file.

Installation

Picori is available on crates.io. Add the following to your Cargo.toml:

[dependencies]
picori = "0.1.0"

Contributing

Contributions are welcome! If you would like to contribute, please open a pull request on GitHub. Please make sure that your code is formatted with rustfmt, and that it compiles without warnings or errors.

License

Picori is licensed under an MIT license. See LICENSE for more information.

picori's People

Contributors

julgodis avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 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.