Game-Decompilation/perfect_dark
1
0
Fork 0
mirror of https://github.com/n64decomp/perfect_dark.git synced 2024-11-27 08:00:27 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
A decompilation of Perfect Dark. (MIRROR of https://gitlab.com/ryandwyer/perfect-dark)
5,753 Commits 5 Branches 0 Tags 122 MiB
C 91.3%
Python 4.2%
Assembly 3.5%
C++ 0.8%
Makefile 0.2%
8a1dd76fa4
Go to file
Ryan Dwyer 8a1dd76fa4 pal-beta: Get ROM fully matching
2022-03-12 15:47:01 +10:00
docs Replace KB with bytes in Challenge 7 document 2022-01-15 18:54:05 +10:00
include Decompile sndLoadAdpcmBook 2021-11-21 20:12:02 +10:00
ld pal-beta: Get lib segment matching excluding pointers 2022-03-11 14:18:03 +10:00
src pal-beta: Get ROM fully matching 2022-03-12 15:47:01 +10:00
tools pal-beta: Get ROM fully matching 2022-03-12 15:47:01 +10:00
.gitignore Introduce mkrom 2021-10-23 11:27:59 +10:00
.gitmodules Remove support for qemu-irix and require the use of recomp 2022-02-15 23:24:53 +10:00
checksums.jpn-final.md5 Merge lang json files 2022-03-10 23:43:52 +10:00
checksums.ntsc-1.0.md5 Merge lang json files 2022-03-10 23:43:52 +10:00
checksums.ntsc-beta.md5 Merge lang json files 2022-03-10 23:43:52 +10:00
checksums.ntsc-final.md5 Merge lang json files 2022-03-10 23:43:52 +10:00
checksums.pal-beta.md5 Merge lang json files 2022-03-10 23:43:52 +10:00
checksums.pal-final.md5 Merge lang json files 2022-03-10 23:43:52 +10:00
Makefile pal-beta: Get ROM fully matching 2022-03-12 15:47:01 +10:00
README.md Remove support for qemu-irix and require the use of recomp 2022-02-15 23:24:53 +10:00
stagetable.txt Initial commit 2019-09-06 08:09:40 +10:00

README.md

Perfect Dark Decompilation (WIP)

This repository contains a work-in-progress decompilation of Perfect Dark for the Nintendo 64.

Status

See the Perfect Dark Decompilation Status Page.

Installation Requirements

For Arch Linux:

  • Install these packages: binutils fakeroot gcc make python vim
  • Install from AUR: armips mips64-elf-binutils

For Debian and Ubuntu:

  • Install these packages: binutils-mips-linux-gnu build-essential libc6-dev-i386 libcapstone3 libcapstone-dev make
  • Compile and install armips

ROM Versions

Perfect Dark has six known versions:

ROM ID Description MD5 Checksum
ntsc-beta NTSC 6.4 beta aa93f4df16fceada399a749f5ad2f273
ntsc-1.0 NTSC 8.7 final (the initial, buggy release) 7f4171b0c8d17815be37913f535e4e93
ntsc-final NTSC 8.7 final e03b088b6ac9e0080440efed07c1e40f
pal-beta PAL 28.7 beta ad2de210a3455ba5ec541f0c78d91444
pal-final PAL 8.7 final d9b5cd305d228424891ce38e71bc9213
jpn-final JPN 8.9 final 538d2b75945eae069b29c46193e74790

The project uses the $ROMID environment variable to know which version to work with. If not set, it defaults to ntsc-final. You can change it by running something like export ROMID=ntsc-1.0.

Extracting the base ROM

Before you do anything you need an existing ROM to extract assets from.

  1. Save your existing ROM file into the root of the repository with the name pd.ntsc-final.z64. It should not be byteswapped (the first four bytes should be 0x80371240).
  2. Run make extract.

This will extract assets to src/assets. If any asset already exists then it will not be overwritten. This means you can modify assets as desired, and your changes will not be overwritten if you run the extract command again.

The extract command will also create an extracted/ntsc-final directory. This directory contains some compiled code segments from the ROM and is only used for comparison purposes.

Compiling

  • Run git submodule update --init --recursive. You only have to do this once.
  • Run make -j to build the ROM. The ROM will be written to build/ntsc-final/pd.z64.

How do I know the built files are matching?

Run make followed by make test. If make test produces no output then the compiled project is matching.

You can also md5sum your base ROM with the built ROM and check they have the same hash: md5sum pd.ntsc-final.z64 build/ntsc-final/pd.z64.