2020-12-26 17:06:22 +08:00
< img src = "https://github.com/GTAmodding/re3/blob/master/logo.png?raw=true" alt = "re3 logo" width = "200" >
2020-12-09 01:46:18 +08:00
[](https://actions-badge.atrox.dev/GTAmodding/re3/goto?ref=master)
2020-12-03 23:48:04 +08:00
< a href = "https://discord.gg/aKYAwCx92H" > < img src = "https://img.shields.io/badge/discord-join-7289DA.svg?logo=discord&longCache=true&style=flat" / > < / a >
2019-11-07 06:53:54 +08:00
## Intro
2019-05-15 22:52:37 +08:00
2021-02-12 03:51:13 +08:00
In this repository you'll find the fully reversed source code for GTA III ([master](tree/master) branch) and GTA VC ([miami](tree/miami) branch).
2019-05-15 22:52:37 +08:00
2021-02-12 03:51:13 +08:00
It has been tested and works on Windows, Linux and FreeBSD, on x86, amd64, arm and arm64.\
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 17:12:42 +08:00
2021-02-12 03:51:13 +08: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-07 06:53:54 +08:00
2021-02-12 03:51:13 +08:00
## Installation
2021-01-29 06:04:44 +08:00
2021-02-12 03:51:13 +08: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/ ).
- Build re3 or download the latest nightly build:
- [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 )
- [Linux 64bit ](https://nightly.link/GTAmodding/re3/workflows/build-cmake-conan/master/ubuntu-latest-gl3.zip )
- [MacOS 64bit ](https://nightly.link/GTAmodding/re3/workflows/build-cmake-conan/master/macos-latest-gl3.zip )
- Copy the files from the `gamefiles` directory to your game root directory. (This is not strictly necessary but very much recommended)
- Move re3 executable to GTA 3 directory and run it.
2021-01-29 06:14:27 +08:00
2021-02-12 03:51:13 +08: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
* Xinput controller support (Windows)
* 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
* 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
* compare Codewarrior build with original binary for more accurate code (very tedious)
## 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-29 06:04:44 +08:00
2021-01-13 10:05:19 +08:00
## Building from Source
2021-02-03 21:33:16 +08:00
When using premake, you may want to point GTA_III_RE_DIR environment variable to GTA3 root folder, if you want executable to be moved there via post-build script.
2021-01-13 09:35:05 +08:00
< details > < summary > Linux Premake< / summary >
2021-01-13 09:38:50 +08:00
For Linux using premake, proceed: [Building on Linux ](https://github.com/GTAmodding/re3/wiki/Building-on-Linux )
2021-01-13 09:35:05 +08:00
< / details >
< details > < summary > Linux Conan< / summary >
2021-01-13 09:39:53 +08:00
Obtain source code.
2021-01-13 09:35:05 +08:00
```
git clone https://github.com/GTAmodding/re3.git
cd re3
git submodule init
git submodule update --recursive
```
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-15 01:00:22 +08:00
conan build .. -if build -bf build -pf package
2021-01-13 09:35:05 +08:00
```
< / details >
< details > < summary > FreeBSD< / summary >
2021-01-13 09:38:50 +08:00
For FreeBSD using premake, proceed: [Building on FreeBSD ](https://github.com/GTAmodding/re3/wiki/Building-on-FreeBSD )
2021-01-13 09:35:05 +08:00
< / details >
< details > < summary > Windows< / summary >
2021-01-13 09:38:50 +08:00
2021-01-13 10:05:19 +08:00
Assuming you have Visual Studio:
- Clone the repo using the argument `--recursive` .
- Run one of the `premake-vsXXXX.cmd` variants on root folder.
- Open the project via Visual Studio
2020-11-27 05:37:09 +08:00
**If you use 64-bit D3D9**: We don't ship 64-bit Dx9 SDK. You need to download it from Microsoft if you don't have it(although it should come pre-installed after some Windows version)
2021-01-13 09:35:05 +08: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 20:20:52 +08:00
2021-02-03 21:33:16 +08:00
> :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. i.e. FIX_BUGS define fixes the bugs we've come across.
2019-05-23 05:12:07 +08:00
2020-07-22 20:20:52 +08:00
> :information_source: **Did you notice librw?** 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-30 06:47:33 +08:00
2020-04-17 23:30:59 +08:00
## Contributing
2021-02-12 03:51:13 +08: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 22:52:37 +08:00
2021-02-12 03:51:13 +08:00
Do not use features from C++11 or later.
2021-02-13 04:52:33 +08: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 21:59:36 +08:00
After a bit of work the project lay dormant for about a year
2021-02-13 04:52:33 +08:00
and was picked up again and pushed to github in May 2019.
2021-02-13 21:59:36 +08:00
At the time I (aap) had reversed around 10k lines of code and estimated
2021-02-13 04:52:33 +08:00
the final game to have around 200-250k.
Others quickly joined the effort and we made very quick progress
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 21:59:36 +08:00
everybody had a lot of time to work on re3 again and
2021-02-13 04:52:33 +08:00
we finally got a standalone exe in April 2020 (around 180k lines by then).
After the initial excitement and fixing and polishing the code more
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.
Since then we have started LCS, which is currently work in progress.
2021-02-12 03:51:13 +08:00
## License
2020-04-07 22:48:49 +08:00
2021-02-13 04:08:38 +08: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 21:59:36 +08:00
Please keep derivate work open source and give proper credit.
