re3/README.md

reVC

Intro

The aim of this project is to reverse GTA Vice City for PC.

How can I try it?

• reVC requires game assets to work, so you must own a copy of GTA Vice City.
• Build reVC or download it from one of the above links (Debug or Release).
• (Optional) If you want to use optional features, copy the files in /gamefiles folder to your game root folder.
• Move reVC.exe to GTA VC directory and run it.

Latest standalone executables to download

(Put content of selected archive into gamedir)

• Windows D3D9 MSS 32bit
• Windows D3D9 64bit
• Windows OpenGL 64bit
• Linux 64bit
• MacOS 64bit

Building from Source

When using premake, you may want to point GTA_VC_RE_DIR environment variable to GTA Vice City root folder, if you want executable to be moved there via post-build script.

Linux Premake

For Linux using premake, proceed: Building on Linux

Linux Conan

Obtain source code.

git clone https://github.com/GTAmodding/re3.git reVC -b miami
cd reVC
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 .. reVC/master@ -if build -o reVC:audio=openal -o librw:platform=gl3 -o librw:gl3_gfxlib=glfw --build missing -s reVC:build_type=RelWithDebInfo -s librw:build_type=RelWithDebInfo
conan build .. -if build -bf build -pf package

FreeBSD

For FreeBSD using premake, proceed: Building on FreeBSD

Windows

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

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)

If you choose OpenAL on Windows You must read Running OpenAL build on Windows.

ℹ️ There are various settings in config.h, you may want to take a look there. i.e. FIX_BUGS define fixes the bugs we've come across.

ℹ️ Did you notice librw? reVC uses completely homebrew RenderWare-replacement rendering engine; 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 Document

Unreversed / incomplete classes

PS2/Mobile stuff:

src/core/Pad.cpp
src/core/main.cpp
src/core/Frontend_PS2.cpp
src/core/FrontEndControls.cpp
src/save/MemoryCard.cpp