# Yoshi's Story Decompilation [![Build Status]][actions] ![Code us Progress]

[Build Status]: <https://github.com/decompals/yoshis-story/actions/workflows/ci.yml/badge.svg>
[actions]: <https://github.com/decompals/yoshis-story/actions/workflows/ci.yml>
[Code us Progress]: https://img.shields.io/endpoint?label=Code%20us&url=https%3A%2F%2Fprogress.deco.mp%2Fdata%2Fyoshisstory%2Fus%2Fcode%2F%3Fmode%3Dshield%26measure%3Dall

This is a WIP decomp of Yoshi's Story (US).

## Setup

### Linux

#### 1. Install build dependencies

The build process has the following package requirements:

* make
* git
* build-essential
* binutils-mips-linux-gnu
* python3
* pip3

Under Debian / Ubuntu (which we recommend using), you can install them with the following commands:

```bash
sudo apt update
sudo apt install make git build-essential binutils-mips-linux-gnu python3 python3-pip python3-venv
```

#### 2. Install python dependencies

The build process has a few python packages required that are located in `requirements.txt`.

To install them simply run in a terminal:

```bash
make venv
```

#### 3. Prepare a base ROM

Copy your ROM to inside `baseroms/` in the version folder corresponding to your ROM's version, and rename the file of the baserom to `baserom.z64`. ex: `baseroms/us/baserom.z64`

#### 4. Make and Build the ROM

To start the extraction/build process, run the following command:

```bash
make setup
make extract
make
```