mirror of https://github.com/sonicdcer/sf64.git synced 2024-11-30 08:21:02 +00:00

Decompilation of Starfox 64

Go to file

Alejandro Asenjo Nitti 755097a5a5 Update ci.yaml		2023-10-16 15:52:35 -03:00
.github/workflows	Update ci.yaml	2023-10-16 15:52:35 -03:00
.vscode	remove	2023-10-16 10:55:53 -03:00
include	stdlib.h	2023-10-16 13:58:53 -03:00
linker_scripts/us	separate libultra symbol addresses	2023-10-14 04:49:48 -03:00
src	format	2023-10-16 14:56:11 -03:00
tools	check_format.sh	2023-10-16 14:57:33 -03:00
yamls	cleanup	2023-10-16 07:44:18 -05:00
.clang-format	Add formatter	2023-10-07 04:38:28 -03:00
.clang-tidy	Add formatter	2023-10-07 04:38:28 -03:00
.gitignore	starfox64.uncompressed.ld	2023-10-15 11:41:48 -03:00
.gitmodules	add asm-differ submodule	2023-10-14 05:10:23 -03:00
diff_settings.py	diff settings	2023-10-06 09:38:01 -03:00
Makefile	echo	2023-10-16 14:55:18 -03:00
README.md	fix	2023-10-15 19:19:33 -03:00
starfox64.us.md5	md5 for compressed rom	2023-10-15 18:00:11 -03:00
starfox64.us.uncompressed.md5	md5 for uncompressed rom	2023-10-15 18:00:16 -03:00

README.md

Starfox 64 (US) REV 1.1

This is a WIP decompilation of Starfox 64. The purpose of the project is to recreate a source code base for the game from scratch, using information found inside the game along with static and/or dynamic analysis.

It currently builds the following ROM:

starfox64.us.z64 md5: 741a94eee093c4c8684e66b89f8685e8

This repo does not include any assets or assembly code necessary for compiling the ROM. A prior copy of the game is required to extract the required assets.

Installation

Windows

For Windows 10, install WSL and a distribution by following this Windows Subsystem for Linux Installation Guide. We recommend using Debian or Ubuntu 22.04 Linux distributions.

Linux (Native or under WSL / VM)

1. Install build dependencies

The build process has the following package requirements:

make
git
build-essential
binutils-mips-linux-gnu
python3
pip3
libpng-dev

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

sudo apt update
sudo apt install make git build-essential binutils-mips-linux-gnu python3 python3-pip libpng-dev

2. Clone the repository

Create your own fork of the repository at https://github.com/sonicdcer/sf64. Then clone your fork where you wish to have the project, with the command:

git clone https://github.com/<YOUR_USERNAME>/sf64.git

This will copy the GitHub repository contents into a new folder in the current directory called sf64. Change into this directory before doing anything else:

cd sf64

3. Install python dependencies

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

To install them simply run in a terminal:

python3 -m pip install -r ./tools/requirements-python.txt

4. Update submodules

git submodule update --init --recursive

5. Prepare a base ROM

Copy your ROM to inside the root of this new project directory, and rename the file of the baserom to reflect the version of ROM you are using. ex: baserom.us.z64

6. Make and Build the ROM

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

make init

This will create the build folders as well as a new folder with the assembly as well as containing the disassemblies of nearly all the files containing code.

this make target will also build the ROM. If all goes well, a new ROM called "starfox64.us.z64" should be built and the following text should be printed:

741a94eee093c4c8684e66b89f8685e8  build/starfox64.us.z64
./build/starfox64.us.z64: OK

If you instead see the following:

./build/starfox64.us.z64: FAILED
md5sum: WARNING: 1 computed checksum did NOT match

This means that something is wrong with the ROM's contents. Either the base files are incorrect due to a bad ROM, or some of the code is not matching.

From now on you should be able to build the rom by running make.