mirror of
https://github.com/GTAmodding/re3.git
synced 2024-11-30 05:45:40 +00:00
f1bb09826d
# Conflicts: # gamefiles/TEXT/american.gxt # premake5.lua # src/audio/MusicManager.cpp # src/control/Darkel.cpp # src/control/Script.cpp # src/core/FileLoader.cpp # src/core/Frontend.cpp # src/core/Game.cpp # src/core/Streaming.cpp # src/core/config.h # src/core/re3.cpp # src/extras/frontendoption.cpp # src/extras/frontendoption.h # src/render/Hud.cpp # src/skel/glfw/glfw.cpp # src/vehicles/CarGen.cpp # src/vehicles/Vehicle.cpp # src/weapons/WeaponInfo.cpp # utils/gxt/american.txt
46 lines
3.3 KiB
Markdown
46 lines
3.3 KiB
Markdown
# re3
|
|
[](https://ci.appveyor.com/project/aap/re3/branch/master)
|
|
<a href="https://discord.gg/jYpXxTm"><img src="https://img.shields.io/badge/discord-join-7289DA.svg?logo=discord&longCache=true&style=flat" /></a>
|
|
| Platform | Debug | Release |
|
|
|------------------|-------------|-------------|
|
|
| Windows Direct3D9 | [](https://bintray.com/gtamodding/revc/Debug_win-x86-librw_d3d9-mss/_latestVersion) | [](https://bintray.com/gtamodding/revc/Release_win-x86-librw_d3d9-mss/_latestVersion) |
|
|
| Windows OpenGL3.3 | [](https://bintray.com/gtamodding/revc/Debug_win-x86-librw_gl3_glfw-mss/_latestVersion) | [](https://bintray.com/gtamodding/revc/Release_win-x86-librw_gl3_glfw-mss/_latestVersion) |
|
|
|
|
## Intro
|
|
|
|
The aim of this project is to reverse GTA III for PC by replacing
|
|
parts of the game [one by one](https://en.wikipedia.org/wiki/Ship_of_Theseus)
|
|
such that we have a working game at all times.
|
|
|
|
## How can I try it?
|
|
|
|
- re3 requires 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 it from one of the above links (Debug or Release).
|
|
- (Optional) If you want to use optional features like Russian language or menu map, copy the files in /gamefiles folder to your game root folder.
|
|
- Move re3.exe to GTA 3 directory and run it.
|
|
|
|
## Preparing the environment for building
|
|
|
|
- Clone the repo using the argument `--recursive`.
|
|
- Point GTA_III_RE_DIR environment variable to GTA3 root folder.
|
|
- Run premake
|
|
- On Windows: one of the `premake-vsXXXX.cmd` variants on root folder
|
|
- On Linux: proceed to [Building on Linux](https://github.com/GTAmodding/re3/wiki/Building-on-Linux).
|
|
- There are various settings at the very bottom of [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.
|
|
- **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)
|
|
|
|
|
|
> :information_source: **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).
|
|
|
|
> :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.
|
|
|
|
## Contributing
|
|
Please read the [Coding Style](https://github.com/GTAmodding/re3/blob/master/CODING_STYLE.md) Document
|
|
|
|
### Unreversed / incomplete classes (at least the ones we know)
|
|
The following classes have only unused or practically unused code left:
|
|
```
|
|
CCullZone - only mobile stuff
|
|
CCullZones - only mobile stuff
|
|
```
|
|
|