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)
4,202 Commits 5 Branches 0 Tags 122 MiB
C 91.3%
Python 4.2%
Assembly 3.5%
C++ 0.8%
Makefile 0.2%
8621b33428
Go to file
Ryan Dwyer 8621b33428 Decompile n_alEnvmixerParam
2021-03-29 08:41:26 +10:00
docs Rename entry.c to boot.c, controller.c to joy.c, core.c to lv.c, texture.c to texdecompress.c, room.c to bg.c, lib_0e9d0.c to snd.c and associated functions 2021-03-24 20:03:37 +10:00
ld Decompile n_alSynDelete 2021-03-28 23:47:08 +10:00
src Decompile n_alEnvmixerParam 2021-03-29 08:41:26 +10:00
tools Restructure assets directory to group all assets by ROM ID 2021-03-26 17:46:16 +10:00
.gitignore Restructure assets directory to group all assets by ROM ID 2021-03-26 17:46:16 +10:00
checksums.jpn-final.md5 Merge boot segment into lib 2021-03-08 12:18:53 +10:00
checksums.ntsc-1.0.md5 Merge boot segment into lib 2021-03-08 12:18:53 +10:00
checksums.ntsc-beta.md5 ntsc-beta: Get lib .text segment matching excluding pointers 2021-03-19 22:15:48 +10:00
checksums.ntsc-final.md5 Merge boot segment into lib 2021-03-08 12:18:53 +10:00
checksums.pal-beta.md5 Merge boot segment into lib 2021-03-08 12:18:53 +10:00
checksums.pal-final.md5 Merge boot segment into lib 2021-03-08 12:18:53 +10:00
macros.inc Start decompiling rarezip binary 2019-09-18 22:27:03 +10:00
Makefile Decompile n_alEnvmixerParam 2021-03-29 08:41:26 +10:00
README.md ntsc-beta: Get game functions in their correct places 2021-03-23 17:15:05 +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: mips64-elf-binutils

For Debian and Ubuntu:

  • Install these packages: binutils-mips-linux-gnu make

ROM Versions

Perfect Dark has six known versions:

ROM ID Description
ntsc-beta NTSC 6.4 beta - supported but mismatching
ntsc-1.0 NTSC 8.7 final (the initial, buggy release) - fully supported
ntsc-final NTSC 8.7 final - fully supported
pal-beta PAL 28.7 beta - can extract assets only
pal-final PAL 8.7 final - supported but mismatching
jpn-final Japanese 8.7 final - can extract assets only

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 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.