2022-12-09 23:30:52 +00:00
# Castlevania: Symphony of the Night Decompilation
2022-01-01 17:45:41 +00:00
Add TT_000 overlay from PSP (#1113)
TT_000 is the first overlay from PlayStation 1 that we are now able to
compile from the source and produce a 1:1 binary. This lead me to start
exploring the same overlay from the game Castlevania: Dracula X
Chronicles, which contains a PSP re-build of Symphony of the Night.
This PR adds all the infrastructure to add the same flow for a PSP
matching decomp. Use `export VERSION=pspeu` and then the usual `sotn`
command to splat the overlay, build it and check if it matches. Running
`make extract_disk` should not be necessary as the same ISO used from
`VERSION=hd` is also used for `pspeu`, so you will probably have it
extracted already.
Some important notes about the PSP build:
* The whole PSP build seems to be compiled with `-O0`, which makes it
much easier to decompile
* Having ŧhe PSX, PSP and Saturn builds will allow to easily
cross-reference the code and reduce fake matches
* `disks/pspeu/PSP_GAME/USRDIR/res/ps/hdbin/tt_000.bin` is the HD PSX
build
* `disks/pspeu/PSP_GAME/USRDIR/res/ps/PSPBIN/tt_000.bin` has the same
code from the HD build, but for PSP
* `disks/pspeu/PSP_GAME/USRDIR/res/ps/PACK_E/TP00.BIN` is the same as
above, but it packs both overlay and graphics. This is the file the PSP
game seems to actually use
* The PSP build uses the Metrowerk CodeWarrior's C compiler, which is
very different from the GCC one used on PSX.
* Thanks to @mkst lead, we found a way to still use the GNU assembler
and linker
* MWCC uses [wibo](https://github.com/decompals/WiBo/), a think
compatibility layer to run Windows CLI tools on Linux. It is much more
lightweight than Wine.
* MWCC does not support the `INCLUDE_ASM` dialect, so the custom
pre-processor `tools/mwcpp` had to be created
* The exact MWCC compiler version is unknown, but I suspect it is `build
147`
* I am not yet sure of any implications for using GNU AS and GNU LD
instead of the MW correspondent tools
* Not all the functions can be correctly disassembled, spimdisasm will
just produce a bunch of `.word 0x________` due to the in-progress effort
of adding the Allegrex-specific opcodes support
---
TO-DO list before marking the PR as ready:
- [X] Add PSP build to the CI
- [x] Add progress reporting to the PSP build
- [x] Integrate source file from `src/servant/tt_000_psp` to
`src/servant/tt_000` to promote the psp build as first-citizen
---
TO-DO in a follow-up PR:
* Figure out what `header` is: can we extract it as assembly code? or
maybe as custom re-compilable asset via splat? Is it a MW stuff or a
Castlevania-specific file?
* Get rid of the last line in `Makefile.psp.mk`
2024-04-21 01:18:10 +00:00
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.
2023-06-29 23:08:06 +00:00
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
Add TT_000 overlay from PSP (#1113)
TT_000 is the first overlay from PlayStation 1 that we are now able to
compile from the source and produce a 1:1 binary. This lead me to start
exploring the same overlay from the game Castlevania: Dracula X
Chronicles, which contains a PSP re-build of Symphony of the Night.
This PR adds all the infrastructure to add the same flow for a PSP
matching decomp. Use `export VERSION=pspeu` and then the usual `sotn`
command to splat the overlay, build it and check if it matches. Running
`make extract_disk` should not be necessary as the same ISO used from
`VERSION=hd` is also used for `pspeu`, so you will probably have it
extracted already.
Some important notes about the PSP build:
* The whole PSP build seems to be compiled with `-O0`, which makes it
much easier to decompile
* Having ŧhe PSX, PSP and Saturn builds will allow to easily
cross-reference the code and reduce fake matches
* `disks/pspeu/PSP_GAME/USRDIR/res/ps/hdbin/tt_000.bin` is the HD PSX
build
* `disks/pspeu/PSP_GAME/USRDIR/res/ps/PSPBIN/tt_000.bin` has the same
code from the HD build, but for PSP
* `disks/pspeu/PSP_GAME/USRDIR/res/ps/PACK_E/TP00.BIN` is the same as
above, but it packs both overlay and graphics. This is the file the PSP
game seems to actually use
* The PSP build uses the Metrowerk CodeWarrior's C compiler, which is
very different from the GCC one used on PSX.
* Thanks to @mkst lead, we found a way to still use the GNU assembler
and linker
* MWCC uses [wibo](https://github.com/decompals/WiBo/), a think
compatibility layer to run Windows CLI tools on Linux. It is much more
lightweight than Wine.
* MWCC does not support the `INCLUDE_ASM` dialect, so the custom
pre-processor `tools/mwcpp` had to be created
* The exact MWCC compiler version is unknown, but I suspect it is `build
147`
* I am not yet sure of any implications for using GNU AS and GNU LD
instead of the MW correspondent tools
* Not all the functions can be correctly disassembled, spimdisasm will
just produce a bunch of `.word 0x________` due to the in-progress effort
of adding the Allegrex-specific opcodes support
---
TO-DO list before marking the PR as ready:
- [X] Add PSP build to the CI
- [x] Add progress reporting to the PSP build
- [x] Integrate source file from `src/servant/tt_000_psp` to
`src/servant/tt_000` to promote the psp build as first-citizen
---
TO-DO in a follow-up PR:
* Figure out what `header` is: can we extract it as assembly code? or
maybe as custom re-compilable asset via splat? Is it a MW stuff or a
Castlevania-specific file?
* Get rid of the last line in `Makefile.psp.mk`
2024-04-21 01:18:10 +00:00
* `pspeu` European build from Castlevania: Dracula X Chronicles
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.
