gillou68310 / soul-re

Reverse-engineering project of the 1999 PlayStation game Legacy of Kain: Soul Reaver, from MIPS to C.

Soul Reaverse

An in-progress decompilation of the Jul 14, 1999 prototype of Legacy of Kain: Soul Reaver on the Playstation 1.

Building (Linux)

Install build dependencies

The build process has the following package requirements:

• git
• build-essential
• binutils-mips-linux-gnu
• python3
• bchunk
• 7z

Under a Debian based distribution, you can install these with the following commands:

sudo apt update
sudo apt install git build-essential binutils-mips-linux-gnu python3 bchunk p7zip-full p7zip-rar

Clone the repository

Clone https://github.com/FedericoMilesi/soul-re in whatever directory you wish. Make sure to clone recursively!

git clone --recursive https://github.com/FedericoMilesi/soul-re.git
cd soul-re

Install Python3 requirements

Run python3 -m install -r requirements.txt

Placing the ROM

Obviously, you will need to provide your own rom dump of the game. The required version is the 1999-07-14 Prototype Version of Legacy of Kain: Soul Reaver. If done correctly, you will end up with a .IMG and a .CUE file that you can mount on your PC to get the required binary, SLUS_007.08, which needs to be placed inside the soul-re folder.

Build the code

Run make setup to extract needed stuff from the SLUS_007.08 file, if that succeeds, run make -j12 to build it. Once build has finished a folder will be produced with the name build, inside this, you will find the output.

If you have trouble with this setup process, reach out on the Discord server for the project: https://discord.gg/W8khh4v4Gx

Contributing

Contributions are welcome. If you would like to reserve a function, open a PR with the function or file name(s).