mirror of https://github.com/Xeeynamo/sotn-decomp.git synced 2024-11-27 06:50:35 +00:00

Decompilation of Castlevania: Symphony of the Night (PSX+Saturn)

Go to file

Luciano Ciccariello 533822ad76 Some checks are pending Format code / format (push) Waiting to run Details Build C code / extract-assets (push) Waiting to run Details Build C code / build-linux (i686, Debug, clang, custom) (push) Blocked by required conditions Details Build C code / build-linux (i686, Debug, clang, lle) (push) Blocked by required conditions Details Build C code / build-linux (i686, Debug, gcc, custom) (push) Blocked by required conditions Details Build C code / build-linux (i686, Debug, gcc, lle) (push) Blocked by required conditions Details Build C code / build-linux (i686, RelWithDebInfo, clang, custom) (push) Blocked by required conditions Details Build C code / build-linux (i686, RelWithDebInfo, clang, lle) (push) Blocked by required conditions Details Build C code / build-linux (i686, RelWithDebInfo, gcc, custom) (push) Blocked by required conditions Details Build C code / build-linux (i686, RelWithDebInfo, gcc, lle) (push) Blocked by required conditions Details Build C code / build-linux (x86_64, Debug, clang, custom) (push) Blocked by required conditions Details Build C code / build-linux (x86_64, Debug, clang, lle) (push) Blocked by required conditions Details Build C code / build-linux (x86_64, Debug, gcc, custom) (push) Blocked by required conditions Details Build C code / build-linux (x86_64, Debug, gcc, lle) (push) Blocked by required conditions Details Build C code / build-linux (x86_64, RelWithDebInfo, clang, custom) (push) Blocked by required conditions Details Build C code / build-linux (x86_64, RelWithDebInfo, clang, lle) (push) Blocked by required conditions Details Build C code / build-linux (x86_64, RelWithDebInfo, gcc, custom) (push) Blocked by required conditions Details Build C code / build-linux (x86_64, RelWithDebInfo, gcc, lle) (push) Blocked by required conditions Details Build C code / build-macos (Debug) (push) Blocked by required conditions Details Build C code / build-macos (RelWithDebInfo) (push) Blocked by required conditions Details Build C code / build-windows (Debug) (push) Blocked by required conditions Details Build C code / build-windows (RelWithDebInfo) (push) Blocked by required conditions Details Build Saturn version / build-and-test-saturn (push) Waiting to run Details Build Saturn version / function-finder-saturn (push) Waiting to run Details Build Debug Module tool / build (push) Waiting to run Details Build PSX and PSP version / build-and-test (pspeu, hd) (push) Waiting to run Details Build PSX and PSP version / build-and-test (pspeu, pspeu) (push) Waiting to run Details Build PSX and PSP version / build-and-test (us, us) (push) Waiting to run Details Build PSX and PSP version / generate-progress-report (pspeu, hd) (push) Blocked by required conditions Details Build PSX and PSP version / generate-progress-report (pspeu, pspeu) (push) Blocked by required conditions Details Build PSX and PSP version / generate-progress-report (us, us) (push) Blocked by required conditions Details Build PSX and PSP version / generate-duplicates-report (us, us) (push) Blocked by required conditions Details Build PSX and PSP version / generate-duplicates-report-psp (pspeu, pspeu) (push) Blocked by required conditions Details WRP and CEN cohabitation (#1701 ) Experimental piece of work I feel confident enough to submit. A few things to take in consideration: * The new `pfn_entity_updates.h` header aims to use the PSP variant of `PfnEntityUpdates` and the two `g_pStObjLayout`, I just tweaked a bit the code from `stage.h` * Add overlay prefix to the PSX version of `PfnEntityUpdates` and the two `g_pStObjLayout` * Changed `wrp/create_entity` to `rwrp/create_entity` in RWRP because we need the `RWRP_` prefix to be issued * Remodernized the WRP header * I am still not sure what's wrong with `g_HeartDropArray` in `warp.c`. I am pretty sure it is a PSX bug. I opted for the PSP version There's a `// PfnEntityUpdates = OVL_EXPORT(EntityUpdates);`. If you uncomment and resolve the multiple definitions you will have the two overlays linked. I still need to figure out how to handle the `InitializeEntity` parameters in `e_init` without going mad with the `#ifdef`. Takeaways from the Xbox 360 build: * `EntityBreakable` is different in every overlay, so we can use the `OVL_EXPORT` in our decomp * Every other function seem to be de-duplciated. For those functions that are slightly different between overlays, the developers of the Xbox port opted for `if (g_StageId == XYZ)` Takeaways from the PSP build: * god bless the psp		2024-10-13 22:15:19 +01:00
.github/workflows	Make distinction between 32-bit and 64-bit requirements (#1786 )	2024-10-13 19:23:56 +01:00
.vscode	Custom debugging module (#108 )	2023-08-10 18:55:24 +01:00
bin	Use allegrex assembler for PSP (#1424 )	2024-07-22 15:36:28 -04:00
cmake	Texture render support (#934 )	2024-01-01 23:31:56 +00:00
config	WRP and CEN cohabitation (#1701 )	2024-10-13 22:15:19 +01:00
disks	Change how game assets are managed	2023-02-21 23:25:31 +00:00
docs	Use built-in abs function (#1151 )	2024-05-19 19:16:56 +01:00
include	WRP and CEN cohabitation (#1701 )	2024-10-13 22:15:19 +01:00
src	WRP and CEN cohabitation (#1701 )	2024-10-13 22:15:19 +01:00
tools	WRP and CEN cohabitation (#1701 )	2024-10-13 22:15:19 +01:00
.clang-format	Update clang-format as self-contained binary (#1257 )	2024-06-04 21:07:50 +01:00
.gitignore	Asset cutscene two stages (#1738 )	2024-10-06 13:10:06 +01:00
.gitmodules	Update splat to 0.24.4 (#1112 )	2024-06-12 18:50:32 +01:00
CMakeLists.txt	WRP and CEN cohabitation (#1701 )	2024-10-13 22:15:19 +01:00
CNAME	Create CNAME	2022-10-18 23:52:54 +01:00
CONTRIBUTING.md	Update CONTRIBUTING.md (#721 )	2023-10-31 20:34:50 +00:00
diff_settings.py	MAR duplicates (#1618 )	2024-09-16 18:19:29 +01:00
Dockerfile	Add bsdmainutils to requirements (#1667 )	2024-09-24 16:54:32 -07:00
go.work	New asset manager (#1343 )	2024-07-02 21:38:36 +01:00
go.work.sum	Weapon assets and statically linked (#1470 )	2024-08-09 00:57:26 +01:00
LICENSE	Add AGPL license (#1565 )	2024-09-06 16:14:55 -04:00
Makefile	NZ0 import all data (#1760 )	2024-10-07 17:22:43 +01:00
Makefile.psp.mk	Use allegrex assembler for PSP (#1424 )	2024-07-22 15:36:28 -04:00
Makefile.psx.mk	Asset cutscene two stages (#1738 )	2024-10-06 13:10:06 +01:00
Makefile.saturn.mk	Rewrite Saturn make rules (#660 )	2023-10-03 21:42:08 +01:00
README.md	Add NO0 (Marble Gallery) overlay (#1691 )	2024-09-30 00:53:54 +01:00
weapon0.ld	Import w_037 data and normalize weapon palette (#1777 )	2024-10-11 18:36:59 +01:00
weapon1.ld	Enhance Makefile for WEAPON0.BIN (#466 )	2023-08-14 02:03:54 +01:00

README.md

Castlevania: Symphony of the Night Decompilation

A work-in-progress decompilation of Castlevania Symphony of the Night for Sony PlayStation 1, Sony PlayStation Portable and Sega Saturn. It aims to recreate the source code from the existing binaries using static and/or dynamic analysis. The code compiles byte-for-byte to the same binaries of the game, effectively being a matching decompilation.

It currently supports the following versions of the game:

us the reference build with the serial number SLUS-00067
hd an unreleased PS1 Japanese build found in Castlevania: Dracula X Chronicles game data
pspeu European build from Castlevania: Dracula X Chronicles
saturn the port created by an external development team

This repo does not include any assets or assembly code necessary for compiling the binaries. A prior copy of the game is required to extract the required assets.

Bins decomp progress

File name	Code coverage	Decomp functions	Description
SLUS_000.67			Shared libraries
DRA.BIN			Game engine
BIN/RIC.BIN			Playable Richter
BIN/WEAPON0.BIN			Equippables
ST/CEN/CEN.BIN			Center
ST/DRE/DRE.BIN			Nightmare
ST/MAD/MAD.BIN			Debug Room
ST/NO0/NO0.BIN			Marble Gallery
ST/NO3/NO3.BIN			Entrance (first visit)
ST/NP3/NP3.BIN			Entrance
ST/NZ0/NZ0.BIN			Alchemy Laboratory
ST/SEL/SEL.BIN			Title screen
ST/ST0/ST0.BIN			Final Stage: Bloodlines
ST/WRP/WRP.BIN			Warp Room
ST/RWRP/RWRP.BIN			Warp Room (reverse)
BOSS/MAR/MAR.BIN			Maria cutscene
BOSS/RBO3/RBO3.BIN			Meduza boss
SERVANT/TT_000.BIN			Bat Familiar
SERVANT/TT_001.BIN			Ghost Familiar

Code coverage means how many bytes of code have been successfully converted from assembly into C code, while decomp function is how many functions have been successfully decompiled.

Useful links

Decompiling a game is a mastodontic task. If you have some basic programming skills, please join us in this journey. Any contribution will be very appreciated!

Special thanks

This project is possible thanks to the hard work of tools provided by the Decompilation community:

mips2c from @matt-kempster to decompile MIPS assembly into C. This has proven to be more accurate than Hexrays IDA and Ghidra.
splat from @ethteck to disassemble code and extract data with a symbol map. This tool provides the fundamentals of the SOTN decomp.
asm-differ from @simonlindholm to know how the decompiled code compares to the original binary.
decomp-permuter from @simonlindholm to pick different versions of the same code that better matches the original binary.
maspsx by @mkst to replicate the customized assembler used in the official PSX SDK.
decomp.me by @ethteck, @nanaian and @mkst to provide a collaborative decompilation site to share and contribute to work-in-progress decompiled functions.
frogress by @ethteck to store and retrieve progression data.
esa-new by @mkst as an inspiration on how to set-up a PS1 decompilation project.
oot as an inspiration of what it is possible to achieve with a complete decompiled video game.