2022-12-09 23:30:52 +00:00
# Castlevania: Symphony of the Night Decompilation
2022-01-01 17:45:41 +00:00
2023-06-29 23:08:06 +00:00
A work-in-progress decompilation of Castlevania Symphony of the Night for Sony PlayStation 1 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:
2023-07-02 18:19:35 +00:00
2023-06-29 23:08:06 +00:00
* `us` the reference build with the serial number SLUS-00067
2023-07-02 18:19:35 +00:00
* `hd` an unreleased PS1 Japanese build found in Castlevania: Dracula X Chronicles game data
2023-06-29 23:08:06 +00:00
* `saturn` the port created by an external development team
2022-01-01 17:45:41 +00:00
2022-12-09 23:30:52 +00:00
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.
2022-10-21 17:20:10 +00:00
## Bins decomp progress
2023-02-25 11:43:20 +00:00
| File name | Code coverage | Decomp functions | Description
|------------|----------|-----------|-------------
2024-02-10 10:37:13 +00:00
| SLUS_000.67 |  |  | Shared libraries
2023-02-25 11:43:20 +00:00
| DRA.BIN |  |  | Game engine
| BIN/RIC.BIN |  |  | Playable Richter
2023-08-26 07:29:05 +00:00
| BIN/WEAPON0.BIN |  |  | Equippables
2023-02-25 11:43:20 +00:00
| ST/CEN/CEN.BIN |  |  | Center
| ST/DRE/DRE.BIN |  |  | Nightmare
| ST/MAD/MAD.BIN |  |  | Debug Room
| 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)
| SERVANT/TT_000.BIN |  |  | Bat Familiar
2023-10-22 11:31:51 +00:00
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.
2022-01-01 17:45:41 +00:00
2023-03-28 21:08:41 +00:00
## Useful links
2023-02-21 01:27:25 +00:00
2023-03-28 21:08:41 +00:00
* [Build guide ](https://github.com/Xeeynamo/sotn-decomp/wiki/Build )
* [Decompilation guide ](https://github.com/Xeeynamo/sotn-decomp/wiki/Decompilation )
* [Progress report ](https://sotn.xee.dev/ )
2023-02-21 01:27:25 +00:00
2023-10-28 22:23:18 +00:00
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!
[](https://sotn-discord.xee.dev/)
2023-02-28 15:40:00 +00:00
## Special thanks
This project is possible thanks to the hard work of tools provided by the Decompilation community:
2023-10-27 18:48:18 +00:00
* [mips2c ](https://github.com/matt-kempster/m2c ) from @matt -kempster to decompile MIPS assembly into C. This has proven to be more accurate than Hexrays IDA and Ghidra.
2023-10-30 20:19:30 +00:00
* [splat ](https://github.com/ethteck/splat ) from @ethteck to disassemble code and extract data with a symbol map. This tool provides the fundamentals of the SOTN decomp.
2023-02-28 15:40:00 +00:00
* [asm-differ ](https://github.com/simonlindholm/asm-differ ) from @simonlindholm to know how the decompiled code compares to the original binary.
* [decomp-permuter ](https://github.com/simonlindholm/decomp-permuter ) from @simonlindholm to pick different versions of the same code that better matches the original binary.
2023-06-29 23:08:06 +00:00
* [maspsx ](https://github.com/mkst/maspsx ) by @mkst to replicate the customized assembler used in the official PSX SDK.
2023-02-28 15:40:00 +00:00
* [decomp.me ](https://github.com/decompme/decomp.me/ ) by @ethteck , @nanaian and @mkst to provide a collaborative decompilation site to share and contribute to work-in-progress decompiled functions.
* [frogress ](https://github.com/decompals/frogress ) by @ethteck to store and retrieve progression data.
* [esa-new ](https://github.com/mkst/esa-new ) by @mkst as an inspiration on how to set-up a PS1 decompilation project.
2023-03-03 18:52:45 +00:00
* [oot ](https://github.com/zeldaret/oot ) as an inspiration of what it is possible to achieve with a complete decompiled video game.
