reVC-Improved

Languages: [English] | 中文 (Chinese)

Introduction

This repository makes the following changes to the original re3 repository:

• Removed canon build
• Added nix flake build and packaging
• Fixed workflows to make them work properly

For easy installation and running on NixOS, a Nix wrapper has been written in re3-flake.

The wrapper can automatically configure re3, reVC, reLCS, but you still need the original game files. By default, it uses Steam's default installation path to find the original game files (except for reLCS).

Compared to other branches, the reVC branch has made more changes:

• Built-in Chinese support
• Added related tools for unpacking, translating, and packing text
• Added tool for automatically generating character tables
• Added tool for generating Chinese font texture maps based on character tables and custom fonts
• Support for rendering Emoji
• Enabled Japanese and Polish settings options, but not yet fully implemented
• Modified the poster when exiting
• Fix some bugs
  • Wrong cursor position when use functional scale multiplier in wayland
  • Can't delete save file in Linux
• Some new features
  • Save game in pause menu
  • Save game after mission complete in standalone slot
  • Press F10 to turn on/off framerate limiter
  • Reduce the sensitivity in first person view. The multiplier can be adjusted in settings.
  • After picking up the phone. press pick-up key again to skip it
• Some improvments
  • Unified vertical and horizontal sensitivity
  • Increase follow speed of free cam

Can't save game in mission or vehicle. Auto save will start after Tommy leave the vehicle.

This branch modified the script of game. Can't load original save!

The following tools/code were used during game modification, thanks to:

• Chinese text is based on the Unnamed Chinese patch (WMHHZ) 1.0 official version, modified, adapted and supplemented
• Chinese text rendering code comes from Ova1122/Revc_Chs
• Chinese mapping table generator dat_generator referred to the code of Unnamed Chinese group WMHHZ/VC.SA.Plugin
• GXT file packing and unpacking tools used modules from Lzh102938/III.VC.SAGXTExtracter
• Used Magic.TXD when packing Chinese character png files into txd files
• Used pillow and pilmoji modules to render Chinese character png files
• Used wqy-zenhei and tegaki_zatsu_normal as Chinese fonts. May be changed later.

Subsequent modifications will continue to focus on the miami branch.

Installation

For non-NixOS systems

Prepare the original game files, then find the required version archive in Actions, and copy all files to the original game folder.

For NixOS and other systems using Nix package manager

Refer to re3-flake for installation, binaries have been uploaded to Nix Cache.

Mods

Current compatibility is the same as the original reVC, may consider extending the script system in the future.

Building from Source

Building with Nix Flakes is recommended. Wiki links need to be accessed through the Internet Archive.

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

Clone the repository with git clone --recursive -b miami https://github.com/GTAmodding/re3.git reVC. Then cd reVC into the cloned repository.

Linux

1. Ensure you have the required dependencies installed
2. Run premake to generate build files:

   ./premake5Linux --with-librw gmake2

3. Build the project (choose one):

   cd build
   make -j5 config=debug_linux-amd64-librw_gl3_glfw-oal     # Debug build
   make -j5 config=release_linux-amd64-librw_gl3_glfw-oal   # Release build

For detailed setup instructions, see: Building on Linux

macOS

1. Ensure you have the required dependencies installed
2. Run premake to generate build files:

   premake5 --with-librw gmake2

3. Build the project (choose one):

   cd build
   make -j5 config=debug_macosx-amd64-librw_gl3_glfw-oal     # Debug build
   make -j5 config=release_macosx-amd64-librw_gl3_glfw-oal   # Release build

For detailed setup instructions, see: Building on macOS

Nix/NixOS

reVC provides a flake.nix for building with Nix. You have two options:

Option 1: Build in a development shell:

nix flake update  # Update flake inputs if needed
nix develop       # Enter development shell with all dependencies
# Then run the build commands as described in Linux section above

Option 2: Build directly with Nix flakes:

nix build .#re3-vc       # Build GTA Vice City (miami branch)

The built binaries will be in ./result/bin/

Quick Build Reference

Linux Debug:

./premake5Linux --with-librw gmake2 && cd build && make -j5 config=debug_linux-amd64-librw_gl3_glfw-oal verbose=1

Linux Release:

./premake5Linux --with-librw gmake2 && cd build && make -j5 config=release_linux-amd64-librw_gl3_glfw-oal verbose=1

macOS Debug:

premake5 --with-librw gmake2 && cd build && make -j5 config=debug_macosx-amd64-librw_gl3_glfw-oal verbose=1

macOS Release:

premake5 --with-librw gmake2 && cd build && make -j5 config=release_macosx-amd64-librw_gl3_glfw-oal verbose=1

Build Options

ℹ️ premake has an --with-lto option if you want the project to be compiled with Link Time Optimization.

ℹ️ There are various settings in config.h, you may want to take a look there.

ℹ️ reVC uses completely homebrew RenderWare-replacement rendering engine; librw. librw comes as submodule of re3, but you also can use LIBRW environment variable to specify path to your own librw.

If you feel the need, you can also use CodeWarrior 7 to compile reVC using the supplied codewarrior/reVC.mcp project - this requires the original RW34 libraries, and the DX8 SDK. The build is unstable compared to the MSVC builds though, and is mostly meant to serve as a reference.

Contributing

This repository is dedicated to improving the original game experience and implementing cross-platform synchronization. It can also serve as a base version for modified games. Compared to the original re3 repository, the requirements for contributions are lower.

License

Keeping the requirements of the original re3 repository, no license is used. The code is for educational, documentation and modification purposes only. Piracy and commercial use are not supported.

Additional Documentation

• Original Repository README
• Localization Workflow