dinosaur-planet/README.md

32 lines
1.2 KiB
Markdown
Raw Normal View History

2021-02-22 18:35:38 +00:00
# Dinosaur Planet
2021-02-28 00:05:03 +00:00
A WIP decompilation of Dinosaur Planet for the Nintendo 64, as released by Forest of Illusion on Feb. 20, 2021.
2021-02-22 18:35:38 +00:00
2021-02-24 05:26:23 +00:00
<b>Note</b>: To use this repository, you must already have a ROM for the game.
2021-02-22 18:35:38 +00:00
2021-02-28 00:05:03 +00:00
```diff
- WARNING! -
The ROM this repository builds while it has a matching checksum cannot be 'shifted' due
to hardcoded pointers which have yet to be dumped. Thus this repository is currently
in an early research/development phase and cannot currently be used traditionally as a
source code base for general changes. It also cannot be run in an emulator or on console
due to the dongleCheck copy protection code.
```
2021-02-24 05:22:56 +00:00
# OS:
2021-02-24 05:26:23 +00:00
Linux (Debian / Ubuntu)</br>
2021-02-24 05:22:56 +00:00
Windows 10 (WSL)
# Prerequisites:
2021-02-24 05:26:23 +00:00
`sudo apt install -y build-essential git binutils-mips-linux-gnu python3`</br>
2021-02-22 18:35:38 +00:00
`pip3 install -r requirements.txt`
# To use
2021-02-28 00:05:03 +00:00
1. Place the unmodified, uncracked Dinosaur Planet ROM into the root of the repository as `baserom.z64`.
2021-02-24 05:26:23 +00:00
2. Set up tools and extract the ROM: `make setup`
3. Re-build the ROM: `make`
2021-02-28 00:05:03 +00:00
# Contributing:
PRs are welcome, but please make sure your code can compile to a matching ROM succesfully.
(you'll know if it does because the terminal will read ``build/dino.z64: OK`` if the resulting ROM matches) before submitting.