tomb5 / tomb5 Goto Github PK

View Code? Open in Web Editor NEW

490.0 24.0 44.0 6.92 MB

Tomb Raider: Chronicles Disassembly translated to C source code.

License: MIT License

C 81.40% CMake 1.91% Makefile 0.24% C++ 9.90% Python 1.21% Batchfile 0.13% Java 4.91% HLSL 0.30%

tomb raider psx pc source code decompile engine lara croft

tomb5's Introduction

Project: Decompile Tomb Raider: Chronicles (TOMB5)

Start Date: 21st June 2017.

PSX:

PSXPC_N:

PC_N:

Platform	Build State
Windows (PSXPC_N)
Linux (PSXPC_N)
Linux (PSXPC_N)
PSX

Disclaimer

This project may be abandoned at any time, use this product at your own risk.

What is this?

This repository contains decompiled code for the game Tomb Raider: Chronicles. All decompiled code is based off the final PlayStation and PC version. The goal is to decompile as much as possible since the original source code is reportedly lost. It is not expected for decompiled code to be 1:1 with the original source code. However, functionality wise it will be the same. Further debugging of the original PlayStation version at a later phase will help map out any existing bugs. All information (variable, file names, method names and data structures) have been obtained from debugging symbols (.SYM, .MAP), TRosettastone 3.0 and GAMEWAD.OBJ.

What are the current goals?

Current goals include decompiling all code up until the title screen sequence, ensuring it's fully correct then proceeding to decompiling in-game code. At this point in time the most critically required parts of code reside within the "GAME" folder.

Usage

Assuming you have compiled the most recent code or downloaded the latest binaries from appveyor (artifacts). Simply put your Tomb Raider: Chronicles PlayStation disc into your PC. At this point you'll need to copy all the files from the root of the CD to the same folder as MAIN.EXE. The codebase is currently based off the final NTSC version of Tomb Raider: Chronicles and final PC version. This means that other localised versions may not be supported. For further usage and build instructions visit this file.

How long will this take?

Depending on the amount of contributors it could take years.

Feel free to contact me on this: Discord server channel #TOMB5-decompile

Credits

Gh0stBlade: Lead Programmer (PSX/PSXPC_N).
zdimension: Programmer (PSX/PSXPC_N,PC_N).
Stohrendorf: Symdump tool creator.
smf: GTE code for EMU.
XProger: EMU render optimisations.
You?

tomb5's People

Contributors

Stargazers

Watchers

Forkers

zdimension gnaghi mewbak ioanlongjing tobey123 fbmly007 hardcppforks 2xsaiko tosotada xinjiesg rodrigobmg fromasmtodisasm majorleek longjohncoder gitmesam lewiscowles1986 amriksadhra revosucks montytrc89 nanangarsyad xproger videogamesources heruix meineri fanyi3315 newyork167 infernuslord booshsource seyi jorge1569 parhelia512 ezhangle ianmicheal ps1lover feiyunwill icodein wode2016501 vertical-sh gargoy-les meowboy326 deanwyns masihercan bishmanrock

tomb5's Issues

Fatal: GPU time-out

Log: GPU timeout:que=0, stat=52042603, chcr=00000401, madr=00ffffff

PSX Branch needs syncing with PSXPC

PSX branch is severely out of date, must update/add all missing PSX PSYQ SDK calls.

Bad Draw Room Indices

Decompiled:

Original:

Overlays

Overlays are now possible on PSX like the original game, see SETUP.C->SETUP.MOD.

Problem is LoadSoundEffects function has a call to SpuMalloc which causes the game to crash completely, must be investigated. Works fine if overlays are not used.

Bug: GPU_BeginScene()

Illegal poly ptrs.

Files decompiled so far

Completed files (Based on PSX):

Todo (List not complete):

All code should be kept clean/readable and finished.

There's large chunks of code that isn't finished or is pure asm commented out. This is polluting the codebase and should therefore be removed instantly!

Problems with drawing title intro screen

Color blending is not working as expected, HACK_CLEAR_DRAW_AREA is used temporarily

Contributing.md missing steps to get started

Describe the bug
I was trying to follow the getting started steps and I think it is missing a step about installing glew-2.1.0 into the EXTERNAL folder.

To Reproduce
Steps to reproduce the behavior:

Follow Contributing.md through step 1 into step 2
Realise that CMake cannot find glew-2.1.0. Causing no project files to be created

Expected behavior
There should be an additional requirement in step 1 Dependencies for glew-2.1.0.
There should be an additional bullet point in step 2 to install glew-2.1.0 into the EXTERNAL folder.

Desktop (please complete the following information):

OS: Windows 10

CODE.WAD Needs unpacking.

PSX crashing

PSX version is freezing up.

Known hacks

This issue will contain a list of known hacks to be removed.

PSX Regression.

Game crashing at loading screen. Caused by most recent commits on develop-gh0stblade branch.

External dependencies (Windows)

SDL2 cmake script requires an environment variable to be set to SDL2's location. Probably better to just scan /EXTERNAL/SDL2.

TODO: PC

TitleOptions deleted, needs moving to PC Specific code.
GetRandomControl deleted from CONTROL.C needs moving to PC Specific code.
GetRandomDraw deleted from CONTROL.C needs moving to PC specific code.

Implement the functions

GAME

ANDREA1.C

ANDREA2.C

ANDREA3.C

ANDY1.C

ANDY2.C

ANDY3.C

ANIM.C

BOX.C

CAMERA.C

CODEWAD.C

sub_1BDF88
sub_1BE988
TriggerEngineEffects_CUT

COLLIDE.C

CONTROL.C

DEBRIS.C

GetFreeDebris
ShatterObject
TriggerDebris

DELSTUFF.C

CalcLaraMatrices @Gh0stBlade - WIP

DELTAPAK.C

DOOR.C

DRAW.C

EFFECT2.C

EFFECTS.C

FLMTORCH.C

FONT.C

FOOTPRNT.C

GAMEFLOW.C

GUARDIAN.C

HAIR.C

InitialiseHair

HEALTH.C

HYDRA.C

ITEMS.C

JOBY1.C

JOBY2.C

JOBY3.C

JOBY4.C

JOBY5.C

LARA.C

LARA1GUN.C

LARA2GUN.C

LARACLMB.C

LARAFIRE.C

LARAFLAR.C

LARAMISC.C

LARASURF.C

LARASWIM.C

LOT.C

MAFIA2.C

MISSILE.C

ControlBodyPart
ExplodeFX

NEWINV2.C

OBJECTS.C

OBJLIGHT.C

PEOPLE.C

PICKUP.C

RAT.C

RICH1.C

RICH2.C

RICH3.C

RICHCUT2.C

ROPE.C

LoadRope
SaveRope
Straighten
StraightenRope

SAVEGAME.C

SOUND.C

SayNo
SOUND_EndScene
SOUND_Init
SOUND_Stop

SPHERE.C

GetSpheres
TestCollision

SPOTCAM.C

CalculateSpotCams
InitialiseSpotCam
InitSpotCamSequences
Spline

SWITCH.C

TEXT.C

InitFont

TOMB4FX.C

TOWER1.C

TOWER2.C

TOWER3.C

TRAPS.C

TWOGUN.C

SPEC_PC_N

3DGLOBAL.CPP

CALCLARA.C

GetBoundsAccurate

DEBUG.CPP

DIRECTX.CPP

DISPLAY.CPP

DrawChar

DRAWPRIMITIVE.CPP

DS.CPP

CDDA_SetMasterVolume
S_SoundSetPitch

DXERROR.CPP

ERR_Describe_DX
ERR_Describe_Init

FILE.CPP

GAME.CPP

do_boot_screen
GameClose
HWInitialise
InitFX

HWINSERT.CPP

InitBuckets

INIT.CPP

INPUT.CPP

Key
S_UpdateInput

MATRIX_SHIT.CPP

NEWSHIT.CPP

SETUP.CPP

SMAIN.CPP

SPECIFIC.CPP

STUBS.C

phd_sqrt
S_SetReverbType

TIME.CPP

Sync
TIME_Init
TIME_Reset

WINMAIN.CPP

WORKSTUBS.CPP

SPEC_PSX

3D_GEN.C

phd_InitWindow

3D_OBJ.C

CreateMonoScreen

ANIMITEM.C

S_DrawFootPrints

BUBBLES.C

CalcClipWindow_ONGTE
DrawFlash
DrawPsxTile
S_DrawSparks

CALCLARA.C

DEL_CalcLaraMatrices_Interpolated_ASM
DEL_CalcLaraMatrices_Normal_ASM
GetBoundsAccurate

CARDHDR.C

CD.C

COLLIDE_S.C

UpdateSky

CONTROL_S.C

DrawBinoculars

DELTAPAK_S.C

DrawCutSeqActors

DRAWOBJ.C

InitObjGTE
MakeMono

DRAWPHAS.C

DRAWSPKS.C

S_DrawDarts

FILE.C

FILE_Length
FILE_Load
FILE_Read
RelocateModule

FXDRAW.C

DrawAllFx

FXTRIG.C

SetGunFlash

GPU.C

LOADSAVE.C

DisplayFiles
LoadGame
SaveGame

LOAD_LEV.C

LOAD_DrawEnable
LOAD_Start
LOAD_Stop

MALLOC.C

game_free
game_malloc
init_game_malloc
show_game_malloc_totals

MATHS.C

MEMCARD.C

MISC.C

MOVIE.C

FMV_InitialiseScreen
FMV_InitialiseVRAM
S_PlayFMV

PAELLA.C

PRINTOBJ.C

print_all_object_NOW

PROFILE.C

PSOUTPUT.C

SetupPadVibration
VibratePad

PSXINPUT.C

S_UpdateInput

PSXMAIN.C

main
VSyncFunc

REQUEST.C

Requester

ROOMLETB.C

DrawRoomletListAsmBinocular
DrawRooms

ROOMLOAD.C

ReloadAnims
S_LoadLevelFile

SETUP.C

InitialiseCutseq

SFX.C

SHADOWS.C

OptimiseOTagR

SPECIFIC.C

SPUSOUND.C

SPU_FreeSamples
SPU_Init

TEXT_S.C

DrawChar
GetStringDimensions

TITSEQ.C

SPEC_PSXPC

3D_GEN.C

phd_InitWindow

3D_OBJ.C

CreateMonoScreen

ANIMITEM.C

S_DrawFootPrints

BUBBLES.C

CALCLARA.C

DEL_CalcLaraMatrices_Interpolated_ASM
DEL_CalcLaraMatrices_Normal_ASM
GetBoundsAccurate
S_SetupClutAdder

CARDHDR.C

CD.C

COLLIDE_S.C

UpdateSky

CONTROL_S.C

DrawBinoculars

DELTAPAK_S.C

DrawCutSeqActors

DRAWOBJ.C

InitObjGTE
MakeMono

DRAWPHAS.C

DRAWSPKS.C

S_DrawDarts

FILE.C

FILE_Length
FILE_Load
FILE_Read
RelocateModule

FXDRAW.C

DrawAllFx

FXTRIG.C

SetGunFlash

GPU.C

LOADSAVE.C

DisplayFiles
LoadGame
SaveGame

LOAD_LEV.C

LOAD_DrawEnable
LOAD_Start
LOAD_Stop

MALLOC.C

game_free
game_malloc
init_game_malloc
show_game_malloc_totals

MATHS.C

MEMCARD.C

MISC.C

MOVIE.C

FMV_InitialiseScreen
FMV_InitialiseVRAM
S_PlayFMV

PRINTOBJ.C

print_all_object_NOW

PROFILE.C

PSOUTPUT.C

SetupPadVibration
VibratePad

PSXPCINPUT.C

S_UpdateInput

PSXPCMAIN.C

main
VSyncFunc

REQUEST.C

Requester

ROOMLETB.C

DrawRoomletListAsmBinocular
DrawRooms

ROOMLOAD.C

ReloadAnims
S_LoadLevelFile

SETUP.C

SFX.C

SHADOWS.C

SPECIFIC.C

SPUSOUND.C

SPU_FreeSamples
SPU_Init

TEXT_S.C

DrawChar

TITSEQ.C

SPEC_PSXPC_N

3D_GEN.C

phd_InitWindow

3D_OBJ.C

CreateMonoScreen

BUBBLES.C

DrawPsxTile

CALCHAIR.C

CALCLARA.C

DEL_CalcLaraMatrices_Interpolated_ASM
DEL_CalcLaraMatrices_Normal_ASM
GetBoundsAccurate
S_SetupClutAdder

CD.C

COLLIDE_S.C

UpdateSky

CONTROL_S.C

DrawBinoculars

DELTAPAK_S.C

DrawCutSeqActors
updateAnimFrame

DRAWOBJ.C

InitObjGTE
MakeMono

DRAWPHAS.C

DrawPhaseGame
DrawRooms
MGDrawSprite
SortOutWreckingBallDraw

DRAWSKY.C

DRAWSPKS.C

FILE.C

FILE_Length
FILE_Load
FILE_Read
RelocateModule

FOOTPRNT_S.C

FXTRIG.C

GETSTUFF.C

GPU.C

do_gfx_debug_mode
GPU_EndScene
GPU_FlipNoIdle
GPU_FlipStory

LIGHT.C

LOADSAVE.C

LOAD_LEV.C

LOAD_Start
LOAD_Stop

MALLOC.C

game_free
game_malloc
init_game_malloc
show_game_malloc_totals

MATHS.C

MEMCARD.C

MISC.C

MOVIE.C

FMV_InitialiseVRAM

PRINTOBJ.C

print_all_object_NOW
PrintAllOtherObjects_ASM

PROFILE.C

PSOUTPUT.C

SetupPadVibration
VibratePad

PSXINPUT.C

PSXMAIN.C

main
psx_main
VSyncFunc

REQUEST.C

Requester

ROOMLETB.C

DrawRoomletListAsmBinocular
DrawRooms

ROOMLOAD.C

S_LoadLevelFile

SFX.C

SHADOWS.C

SPECIFIC.C

SPHERES.C

SPUSOUND.C

SPU_FreeSamples
SPU_Init

TEXT_S.C

DrawChar
UpdatePulseColour

TITSEQ.C

Compiler Warnings.

There's a lot of compiler warnings which must be resolved.

Build: PSX is failing.

PSXPC - Crashing and out of date

Out of sync.
Lots of PSX ASM code needs decompiling to C for this code path.
Currently crashing, shouldn't share code with PC_VERSION.
Will need separate debugging phase.

Probably going to drop PSXPC support for a long while now, focusing on PSX unless someone else wants to maintain it. I will ensure it compiles though.

Bug: PSX Compile

See: 3617704

Reverted, if file resaved in VS2017. PSX PsyQ compiler complains about an illegal character.

Crash: phd_sqrt_asm

Caused by gte_stlzc... swc2 is incorrect.

CODE.WAD needs disassembling.

From both INT and release build.

Fatal: SPU locate free channel failure.

Fatal: Vsync time out

Vsync time out.. Causing severe slowdowns/unresponsiveness on the PSX version. Must find the cause.

Bug: draw_rotate_sprite (PSX)

draw_rotate_sprite simply does not work.

CODE.WAD Can be loaded once.

Might as well load it into memory once rather than loading it each time a level is loaded since the file is identical across all gamewad entries. May need gamewad format alteration.

test

Methods must be re-ordered same as the original code.

Currently some methods are incorrectly ordered, would prefer them to be in the same order as seen in psx symbol output.

Split INTERNAL code path.

Currently, "INTERNAL" code path splits out retail/internal beta code, leaving us with internal beta/debug/psx no cd code.

INTERNAL code path should be split properly i.e:

All INTERNAL BETA specific code should be kept wrapped in "INTERNAL_BETA".
All Debug code should be wrapped in "DEBUG_VERSION".
All file io/cd operations should be wrapped in "NO_CD" (use of SIO).

Will allow us to properly mix debug/no-cd code into the retail code path. Note: I have not yet seen a case where game code logic has changed between retail/internal.

Investigate future possible x64 complications.

Impossible, not enough space to relocate 64-bit pointers then store.

See: https://github.com/Gh0stBlade/TOMB5/blob/master/SPEC_PSXPC/SETUP.C#L145

Bug: Graphics

Caused by b4e7575

PSX version crash on launch.

Caused by recent commit.

Bug: (PSX/PSXPC) - Drawing

There's a bug in the code that prevents further drawing of primitives after the pre-title loading sequence.

Bug: RelocateLevel

ptr mis-alignment, causes invalid spotcam ptr + possibly more.

Game Memory optimisation

GAMEFLOW, when string header of language specific script is loaded.... There's still unused data (language script names) which aren't used. I believe Core intended to strip this out during the string header memcopy but it has failed not all of the script language names get overwritten.

Appveyor - Artifacts.

Artifacts are offline. Issue with zipping built binaries due to their folder changing with the new CMake system including multiple build targets in the solution file.

Static methods

Static methods don't show in MAIN.MAP but they do show in MAIN.sym. This is an easy way to detect what functions were declared static in the original codebase

Bug: RelocateModule (PSX)

Untested, as expected... second param ptr is invalid. Local fix applied, needs testing.

Find a way to integrate TR5Main into the codebase

By compiling code selectively we would be able to directly test game code that we can't currently test because of the lack of a functional platform branch.

Appveyor/Travis errors.

Solved PSXPC Appveyor
Appveyor ubuntu todo
Travis todo

Appveyor - PSX - Needs valid link to PSX SDK.

Need someone to host the PSX SDK on a valid URL.

[PSX] Verification Phase: #1 Progress.

GAME - CFILES:

TEXT.C

SPEC_PSX - CFILES:

SPEC_PSX - MIP FILES:

Bug: GPU_FlipToBuffer (PSX)

Buffer flip index not saved.

Level serialisation is broken.

Caused by: 2c0f8b7

All globals variables. It should be checked that their initial value is correct.

Bug: PSX version runs out of memory.

Happens just before rooms are loaded (LevelRelocPtr[14]). Results in NULL being returned and a crash.

[PSX] Internal beta failing

Fails to properly load up, some crash to be investigated soon.

PSXPC - Simulate polygon buffers.

Should simulate polygon buffers to make life easier debugging the PSX version.

Looking for dedicated QA testers

Now we are at a stage where we need QA testers.

We are looking for QA testers to test the following platforms:

PSX.
PSXPC_N

Test plan:
Test TOMB5 decompile reporting any issues found via GitHub issues. Preferably it would be better to compare the decompile version to the original game to help identify bugs more easily. Testers will be responsible for testing all menu cases.

PSXPC is out of date.

Must be re-synced with PSX Platform Specific code.

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.