ModdingRX/GTAV_BuildGuide
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
c683fd8233
GTAV_BuildGuide/README.md
Gentoolman c683fd8233
Update README.md
2024-03-19 14:19:47 +03:00

11 KiB
Raw Blame History

GTA V Build Guide

Based on original Pastebin guide and assistance from various individuals.
Also Github edition with fixed links and added some files!

Requirements | Prerequisites

Prebuilt Files

Note

It is recommended to create a virtual machine for this build process, although the build process can be done on your PC. VMWare/Hyper-V are recommended to run the VM due to their performance.

Prerequisite Setup

  1. Install Visual Studio 2012
    • Uncheck all optional components in the installer except "Microsoft Foundation Classes for C++" to save space, none of them are needed for the build.
  2. Install Update 4 for Visual Studio 2012
  3. Install Incredibuild 4.0 (Only needed for compiling shaders and scripts)
    • If you encounter the error that the installer is "Blocked by your administrator", follow these steps:
      1. Hold Shift and right click the incredibuild4_0.exe file, select "Copy as path"
      2. Open Command Prompt as Administrator
      3. Paste the path and press Enter
    • Select to install "Incredibuild Agent", "Incredibuild Coordinator", and the extension for Visual Studio
  4. Install DirectX SDK June 2010
  5. Install OpenIV
  6. Create X:\ drive
    1. Open Command Prompt
    2. Run net use X: \\localhost\c$\<Path to working folder for build> /persistent:yes
      • ex. net use X: \\localhost\c$\Users\abc\Desktop\GTA /persistent:yes for working folder C:\Users\abc\Desktop\GTA
  7. Create the folder X:\gta5 and copy all folders from GTAVSP.7z\GTA V Source into it
    • By the end, you should have the folders X:\gta5\src, X:\gta5\script, and X:\gta5\tools_ng. If the paths are different or some folders are missing, try re-extracting or moving as needed.
  8. Right click the folder X:\gta5, select "Properties", uncheck "Read-only", click Apply then OK
  9. Copy all folders in dll_patches.zip to X:\gta5\tools_ng\bin, make sure to overwrite when copying
  10. Open Command Prompt as Administrator and run the following commands, then close:
setx /m RS_TOOLSROOT X:\gta5\tools_ng
setx /m DXSDK_DIR "C:\Program Files (x86)\Microsoft DirectX SDK (June 2010)"
setx /m RS_CODEBRANCH X:\gta5\src\dev_ng
  1. To ensure changes are finalized, restart build machine

Patching The Source Code

  1. Open rush_patches-master.zip
  2. Copy game and rage folders to X:\gta5\src\dev_ng, make sure to overwrite when copying
  3. (OPTIONAL) To skip launcher requirement for running the game, copy game and rage folders from OPTIONAL_FIXES to the same folder

Building The Game Binary

  1. Run X:\gta5\src\dev_ng\game\VS_Project\load_sln_unity_2012.bat
    • If prompted with "How do you want to open this file?", check "Always use this app to open .sln files" and click OK
  2. Once the solution loads, open the dropdown menu that says "Debug" at the top, select "Configuration Manager"
  3. Change "Active Solution Platform" to "x64" and close the configuration window
  4. Hold Ctrl key and click all projects under "GameLibs" and "Rage", right-click and select "Properties"
  5. In the "Configuration" dropdown, select "All Configurations"
  6. Select C/C++ > All options, under "Look for options or switches", search "err" and set "Treat Warnings as Errors" to "No (/WX-)", then click "Apply" and "OK"
    • For faster compiles, search "mul" and set "Multiprocessor Compilation" to "Yes (/MP)"
    • If you get the error C1060: Compiler is out of heap space during build, come back to the above setting and turn it off
  7. Right-click the "game" project and select "Properties" and do step 5 again
  8. Change build the type at the top of the window from "Debug" to "BankRelease"
  9. At the top of the window, select Build > Build Solution and wait for build to finish
  10. Copy output binary to game folder

Note

Building shaders and scripts can be skipped using the prebuilt files above. These steps are here to allow modding or for those who prefer to build from source as much as possible.

Building Shaders

  1. Under "Shaders", right click the "shaders_rc" project and click "Build"
  2. (OPTIONAL) Build low quality shaders
    1. Right click the "shaders_rc" project and click "Properties"
    2. Select Configuration Properties > NMake
    3. Under "General", change all command lines from ending with win32_40.bat to ending with win32_40_lq.bat, then click "Apply" and "OK"
    4. Rebuild shaders
  3. Copy X:\gta5\titleupdate\dev_ng\common to game directory

Building Game Scripts

  1. Open Command Prompt
  2. Run the following commands:
X:
cd X:\gta5\src\dev_ng
setenv
cd ..\..\tools_ng\bin\RageScriptEditor
ragScriptEditor
  1. In the editor, select File > Open Project and open X:\gta5\script\dev_ng\singleplayer\GTA5_SP.scproj
  2. Select Compiling > Intellibuild > Build Project

Patching Game Assets

  1. Run OpenIV, select "Windows"
  2. Select the game folder and click "Continue"
  3. Open GTA V\update\update2.rpf\x64\levels\gta5\script
  4. Click the "Edit mode" button, and copy X:\gta5\titleupdate\dev_ng\x64\levels\gta5\script\script.rpf to the OpenIV window
  5. (OPTIONAL) Fix Story Mode
    1. Open GTA V\update\update.rpf\common\data and make sure "Edit Mode" is enabled
    2. Under "XML Text Files", right-click gameconfig.xml and click "Edit"
    3. Under "Search", type "51000"
    4. Change the value of 51000 to 53000
    5. Click "Save"
  6. Close OpenIV
  7. From rush_patches-master.zip, copy all files in the ARCHIVEFIX folder to a separate location
  8. Open <GAME FOLDER>\update, and drag update.rpf and update2.rpf onto ArchiveFix.exe
  9. Close both windows

Running The Game

  1. In the game directory, create a file named launch.bat and add these contents:
cd %~dp0
game_win64_bankrelease.exe -noSocialClub -nokeyboardhook -nonetlogs
  1. (OPTIONAL) Add additional arguments:
  • -kbgame - Start game with game keyboard enabled
  • -output - Show console log of game
  • -rag - Enable support for RAG, the internal game debugging tool
  • -ragUseOwnWindow - Combined with -rag to make game run outside of RAG window
  • -DoReleaseStartup - Start real Story Mode on launch
  • Additional standard game arguments can be added as well
  1. (OPTIONAL) Launch RAG with the following commands in Command Prompt
X:
cd X:\gta5\src\dev_ng
setenv
cd ..\..\tools_ng\bin\rag
rag
  1. (OPTIONAL) Copy Goldberg patch into game directory, make sure to overwrite
  2. Run launch.bat

Debug Build Controls

Legend:
LCTRL -- Left control.
RCTRL -- Right control.
LALT - Left alt.
RALT - Right alt.
LSHIFT - Left shift
RSHIFT - Right shift.

Main keybinds:
CTRL + TAB -> Switch between game keyboards. Available are debug, marketing, game and roleplay.

Debug Keybinds:
Backtick ---> Toggle scene information.
Ins (Numpad) ---> Remove debug screen information.
Del (Numpad) ---> Creates a copy of you.
Page up (Numpad) ---> Toggle CPU information.
CTRL + Del (Numpad) ---> Creates a copy of you and sets as your main.
CTRL + Num lock (Numpad) ---> Freezes the game. (literally)
ALT + Enter (Numpad) ---> Fullscreen.

Page up / Page down ---> Change game weather.
Scroll Lock ---> Appears "Streaming paused" message.
Break (Pause break) ---> Freezes the game. (literally)

A ---> Toggle AI display info variants.
B ---> Toggle render info.
D ---> Enable/Disable debug pad.
G ---> Teleport (mouse)
H ---> Health cheat
I ---> Show navmeshes
J ---> Skip to next segment of mission
N ---> Appears your character name in minimap and weird red sphere. (It's AI Walking).
O ---> Toggles minimap on the screen.
Q ---> Changes current character model.
R ---> Navigation info, ambient vehicle info
S ---> Reload shaders
U ---> Spawns a vehicle.
V ---> Invincibility
W ---> Gives a specific amount of all weapons in the game.
X ---> Toggles character clothes info.
Z ---> Mission Debug Menu
F1 ---> Toggle Peds/Cards/Objects/Physics instances and lights info.
F2 ---> AI Combat debug info.
F3 ---> Decrease Wanted Level
F5 ---> Teleports to random location.
F8 ---> FAMILY_CONTROLLER / PLAYER_SWITCH STATE INFORMATION
F9 ---> GAMEFLOW STATE INFORMATION
F10 ---> FRIEND_CONTROLLER STATE INFORMATION
F11 ---> RANDOM EVENTS DEBUG DISPLAY
F12 ---> SCRIPT METRICS DEBUG INFO.

CTRL + A ---> Remove AI display info.
CTRL + B ---> Remove box modifier gui.
LCTRL + C ---> Get all available promotions.
RCTRL + C ---> Show prop hitboxes.
CTRL + D ---> Opens filter menu.
CTRL + F ---> Toggle prop/vehicle information like life ratio.
CTRL + G ---> #UNKNOWN
CTRL + I ---> Toggle mouse relative debug info.
Ctrl + N ---> Show player/vehicle tags.
Ctrl + P ---> Toggle information about promps and show character's hitbox.
Ctrl + T ---> Clear Mission trigger
Ctrl + U ---> Spawns or teleports a vehicle. #PARTIALLYKNOWN
RCTRL + Right/Left arrow key ---> Increase/Decrease timescale.

Ctrl + Shift + C ---> Prop hitboxes.
Ctrl + Shift + H ---> Spawn a human.
Ctrl + Shift + R ---> Init telemetry. #PARTIALLYKNOWN
Ctrl + Shift + P ---> Spawns a car.

ALT + A ---> Toggle vehicle information.
ALT + C ---> Cycle through Camera Debug Displays
ALT + G ---> Change game shader.
ALT + H ---> Toggle shader information.
ALT + M ---> Position zoom.
ALT + O ---> Toggle overdraw info.
ALT + T ---> Toggle texture view gui.
ALT + W ---> Show every prop's hitbox.
ALT + X ---> Removes power cables.

SHIFT/CTRL + B ---> Toggle collision debug info.
SHIFT + H ---> Teleports to your house.
SHIFT + K ---> LowTierGod. (Kills the player.)
SHIFT + O ---> Toggle Overview gui.
SHIFT + P ---> Change characters model in vehicle.
SHIFT + R ---> Toggle peds info.
SHIFT + T ---> Change trigger zone.
SHIFT + U ---> Spawns a vehicle and makes your driver auto.

Ctrl + Alt + I ---> Toggle weapon/inputs information.