gta-reversed / gta-reversed-modern Goto Github PK

View Code? Open in Web Editor NEW

523.0 25.0 88.0 13.42 MB

Reimplementation of GTA:SA 1.0 US

CMake 0.07% C 19.05% Batchfile 0.01% Lua 0.08% C++ 80.72% Python 0.07%

source-code gtasa mtasa multitheftauto grandtheftauto plugin-sdk modern-cpp bug-fix bug-fixing windows

gta-reversed-modern's Introduction

gtasa-reversed

A project to reverse Grand Theft Auto San Andreas completely, and to rewrite and document every function.

What exactly is this project?

Building this project will result in a DLL file that can be injected into GTA:SA using any ASI loader out there. After the DLL file has been injected, the ingame functions will be replaced by the reversed ones. The game will behave the same. Now if we make any changes to the reversed code, it will take effect in the game. The goal is to keep reversing until we have the entire game reversed to compile a standalone executable.

Progress

The progress of reversed classes can be tracked here. (needs to be updated) We currently estimate that about 50-60% of the code is done. Since this project is done as a hobby, and worked on at irregular intervals, there's no real time estimate.

Coding Guidelines

Before you start writing code, please make sure to read the coding guidelines for this project.

Requirements

Visual Studio 2022 (Community Edition is enough)
CMake (for those who want to use CMake instead of premake5)

Build Instructions

You can either build with Premake5 or CMake; that's up to you, but a C++20 capable compiler [with <ranges>, <format> support] is required.

First clone the project, including the submodules:

git clone --recurse-submodules https://github.com/gta-reversed/gta-reversed-modern.git

Premake5

Execute premake5.bat
You'll find gta_reversed.sln shortcut in the same folder as premake5.
Open it, and once the project has loaded, just hit CTRL + SHIFT + B

CMake

Sadly CMake requires VS22, because since CMake v3.20.4 cxx_20 maps to std=c++20 instead of std=c++latest. If you really want to avoid VS22, you can either downgrade your CMake, or change c++20 to c++latest manually in the project settings... Or just use premake5 instead.
Download and install the latest version of CMake for windows from HERE and make sure to add it to your PATH.

GUI

Open CMake GUI
Set the Source and Build directories (Don't forget to append "Bin" after the path for build), like this:

Click configure, then you will see a dialogue box. Choose the IDE you have (In the image below it's VS2019) and "Win32", then click Finish.

Once the configuration is complete, click the Generate button.
You'll find GTASA.sln in the Bin folder.

CLI

Open Command Prompt in the gta-reversed directory and run cmake -Bbuild -H. -A Win32.
To open the Visual Studio project, simply run cmake --open build or open build/GTASA.sln manually.
Once the configuration is complete, click the Generate button.
You'll find GTASA.sln in Bin folder.

Game

To install all the necessary files, run install.py with administrator privileges [Necessary to create symlinks on Windows] in the root directory. Alternatively, you can install them by yourself:

GTA SA Compact exe
ASI Loader
III.VC.SA.WindowedMode.asi
Mouse Fix (dinput8.dll) [Can be found in the zip in ./contrib]

You can download them in a single archive. Using other plugins is strongly discouraged and we provide no support.

To run the game with the Modern plugin, you just need to run the "Local Windows Debugger" in Visual Studio.

What to work on?

Check this out for some inspiration ;)

Credits

All contributors of the plugin-sdk project.
All contributors of the original project.
Hundreds of great people on gtaforums.com.
re3 team.
And everyone who contributed to GTA:SA reversing.

gta-reversed-modern's People

Contributors

Stargazers

Watchers

Forkers

pirulax imring yukani macochet dekadence unnunu tacos-private-room forkerer majesticcoding cybersys spmn enterbrain temajm gtaresources2 geeede 0yueyunfei0 quarekt alehacksp franndzs izzotop jaapionl kin4stat flockws mrjohndev oops00 just-archives susshybaka frouk3 mahdi-mafia indirivacua gtkvba blackofworld westside56 kkpan11 sarvex riesi lmmloli gmh5225 himorik christianlutzcl sndrkrly vicenteicc2008 brenoteles afskyy simplyceo batnow94 unkcs user-grinch stalkersnowy ilyesmk2 lunarjournal brugarolas b00tkitism tempaccountnull plakapenka hestioyodierh rizky-prasetya crimsont bitsourcerer gtavcsa asdlei99 arnoclare ethannnnnn3ee24 bearts lioncat2002 codehams designthala q4a amyrahmady noneplayers cualquiercosa327 mazaha-ka elabyad247 theartemmaps shad0wxp ilkashpilkerman buridan1999 richard9902 codenulls nullptr03 cenobite-961 pablomodsx vladik01-11 elpicaroncl

gta-reversed-modern's Issues

Texture/Brightness bug

I'm not sure, but I think it started happening 1-2 weeks ago.
Unsure what causes it, in the video I've tired:

CWorld
Occluder stuff
2DFx
https://youtu.be/yqUIHJUqRWQ

Denise doesn't follow the player in "Burning Desire"

Faulty func: CPedIntelligence::FlushImmediately

ScanBigBuildingList - Crash

ScanBigBuildingList causes a crash because it tries to add to many entities to the render list using AddEntityToRenderList (which is where it actually crashes, because ms_nNoOfVisibleEntities is incremented to some absurdly high value).

Unhooking it fixes the problem.

Fix blip scaling in radar

Disabling CRadar::DrawRadarSprite will show difference.

Dancing/lowrider side-missions bug

Arrow icons disappear after ~10 seconds from start.

Crash at the end of "Tagging Up Turf"

Steps:

Unhook CWorld::SprayPaintWorld. (#109)
Spray all tags.
Game will crash before Sweet calls you back.

Faulty func: CWorld::ClearExcitingStuffFromArea

Occasional crashes

Post all random crashes here, using the bug report template.

Fireman disappearing from firetruck

Seems to happen only the first time they come out.
Unhooking CWorld::Process doesn't help.
Possible way to trace the issue may be to hook CWorld::Remove or CPopulation::RemovePed and see where it's called from.

Pool ped does not spawn in the Bar

Fix ProcessColModels

Turns out Dumper uses disks... And I haven't implemented disks. (upd: Izzotop: MonsterTruck and cranes uses too)
Also, there seems to be some collision bug when you stick the car to a wall.

Couldn't switch to fullscreen

I'm playing in windowed mode, but when I wanna switch to fullscreen by pressing alt+enter game is crashing.

Font is not centered

Incorrect then correct:

Faulty func: CFont::GetStringWidth

Breaking door

Sometimes when entering to interior or vice versa, the door breaks.

Location

CShinyTexts::Render

CTaskSimpleInAir::ProcessPed

Describe the bug
Incorrect fall animation.

To Reproduce
Steps to reproduce the behavior:

FindPlayerPed()->GetPosition() += { 0.0f, 0.0f, 2000.f };

Video

8mb.video-TEk-5y4O688s.mp4

Pool balls do not collide

Faulty func: CObject::SpecialEntityPreCollisionStuff_Reversed

Add better search functionality to Hooks tool

The original idea (Refer here for the final implementation):

Right now it's only possible to search by class name, but not by function name.
I propose the following format:

<namespace (class)>::<function name>
Just like in C++, it's possible to refer to the global namespace by typing :: (without anything before ::)
If there's no :: or there's nothing after it we just filter the namespace list

Eg.:

CWorld::Process - Should yield CWorld with all functions whose name starts with Process
::Process - All functions starting with Process
Process:: - All functions inside the Process class/namespace
Entity/:: - All functions inside the Entity category (Note the trailing / at the end - It is needed to differentiate between a class and category)
Entity/Ped:: - Similar to above, but only show functions inside the Entity/Ped category.
Entity:: - All functions inside the Entity class

For now this should be enough, in another PR fuzzy search could be added, to make stuff like:

World::Process -> Would display all classes which contain the word "Word" and have a function whose name contains Process

Game hangs in cutscenes

Can't play missions (duh) and start a new game.

Faulty func: CClothes::RebuildCutscenePlayer

Fix double con/destruction of classes with a c/dtor that isn't reversed

Describe the bug
Right now classes with a c/dtor that isn't reversed will be double con/destructed, because when our ctor is called we call the original ctor, and then compiler will con/destruct all members over again.

To Reproduce
CPed is a good example: It has no reversed dtor. If one would add it, and just plugin::Call the original one they would experience a crash (likely in CMatrixLink)

Expected behavior
All classes with an c/dtor that hasn't been reversed should get reversed.

Additional context
Fixing this may fix quite some random issues.

Fix constness of methods

Most notably:

CPlaceable (GetPosition, etc)
CMatrix
CTask's GetTaskType
... (add more)

Add RH_ScopedVirtualInstall

It should be similar to RH_ScopedInstall, but it should take the address of the _Reversed function instead.
Eg.: RH_ScopedVirtualInstall(GetTaskType, 0xdeadbeef) Should expand to something like InstallHook("ClassName", "GetTaskType", &GetTaskType_Reversed)

Adding this macro will get rid of the ugly _Reversed prefix in the GUI.

Rhino projectiles not working

https://www.youtube.com/watch?v=Fd897fF1q5g&feature=youtu.be

CI/CD wrong artifacts

Instead of our asi we get imgui.

Fix rendering issues

CRenderer::ScanSectorList - Problem with alpha on the road
CRenderer::ScanBigBuildingList - Loop seems to go-on forever, and crashes in AddMovingEntityPtr (because numVisibleEntityPtrs is too high)
CVisibilityPlugins. Produces bad render while only they hooked

Also maybe CRenderer::AddEntityToRenderList is wrong.

Try hook/unhook CRenderer::ScanBigBuildingList several time and bug will apear.

Images

Questions

I'm curious how long it might be before there is a standalone executable at the rate this project is moving? Further, once it does reach a complete state where it matches the original in function, would this project then start working on adding new features on top of the game? Like say optimizing it, fixing bugs, adding a few tweaks, and maybe custom textures and sounds to replace the original?

Crash around Unity Station

1-) Go to Unity Station
2-) CRASH!

stacktrace

Add `locked` option to ReversibleHooks

An option to "lock" hooks would be nice (that is, the hook's state can't be changed from the GUI).
Would be very useful in situations like #220 where we want to install hooks which always unhooked.

Refactor table in CTaskSimplePlayerOnFoot::PlayIdleAnimations

thats a 2D table, hence the multiply by 2.

constexpr struct {AnimationId animId; AssocGroupId assoc; } translation[] = {...};

(originally it was prob uint32[2][]

I'd recommend you use the struct method for clarity.

Also, the table seems to start at a lower address than IDA thinks (because 2 * 0 - 1 = -1).

Originally posted by @Pirulax in https://github.com/Updated-Classic/gta-reversed-modern/pull/29#discussion_r699641175

Game crashes while spraying

Faulty func: CWorld::SprayPaintWorld

CClouds::MovingFogRender

Turn on foggy weather through debug menu. There should be no fog in the interiors.

Phone still rings while using a jetpack

Describe the bug
Game still rings the phone for a frame-perfect time then dismiss while using a jetpack. Phone shouldn't ring at the first place.

To Reproduce
Steps to reproduce the behavior:

Load the save I uploaded below.
Get outside and enter the jetpack.
Wait for the phone ring, this is the bug.

Additional context

(took a while to catch the perfect frame 😄)

GTASAsf7.zip

Sandbag physics broken

2022-02-05.20-01-48.mp4

Faulty func: CPhysical::??? (also punching bags after unhooked ApplyForce crashes the game)

Fix `ProcessEntityCollision` not overridden in some classes

Describe the bug
There are a few classes that originally overwrote ProcessEntityCollision, yet we don't (which causes issues).
I've fixed CAutomobile in 11ed5a7, but there are still a few classes that don't override it. (CTrailer, CBoat, etc)

To Reproduce
See original VTables

World rendered weird on races

"Little loop":

and sometimes the weirdness remains

Can't even load the mission "High Stakes, Low Rider"

Can't burn weeds in "Are You Going to San Fierro?"

Starting `Initial 2` mission crashes the game

Describe the bug
Starting Initial 2 mission crashes the game

To Reproduce

Start the Initial 2 mission

Screenshots

Additional context
Crashes in CCarGenerator, this is always 0xE27AB0 (Which causes a write access violation)

Leaving the gym will lead to failure

The CStreaming::DeleteRwObjectsInSectorList crashes because entity is nullptr.

Stingers don't work

Faulty func: CDamageManager::GetWheelStatus

2022-02-03.22-49-29.mp4

Unlock master branch

Here's a list of stuff we gotta fix:

HooksModule: Entering "\:" then deleting ":" will cause an assert

This isn't really the issue of HooksModule, it's just where it "comes out".
It's SplitStringView being garbage (Sadly only C++23 has the required stuff that we'd need to get rid of this function).
Using tne range-constructor of string_view (c++23) it works fine, so I'll probably do that.
Until then, don't enter such strings :D

Edit:
Actually, the fix would be this I think:

if (&*rng.begin() != str.end()) {
    return std::string_view(&*rng.begin(), std::ranges::distance(rng));
} else {
    return "";
}

Use `floor` in CRadar::DrawRadarSprite

Let's use floor, otherwise the compiler will complain:

    float width = std::floor(SCREEN_WIDTH_UNIT * 8.f);
    float height = std::floor(SCREEN_HEIGHT_UNIT * 8.f);

Originally posted by @Pirulax in https://github.com/Updated-Classic/gta-reversed-modern/pull/93#discussion_r790186207

Refactor C arrays to `std::array` wherever possible

It would be really useful, because std::array has bound checking in debug mode, and it would help us in debugging a lot.
It has the same memory layout as a C-style array, so they're interchangeable.

Missing stubs for classes

Car door stuff

CTaskSimpleCarGoToPointNearDoorUntilDoorNotInUse
CTaskComplexOpenDriverDoor
CTaskComplexOpenPassengerDoor

Seek Pos Calculator's

CEntitySeekPosCalculatorDriving
CEntitySeekPosCalculatorEntitySurface
CEntitySeekPosCalculatorVehicleId
CTaskComplexSeekEntityAiming

Simple Interior Tasks

CTaskSimpleCar...

CTaskSimpleCarOpenLockedDoorFromOutside
CTaskSimpleCarSetPedSlowDraggedOut
CTaskSimpleCarShuffle
CTaskSimpleCarSlowBeDraggedOut

HurtPedWithCar

CTaskSimpleHurtPedWithCar
CTaskSimpleKillPedWithCar
CTaskComplexHitPedWithCar

Simple Tasks

CTaskSimpleDuckToggle - Script
CTaskSimpleFinishBrain - Script
CTaskSimpleOnEscalator
CTaskSimpleSetCharIgnoreWeaponRangeFlag
CTaskSimpleSetKindaStayInSamePlace
CTaskSimpleWaitUntilLeaderAreaCodesMatch

CTaskComplexKill...

CTaskComplexKillCriminal

CTaskComplexFollow...

CTaskComplexFollowLeaderAnyMeans
CTaskComplexFollowPatrolRoute

CTaskComplexEnterCar...

CTaskComplexEnterCarAsDriverTimed
CTaskComplexEnterCarAsPassengerTimed

Complex Tasks

CTaskComplexFallToDeath
CTaskComplexWalkAlongsidePed
CTaskComplexEvasiveDiveAndGetUp

CTaskComplexUseClosestFreeScriptedAttractor...

CTaskComplexUseClosestFreeScriptedAttractor
CTaskComplexUseClosestFreeScriptedAttractorRun
CTaskComplexUseClosestFreeScriptedAttractorSprint

CTaskComplexUseEffect... (Needed for CTaskComplexUseClosestFreeScriptedAttractor)

CTaskComplexUseEffect
CTaskComplexUseEffectRunning
CTaskComplexUseEffectSprinting

Unused

CTaskComplexFollowNodeRouteShooting
CTaskComplexFallAndStayDown
CTaskComplexExtinguishFireOnFoot
CTaskSimpleRunAnimLoopedMiddle
CTaskSimpleBeHitWhileMoving
CTaskSimpleChat
CTaskSimpleDuckWhileShotsWhizzing
CTaskComplexGoToPointUntilCollisionAndStandStill
CTaskComplexKillAllThreats
CTaskComplexUseAttractorPartner
CTaskComplexPresentIDToCop
CTaskComplexReactToAttack
CTaskSimpleHailTaxi
CTaskSimpleHailTaxiAndPause
CTaskComplexUseEntryExit
CTaskSimpleWaitForPizza
CTaskSimpleTriggerEvent

CTaskComplexUseAttractor

CTaskComplexUsePairedAttractor

Fix CClouds::MovingFogRender

Issue

How it looks like

How it should look like

Reproduce
Turn on foggy weather through debug menu.
Make sure CClouds::MovingFogRender is hooked.

Dumbells/barbells does not render correctly

2022-01-23.22-15-11.mp4

Peds stuck in the road, and air

Describe the bug
See screenshot.

To Reproduce
Walk around

Screenshots

Additional context
Most likely introduced by e898575

Gas pumps don't explode correctly

All of them should've been exploded.

Faulty func: CExplosion::AddExplosion

Can't spray tags

2022-01-27.00-28-51.mp4

Faulty func: CWorld::SprayPaintWorld

Task pool gets full, makes game crash

Describe the bug
The task pool (eg.: CPool) is full after some chasing by cops. Now, I'm not sure if it's because I was in a Rhino, but I'm pretty sure the vanilla game doesnt crash even when youre chased by the police in a Rhino.
From the video you can see I crash when there's a lot of stuff going on around me. I guess that's related as well.

To Reproduce

Take Rhino (I don't even think you need a vehicle)
Make yourself Wanted thru the cheat debug menu
Start running from them
Crash

Expected behavior
To not crash xddd

Screenshots
I'll post a video

Additional context
We probably have a mem leak somewhere. Good start would be the task manager/CPedIntel
dmp here

Merge these branches

Untested:

Tested: