Repository files navigation

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

Please join our community Discord:GTA Groupies [The invite is permanent, feel free to share it!]

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.

The progress of reversed classes can be trackedhere. (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 time estimate on when it'll be finished.

• LatestVisual Studio 2022
• Python >= 3.x (For Conan)
• Conan (>= 2.x)
• CMake

• Install thelatest Python [When installing make sure to tick the "Add to PATH" checkbox!]
• Install Conan usingpip install conan [You might need to reload the console if you've freshly installed Python.]
• If you are installing Conan for the first time, also runconan profile detect

0. Run the setup script withpython setup.py. Use--help for more info.
1. Open the generated VS solution atbuild/GTASA.sln, alternatively you can open the root folder with VS's native CMake integration but it isn't as good as the generated sln solution as for now.
2. You can also typecmake --build build to build in command line.

0. GTA SACompact exe: Our code requires you to use this exe, otherwise you will experience random crashes.You must own the original game and assets for this to work.

1. To install all the necessary files (after building the project!), runcontrib/install.py withadministrator privileges [Necessary to create symlinks on Windows] in the root directory.Alternatively, you can install them by yourself:

   • ASI Loader
   • Mouse Fix (dinput8.dll) [Can be found in the zip in thecontrib folder]

   You can download them in a singlearchive.

Using other (than the ones we've tested) plugins is strongly discouraged and we provideno support.

Before you start writing code, please make sure to read thecoding guidelines for this project. Consider these points before opening a PR:

• Follow the coding guidelines, it exists for a reason.
• Try to focus your changes onto single subject, do not create PRs that cover many things at once. This is because it's hard to properly test and review such PRs.
• If you intend to add non-vanilla features please first consult with us, so you don't waste your time.

Check outthis discussion for some inspiration ;)

0. Make sure the latest DLL is in thescripts folder of your GTASA installation - Skip this step if you've usedcontrib/install.py (As it uses symlinks!)
1. Launch the game
2. Attach using theReAttach plugin to make your life easier

• All contributors of theplugin-sdk project.
• All contributors of theoriginal project.
• Hundreds of great people ongtaforums.com.
• re3 team.
• And everyone who contributed to GTA:SA reversing.