2020-12-26 09:06:22 +00:00
< img src = "https://github.com/GTAmodding/re3/blob/master/logo.png?raw=true" alt = "re3 logo" width = "200" >
2020-12-08 17:46:18 +00:00
[](https://actions-badge.atrox.dev/GTAmodding/re3/goto?ref=master)
2021-06-25 13:22:20 +00:00
< a href = "https://discord.gg/RFNbjsUMGg" > < img src = "https://img.shields.io/badge/discord-join-7289DA.svg?logo=discord&longCache=true&style=flat" / > < / a >
2019-11-06 22:53:54 +00:00
## Intro
2019-05-15 14:52:37 +00:00
2021-02-14 01:35:29 +00:00
In this repository you'll find the fully reversed source code for GTA III ([master](https://github.com/GTAmodding/re3/tree/master/) branch) and GTA VC ([miami](https://github.com/GTAmodding/re3/tree/miami/) branch).
2019-05-15 14:52:37 +00:00
2021-07-03 13:34:55 +00:00
It has been tested and works on Windows, Linux, MacOS and FreeBSD, on x86, amd64, arm and arm64.\
2021-02-11 19:51:13 +00:00
Rendering is handled either by original RenderWare (D3D8)
or the reimplementation [librw ](https://github.com/aap/librw ) (D3D9, OpenGL 2.1 or above, OpenGL ES 2.0 or above).\
Audio is done with MSS (using dlls from original GTA) or OpenAL.
2019-06-13 09:12:42 +00:00
2021-02-11 19:51:13 +00:00
The project has also been ported to the [Nintendo Switch ](https://github.com/AGraber/re3-nx/ ),
[Playstation Vita ](https://github.com/Rinnegatamante/re3 ) and
[Nintendo Wii U ](https://github.com/GaryOderNichts/re3-wiiu/ ).
We cannot build for PS2 or Xbox yet. If you're interested in doing so, get in touch with us.
2019-11-06 22:53:54 +00:00
2021-02-11 19:51:13 +00:00
## Installation
2021-01-28 22:04:44 +00:00
2021-02-11 19:51:13 +00:00
- re3 requires PC game assets to work, so you **must** own [a copy of GTA III ](https://store.steampowered.com/app/12100/Grand_Theft_Auto_III/ ).
2021-02-19 17:21:04 +00:00
- Build re3 or download the latest build:
2021-02-11 19:51:13 +00:00
- [Windows D3D9 MSS 32bit ](https://nightly.link/GTAmodding/re3/workflows/re3_msvc_x86/master/re3_Release_win-x86-librw_d3d9-mss.zip )
- [Windows D3D9 64bit ](https://nightly.link/GTAmodding/re3/workflows/re3_msvc_amd64/master/re3_Release_win-amd64-librw_d3d9-oal.zip )
- [Windows OpenGL 64bit ](https://nightly.link/GTAmodding/re3/workflows/re3_msvc_amd64/master/re3_Release_win-amd64-librw_gl3_glfw-oal.zip )
2021-06-26 15:11:29 +00:00
- [Linux 64bit ](https://nightly.link/GTAmodding/re3/workflows/build-cmake-conan/master/ubuntu-18.04-gl3.zip )
2021-07-03 13:34:55 +00:00
- [MacOS 64bit x86-64 ](https://nightly.link/GTAmodding/re3/workflows/build-cmake-conan/master/macos-latest-gl3.zip )
2021-02-14 01:35:29 +00:00
- Extract the downloaded zip over your GTA 3 directory and run re3. The zip includes the gamefiles and in case of OpenAL the required dlls.
2021-01-28 22:14:27 +00:00
2021-02-11 19:51:13 +00:00
## Screenshots
## Improvements
We have implemented a number of changes and improvements to the original game.
They can be configured in `core/config.h` .
Some of them can be toggled at runtime, some cannot.
* Fixed a lot of smaller and bigger bugs
* User files (saves and settings) stored in GTA root directory
* Settings stored in re3.ini file instead of gta3.set
* Debug menu to do and change various things (Ctrl-M to open)
* Debug camera (Ctrl-B to toggle)
* Rotatable camera
2021-02-14 21:58:42 +00:00
* XInput controller support (Windows)
2021-02-11 19:51:13 +00:00
* No loading screens between islands ("map memory usage" in menu)
* Skinned ped support (models from Xbox or Mobile)
* Rendering
* Widescreen support (properly scaled HUD, Menu and FOV)
* PS2 MatFX (vehicle reflections)
* PS2 alpha test (better rendering of transparency)
* PS2 particles
* Xbox vehicle rendering
* Xbox world lightmap rendering (needs Xbox map)
* Xbox ped rim light
* Xbox screen rain droplets
* More customizable colourfilter
* Menu
* Map
* More options
* Controller configuration menu
* ...
* Can load DFFs and TXDs from other platforms, possibly with a performance penalty
* ...
## To-Do
The following things would be nice to have/do:
* Fix physics for high FPS
2021-02-14 08:48:35 +00:00
* Improve performance on lower end devices, especially the OpenGL layer on the Raspberry Pi (if you have experience with this, please get in touch)
2021-02-11 19:51:13 +00:00
* Compare code with PS2 code (tedious, no good decompiler)
* [PS2 port ](https://github.com/GTAmodding/re3/wiki/PS2-port )
* Xbox port (not quite as important)
* reverse remaining unused/debug functions
2021-02-14 21:58:42 +00:00
* compare CodeWarrior build with original binary for more accurate code (very tedious)
2021-02-11 19:51:13 +00:00
## Modding
Asset modifications (models, texture, handling, script, ...) should work the same way as with original GTA for the most part.
Mods that make changes to the code (dll/asi, CLEO, limit adjusters) will *not* work.
Some things these mods do are already implemented in re3 (much of SkyGFX, GInput, SilentPatch, Widescreen fix),
others can easily be achieved (increasing limis, see `config.h` ),
others will simply have to be rewritten and integrated into the code directly.
Sorry for the inconvenience.
2021-01-28 22:04:44 +00:00
2021-01-13 02:05:19 +00:00
## Building from Source
2021-02-14 02:01:44 +00:00
When using premake, you may want to point GTA_III_RE_DIR environment variable to GTA3 root folder if you want the executable to be moved there via post-build script.
2021-02-14 01:35:29 +00:00
Clone the repository with `git clone --recursive https://github.com/GTAmodding/re3.git` . Then `cd re3` into the cloned repository.
2021-01-13 01:35:05 +00:00
< details > < summary > Linux Premake< / summary >
2021-01-13 01:38:50 +00:00
For Linux using premake, proceed: [Building on Linux ](https://github.com/GTAmodding/re3/wiki/Building-on-Linux )
2021-01-13 01:35:05 +00:00
< / details >
< details > < summary > Linux Conan< / summary >
Install python and conan, and then run build.
```
conan export vendor/librw librw/master@
mkdir build
cd build
conan install .. re3/master@ -if build -o re3:audio=openal -o librw:platform=gl3 -o librw:gl3_gfxlib=glfw --build missing -s re3:build_type=RelWithDebInfo -s librw:build_type=RelWithDebInfo
2021-01-14 17:00:22 +00:00
conan build .. -if build -bf build -pf package
2021-01-13 01:35:05 +00:00
```
< / details >
2021-07-03 13:34:55 +00:00
< details > < summary > MacOS Premake< / summary >
For MacOS using premake, proceed: [Building on MacOS ](https://github.com/GTAmodding/re3/wiki/Building-on-MacOS )
< / details >
2021-01-13 01:35:05 +00:00
< details > < summary > FreeBSD< / summary >
2021-01-13 01:38:50 +00:00
For FreeBSD using premake, proceed: [Building on FreeBSD ](https://github.com/GTAmodding/re3/wiki/Building-on-FreeBSD )
2021-01-13 01:35:05 +00:00
< / details >
< details > < summary > Windows< / summary >
2021-01-13 01:38:50 +00:00
2021-02-14 01:35:29 +00:00
Assuming you have Visual Studio 2015/2017/2019:
2021-01-13 02:05:19 +00:00
- Run one of the `premake-vsXXXX.cmd` variants on root folder.
2021-02-14 02:09:22 +00:00
- Open build/re3.sln with Visual Studio and compile the solution.
2021-02-14 01:35:29 +00:00
Microsoft recently discontinued its downloads of the DX9 SDK. You can download an archived version here: https://archive.org/details/dxsdk_jun10
2020-11-26 21:37:09 +00:00
2021-01-13 01:35:05 +00:00
**If you choose OpenAL on Windows** You must read [Running OpenAL build on Windows ](https://github.com/GTAmodding/re3/wiki/Running-OpenAL-build-on-Windows ).
< / details >
2020-07-22 12:20:52 +00:00
2021-02-14 01:35:29 +00:00
> :information_source: premake has an `--lto` option if you want the project to be compiled with Link Time Optimization.
> :information_source: There are various settings in [config.h](https://github.com/GTAmodding/re3/tree/master/src/core/config.h), you may want to take a look there.
> :information_source: re3 uses completely homebrew RenderWare-replacement rendering engine; [librw](https://github.com/aap/librw/). librw comes as submodule of re3, but you also can use LIBRW enviorenment variable to specify path to your own librw.
2019-05-22 21:12:07 +00:00
2021-02-14 21:58:42 +00:00
If you feel the need, you can also use CodeWarrior 7 to compile re3 using the supplied codewarrior/re3.mcp project - this requires the original RW33 libraries, and the DX8 SDK. The build is unstable compared to the MSVC builds though, and is mostly meant to serve as a reference.
2019-05-29 22:47:33 +00:00
2020-04-17 15:30:59 +00:00
## Contributing
2021-02-16 13:49:42 +00:00
As long as it's not linux/cross-platform skeleton/compatibility layer, all of the code on the repo that's not behind a preprocessor condition(like FIX_BUGS) are **completely** reversed code from original binaries.
We **don't** accept custom codes, as long as it's not wrapped via preprocessor conditions, or it's linux/cross-platform skeleton/compatibility layer.
We accept only these kinds of PRs;
- A new feature that exists in at least one of the GTAs (if it wasn't in III/VC then it doesn't have to be decompilation)
- Game, UI or UX bug fixes (if it's a fix to original code, it should be behind FIX_BUGS)
- Platform-specific and/or unused code that's not been reversed yet
- Makes reversed code more understandable/accurate, as in "which code would produce this assembly".
- A new cross-platform skeleton/compatibility layer, or improvements to them
- Translation fixes, for languages original game supported
- Code that increase maintainability
2021-02-11 19:51:13 +00:00
We have a [Coding Style ](https://github.com/GTAmodding/re3/blob/master/CODING_STYLE.md ) document that isn't followed or enforced very well.
2019-05-15 14:52:37 +00:00
2021-02-11 19:51:13 +00:00
Do not use features from C++11 or later.
2021-02-12 20:52:33 +00:00
## History
re3 was started sometime in the spring of 2018,
initially as a way to test reversed collision and physics code
inside the game.
This was done by replacing single functions of the game
with their reversed counterparts using a dll.
2021-02-13 13:59:36 +00:00
After a bit of work the project lay dormant for about a year
2021-02-12 20:52:33 +00:00
and was picked up again and pushed to github in May 2019.
2021-02-13 13:59:36 +00:00
At the time I (aap) had reversed around 10k lines of code and estimated
2021-02-12 20:52:33 +00:00
the final game to have around 200-250k.
2021-02-14 21:58:42 +00:00
Others quickly joined the effort (Fire_Head, shfil, erorcun and Nick007J
in time order, and Serge a bit later) and we made very quick progress
2021-02-12 20:52:33 +00:00
throughout the summer of 2019
after which the pace slowed down a bit.
Due to everyone staying home during the start of the Corona pandemic
2021-02-13 13:59:36 +00:00
everybody had a lot of time to work on re3 again and
2021-02-12 20:52:33 +00:00
we finally got a standalone exe in April 2020 (around 180k lines by then).
2021-02-13 16:16:51 +00:00
After the initial excitement and fixing and polishing the code further,
2021-02-12 20:52:33 +00:00
reVC was started in early May 2020 by starting from re3 code,
not by starting from scratch replacing functions with a dll.
After a few months of mostly steady progress we considered reVC
finished in December.
2021-02-13 16:16:51 +00:00
Since then we have started reLCS, which is currently work in progress.
2021-02-12 20:52:33 +00:00
2021-02-11 19:51:13 +00:00
## License
2020-04-07 14:48:49 +00:00
2021-02-12 20:08:38 +00:00
We don't feel like we're in a position to give this code a license.\
The code should only be used for educational, documentation and modding purposes.\
We do not encourage piracy or commercial use.\
2021-02-13 13:59:36 +00:00
Please keep derivate work open source and give proper credit.
