search

gta-reversed / gta-reversed-modern

Reimplementation of GTA:SA 1.0 US
534 stars 92 forks source link
bug-fix bug-fixing grandtheftauto gtasa modern-cpp mtasa multitheftauto plugin-sdk source-code windows

readme

gtasa-reversed Build Status

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

Community

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

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 time estimate on when it'll be finished.

Coding Guidelines

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

Build Instructions

0. Requirements/Prerequisites

1. Initialize/Update submodules

First clone the project, including the submodules:

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

Or if already cloned:

git submodule update --init --recursive

2. Generate solution using Premake5

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

Generate solution using CMake

The CMake build is currently not supported, and is used only for the CI. The DLLs it produces do not work.

Game

  1. GTA SA Compact exe: Our code requires you to use this exe, otherwise you will experience random crashes.

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

    You can download them in a single archive.

Other plugins

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

Debugging

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

In case that doesn't suit your needs, use the ReAttach plugin to make your life easier.

What to work on?

Check out this discussion for some inspiration ;)

Credits