Skip to content

fmil95/soul-re

Repository files navigation

Soul Reaverse

image

Description

Soul Reaverse is a project that seeks to reconstruct the source code of the PSX action-adventure classic Legacy of Kain: Soul Reaver. This is achieved by disassembling the executable of a prototype of the game that was built two weeks before its final release, which includes a full set of debugging symbols that makes the process of reverse-engineering the binary's MIPS instructions back to C language easier.

Once its fully overhauled, the source code could then be used for many different purposes, including but not limited to: porting the game to other platforms, improving its performance on console hardware, and developing tools for it such as a level editor.

Progress

Build Status Code Progress Data Progress

Name Purpose Status
SLUS_007.08 Gex 2 engine + game code image image
cinemax.drm Video Player overlay image image
mcardx.drm Memory Card overlay image image
hunter.drm Human Hunter overlay image image
skinner.drm Melchiahim overlay image image
wallcr.drm Zephonim overlay image image
aluka.drm Rahabim overlay image image
skinbos.drm Melchiah overlay image image
kain.drm Kain overlay image image
walboss.drm Zephon overlay A image image
walbosb.drm Zephon overlay B image image
alukabss.drm Rahab overlay image image
roninbss.drm Dumah overlay image image

In case you wonder what an overlay is: Soul Reaver like many other titles for the PlayStation (especially those near the end of the system's life cycle) distributes a good amount of game logic throughout overlays. For those not familiar with the concept, overlays are binaries which contain code that is loaded at specific instances during gameplay by the primary executable. This was designed such to taper the maximum amount of memory that the game consumes at once, which could never be too high due to hardware limitations.

While overlays are fairly common, Crystal Dynamics designed some noteworthy tech to link DRM files dynamically on runtime, which means that the game's overlays never load at the same address during execution. The undrm function of cd-dat-utils circumvents that, allowing decompilation of the modules.

Setting Up

For first time setup, check out the installation guide.

Contributing

Thinking about contributing to the project? Check out the contribution guide to get started!

Reference

New to the PSX, decompilation as a whole, or just stuck on a function? Check out the decompilation reference which has several common code patterns broken down and documented.

Contact

The PS1/PS2 Decompilation Discord server has an exclusive channel for this decompilation titled #soul-reaver, which is the main medium of communication for anything in relation to it: [REDACTED].

Alternatively, if you aren't able to join the server for some reason, you can write me an email to frozenburnside@hotmail.com with any query you might have.

About

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

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors