Game-Decompilation/sotn-decomp
1
0
Fork 0
mirror of https://github.com/Xeeynamo/sotn-decomp.git synced 2024-11-26 22:40:33 +00:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity
Decompilation of Castlevania: Symphony of the Night (PSX+Saturn)
1,992 Commits 18 Branches 1 Tag 62 MiB
C 87.3%
Python 3.6%
C++ 3.3%
Go 3.2%
Rust 1.4%
Other 1.2%
76d1584c89
Go to file
Jonathan Hohle 76d1584c89
Replace BIOS Trampolines (#1133) 
This replaces several dozen BIOS trampolines from the extracted ASM to
"decompiled" source. These are modeled on the `INCLUDE_ASM` macro, but
generate the instructions necessary for each trampoline directly instead
of importing an extracted source file.

Because these trampolines never return, and GCC 2.6 doesnt appear to
have builtins for leaving off the return jump postamble, these will
likely need to remain assembly.

This also changes the `main.elf` target to depend on `main.ld`, and
undefined symbols files, allowing `make build` to regenerate those files
if necessary.

Co-authored-by: Jonathan Hohle <jon@ttkb.co>
2024-05-17 08:45:26 +01:00
.github/workflows Fix CI progress report for pspeu 2024-04-21 02:29:16 +01:00
.vscode Custom debugging module (#108) 2023-08-10 18:55:24 +01:00
bin Add TT_000 overlay from PSP (#1113) 2024-04-21 02:18:10 +01:00
cmake Texture render support (#934) 2024-01-01 23:31:56 +00:00
config Replace BIOS Trampolines (#1133) 2024-05-17 08:45:26 +01:00
disks Change how game assets are managed 2023-02-21 23:25:31 +00:00
docs Import 5D6C4 data (#845) 2023-12-14 08:45:07 -08:00
include Replace BIOS Trampolines (#1133) 2024-05-17 08:45:26 +01:00
src Replace BIOS Trampolines (#1133) 2024-05-17 08:45:26 +01:00
tools Support Single BIN CUE Files (#1127) 2024-05-14 19:59:56 +01:00
.clang-format Disallow formatter to make some undesiderable changes 2023-07-05 22:50:18 +01:00
.gitignore Add TT_000 overlay from PSP (#1113) 2024-04-21 02:18:10 +01:00
.gitmodules Extract memory card icons (#166) 2023-12-11 23:12:13 -08:00
CMakeLists.txt Migrate rodata to functions for dra (#1084) 2024-02-25 17:44:11 +00: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 More TT_000 PSP functions matching (#1115) 2024-04-23 20:06:05 +01:00
Dockerfile Update maspsx (#1100) 2024-03-15 14:04:57 -07:00
go.work Purge ASPATCH 2023-06-17 12:30:42 +01:00
Makefile Replace BIOS Trampolines (#1133) 2024-05-17 08:45:26 +01:00
Makefile.psp.mk Improve permuter behaviour with the PSP build (#1117) 2024-05-04 10:06:37 +01:00
Makefile.psx.mk Add TT_000 from the HD version (#1111) 2024-04-04 22:28:57 +01:00
Makefile.saturn.mk Rewrite Saturn make rules (#660) 2023-10-03 21:42:08 +01:00
README.md Add TT_000 overlay from PSP (#1113) 2024-04-21 02:18:10 +01:00
weapon0.ld Enhance Makefile for WEAPON0.BIN (#466) 2023-08-14 02:03:54 +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 code coverage SLUS_000.67 decompiled functions Shared libraries
DRA.BIN code coverage DRA.BIN decompiled functions Game engine
BIN/RIC.BIN code coverage RIC.BIN decompiled functions Playable Richter
BIN/WEAPON0.BIN code coverage WEAPON0.BIN decompiled functions Equippables
ST/CEN/CEN.BIN code coverage CEN.BIN decompiled functions Center
ST/DRE/DRE.BIN code coverage DRE.BIN decompiled functions Nightmare
ST/MAD/MAD.BIN code coverage MAD.BIN decompiled functions Debug Room
ST/NO3/NO3.BIN code coverage NO3.BIN decompiled functions Entrance (first visit)
ST/NP3/NP3.BIN code coverage NP3.BIN decompiled functions Entrance
ST/NZ0/NZ0.BIN code coverage NZ0.BIN decompiled functions Alchemy Laboratory
ST/SEL/SEL.BIN code coverage SEL.BIN decompiled functions Title screen
ST/ST0/ST0.BIN code coverage ST0.BIN decompiled functions Final Stage: Bloodlines
ST/WRP/WRP.BIN code coverage WRP.BIN decompiled functions Warp Room
ST/RWRP/RWRP.BIN code coverage RWRP.BIN decompiled functions Warp Room (reverse)
SERVANT/TT_000.BIN code coverage TT_000.BIN decompiled functions Bat 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!

Join to our Discord server

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.