GTAV_BuildGuide/README.md

241 lines
13 KiB
Markdown
Raw Normal View History

2024-04-21 05:36:41 +08:00
<!-- Made with ❤️ by Smashtika(@yungDoom) -->
2024-04-13 18:48:28 +08:00
2024-04-23 06:18:02 +08:00
![Icon](/other/design/icon/icon.png)
2024-04-21 05:36:41 +08:00
2024-04-23 07:08:22 +08:00
<h1 align=center>📜 --> GTA V Source Code Build Guide <-- 📜</h1>
2024-04-06 19:48:34 +08:00
2024-04-23 06:38:41 +08:00
🖥️ *Working Status of Tools and Game:* [See Here](/workingstatus.md)<br>
🔨 *Known Bugs, Errors and Issues:* [See Here](/knownissues.md)
2024-03-19 03:31:31 +08:00
2024-04-16 20:00:15 +08:00
⚠️ *If you having any problem, let us know in the ["Issues"](https://github.com/P0L3NARUBA/gtav-sourcecode-build-guide/issues) section of this repository!*<br>
💬 *You can check out ["Discussions"](https://github.com/P0L3NARUBA/gtav-sourcecode-build-guide/discussions) for talking and discuss.*
2024-04-09 03:05:07 +08:00
2024-04-23 17:56:48 +08:00
📩 *You can contact me from discord: yungdoomofficial*
2024-04-23 19:48:01 +08:00
# Contents
1. [Prerequisites](#prerequisites)
1. [Base](#base)
2. [Dependencies](#dependencies)
3. [Miscellaneous](#miscellaneous)
2024-04-23 19:59:46 +08:00
2. [Prebuilt Files](#prebuilt-files)
3. [Prerequisites Setup](#prerequisites-setup)
4. [Patching The Source Code](#patching-the-source-code)
2024-04-23 19:48:01 +08:00
5. [Building The Game Binary/Executable](#building-the-game-binaryexecutable)
6. [Building Shaders](#building-shaders)
7. [Building Game Scripts](#building-game-scripts)
8. [Patching Game Assets](#patching-game-assets)
1. [Modifying the RPF Files](#modifying-the-rpf-files)
2. [Prebuilt Stuff](#prebuilt-stuff)
1. [Prebuilt Shaders](#prebuilt-shaders)
2. [Prebuilt Game Scripts](#prebuilt-game-scripts)
9. [Running The Game](#running-the-game)
10. [BankRelease & Debug Controls](#bankrelease--debug-controls)
11. [Final Thoughts](#final-thoughts)
2024-04-21 20:13:16 +08:00
## Prerequisites
2024-03-19 21:40:03 +08:00
### Base
2024-04-13 18:48:28 +08:00
- Windows 10/11
- [LTSC 2021](https://archive.org/download/Windows10EnterpriseLTSC202164Bit/en-us_windows_10_enterprise_ltsc_2021_x64_dvd_d289cf96.iso) Recommended, but you can use Normal Windows 10/11 too.
2024-04-23 06:50:41 +08:00
- Latest Grand Theft Auto V Files from Steam, Epic Games or maybe Rockstar Games Launcher.
- Minimum 65GB Free Space, 140GB+ is Recommended because of the game files and programs.
2024-04-13 18:48:28 +08:00
- GTAVSP.7z - Source Code<br>
2024-04-18 19:28:42 +08:00
- **Download Link: [All Available Download Links](/source-code-links.md)**
2024-04-11 19:18:06 +08:00
- Archive Password: `Mi76#b>9mRed`
2024-04-09 17:03:08 +08:00
- You can verify the authenticity of the file by its SHA1 hash: `ca39323730ed644fa534a2946506d4287f92a799`
2024-04-11 19:18:06 +08:00
- To verify with 7-Zip, right click the file and select `7-Zip > CRC SHA > SHA1`
2024-04-21 05:36:41 +08:00
- [update.rpf and update2.rpf from GTA V build 2699](https://mega.nz/file/PzJ3DC4R#PAQei9OwOEboB4o5oN2TFmb7KmRFRTvlcKVlZ5zhj3o)
- Some Patience and Technical Competence
2024-03-19 21:40:03 +08:00
### Dependencies
- [Visual Studio 2012](https://files.dog/MSDN/Visual%20Studio%202012/en_visual_studio_ultimate_2012_x86_dvd_2262106.iso)
2024-03-22 01:20:09 +08:00
- [Update 4 for Visual Studio 2012](https://files.dog/MSDN/Visual%20Studio%202012%20Update%204/mu_visual_studio_2012_update_4_x86_dvd_3161759.iso)
2024-03-19 21:40:03 +08:00
- [DirectX SDK June 2010](https://download.microsoft.com/download/A/E/7/AE743F1F-632B-4809-87A9-AA1BB3458E31/DXSDK_Jun10.exe)
2024-04-13 16:42:35 +08:00
- (OPTIONAL) [3D Studio Max 2010 SDK](https://archive.org/details/sdk-3ds-max-2010)
2024-03-22 00:47:17 +08:00
- [Incredibuild 4.0](https://xoreax-incredibuild.software.informer.com/4.0/)
2024-03-22 07:05:27 +08:00
- This is only needed for Compiling Shaders and Game Scripts.
2024-03-19 21:40:03 +08:00
- [7-Zip](https://7-zip.org/a/7z2301-x64.exe)
2024-03-22 08:09:35 +08:00
- For extracting the archives.
2024-03-19 21:40:03 +08:00
- [OpenIV](https://openiv.com/WebIV/guest.php?get=1)
2024-03-22 07:05:27 +08:00
- For editing the game files.
2024-03-19 21:40:03 +08:00
### Miscellaneous
2024-04-05 16:18:49 +08:00
- [Rush Patches](https://github.com/WH0LEWHALE/gtav-sourcecode-build-guide/files/14641602/rush_patches-master.zip)
2024-04-13 16:42:35 +08:00
- [DLL Patches](https://github.com/P0L3NARUBA/gtav-sourcecode-build-guide/files/14965810/dll_patches_x.zip)
- (OPTIONAL) [3rdParty Folder](https://mega.nz/file/SqojFJZL#eYINo1pnspuTvdbocz4cA7NYZA8BN2H2nm7YEXuzlFw)
2024-04-13 16:42:35 +08:00
- (OPTIONAL) [gIKgDXuVHNzIgXkiwpB.zip - Art Asset Leak](https://big.fileditchnew.ch/b9/gIKgDXuVHNzIgXkiwpB.zip)
2024-04-23 07:07:00 +08:00
- [Mirror Link](https://www.bojarcz.uk/gIKgDXuVHNzIgXkiwpB.zip), Thanks to [@RockstarAdvancedGameEngine](https://github.com/RockstarAdvancedGameEngine).
2024-04-23 06:38:04 +08:00
- (OPTIONAL & NOT STABLE) [Visual Studio 2022 Patches](https://small.fileditchstuff.me/s10/VBlSfKBylNQplMIPLL.zip)
2024-04-23 18:56:03 +08:00
- Presented by [@userTermzik](https://github.com/userTermzik), but i don't recommend this because it needs some modifications.
2024-03-19 03:31:31 +08:00
2024-04-23 03:53:20 +08:00
## Prebuilt Files
2024-04-23 04:03:51 +08:00
- [Shaders](https://github.com/WH0LEWHALE/gtav-sourcecode-build-guide/files/14649717/common.zip) ([You can build your own shaders and play with them without any problem.](#building-shaders))
2024-04-23 19:48:01 +08:00
- Game Scripts (Already included, [You can build your own scripts and play with them without any problem.](#building-game-scripts))
2024-03-19 03:31:31 +08:00
2024-04-21 05:36:41 +08:00
___
2024-03-19 03:31:31 +08:00
> [!NOTE]
2024-04-23 06:18:02 +08:00
> It is recommended to create a virtual machine for this build process, Although the build process can be done on your Real PC<br>
> It's not recommended on your Real PC because sometimes the conflicts may happen and broke the whole compilation process<br>
> **VMWare/Hyper-V are recommended to run the Virtual Machine due to their performance.**
2024-03-19 03:31:31 +08:00
2024-04-21 20:13:16 +08:00
## Prerequisites Setup
2024-04-11 19:18:06 +08:00
1. Install DirectX SDK June 2010
2024-04-23 19:48:01 +08:00
- **If you get error S1023, Uninstall `Visual C++ 2010 Redistributable` & Reinstall DirectX SDK - (June 2010).**
2024-04-11 19:18:06 +08:00
2. Install 7-Zip
3. Install Visual Studio 2012
2024-03-22 01:12:37 +08:00
- Uncheck all optional components in the installer **except "Microsoft Foundation Classes for C++"** to save space, none of them are needed for the build.
2024-04-11 19:18:06 +08:00
4. Install Update 4 for Visual Studio 2012
2024-04-23 19:48:01 +08:00
5. Install Incredibuild 4.0 (Only needed for compiling shaders and game scripts)
2024-03-22 01:07:25 +08:00
- If you encounter the error that the installer is "Blocked by your administrator", follow these steps:
2024-04-21 05:36:41 +08:00
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
2024-04-23 03:50:29 +08:00
- Select to install "Incredibuild Agent", "Incredibuild Coordinator", and the extension for Visual Studio
2024-04-11 19:18:06 +08:00
6. Install OpenIV
2024-04-21 06:33:16 +08:00
7. Install [DLL Patches and Rush Patches](#miscellaneous)
2024-04-13 16:42:35 +08:00
8. (OPTIONAL) Install 3D Studio Max 2010 SDK
2024-04-14 23:29:03 +08:00
9. Create X:\ Drive by following the steps at the bottom:
2024-04-13 16:42:35 +08:00
1. Open Command Prompt
2024-04-23 03:50:29 +08:00
2. Create a new folder called "GTA" to the Desktop or anywhere that you want
2024-04-13 16:42:35 +08:00
3. Run `net use X: \\localhost\c$\<Path to working folder for build> /persistent:yes`
2024-04-23 06:38:04 +08:00
- Example: `net use X: \\localhost\c$\Users\abcd\Desktop\GTA /persistent:yes`
2024-04-13 16:54:49 +08:00
10. Create the folder `X:\gta5` and copy all folders from `GTAVSP.7z\GTA V Source` into it
2024-04-23 03:50:29 +08:00
11. Right click the folder `X:\gta5`, select "Properties", uncheck "Read-only", click Apply then OK
2024-04-23 04:03:51 +08:00
12. Open Command Prompt as Administrator and run the following commands, then close:
2024-03-19 03:31:31 +08:00
```batch
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
2024-03-22 03:57:26 +08:00
setx /m RS_PROJECT gta5
2024-03-19 03:31:31 +08:00
```
2024-04-23 19:48:01 +08:00
13. (OPTIONAL) Symlink the `X:\gta5\titleupdate\dev_ng` directory.
- This can be done with this CMD Command: `mklink /D /J "X:\gta5\titleupdate\dev_ng" "INSERT_RETAIL_COPY_HERE"`.
**(``INSERT_RETAIL_COPY_HERE`` being your GTA V Game Directory)**
14. If you dont want to symlink, Put all the game files to the `X:\gta5\titleupdate\dev_ng` directory.
15. To ensure changes are finalized, restart build machine/computer.
2024-04-13 16:54:49 +08:00
2024-04-23 05:58:13 +08:00
## 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 `rush_patches-master.zip\OPTIONAL_FIXES` to the same folder
4. Copy all folders in `dll_patches_x.zip` to `X:\gta5\tools_ng\bin`, make sure to overwrite when copying
5. (OPTIONAL) Install 3rdParty Folder, Extract and Put the folder to `X:\gta5\`.
2024-04-23 03:50:29 +08:00
**By far, Your Folder Structure should look like this:**
2024-04-13 16:54:49 +08:00
```
2024-04-13 18:24:35 +08:00
🖥️ X:
2024-04-13 16:54:49 +08:00
┗ 📂 gta5
2024-04-23 06:38:04 +08:00
┣ 📂 3rdParty - (OPTIONAL)
2024-04-13 16:54:49 +08:00
┣ 📂 src
2024-04-23 20:03:04 +08:00
┃ ┣ 📂 dev_ng
2024-04-13 16:54:49 +08:00
┣ 📂 script
2024-04-23 20:03:04 +08:00
┃ ┣ 📂 dev_ng
2024-04-13 16:55:37 +08:00
┗ 📂 tools_ng
2024-04-13 16:54:49 +08:00
```
2024-03-19 03:31:31 +08:00
2024-04-23 06:38:04 +08:00
## Building The Game Binary/Executable
2024-03-19 03:34:38 +08:00
1. Run `X:\gta5\src\dev_ng\game\VS_Project\load_sln_unity_2012.bat`
2024-04-23 03:50:29 +08:00
- If prompted with "How do you want to open this file?", check "Always use this app to open .sln files" and Select **Visual Studio 2012** then click OK
2024-03-19 03:31:31 +08:00
2. Once the solution loads, open the dropdown menu that says "Debug" at the top, select "Configuration Manager"
2024-04-23 03:50:29 +08:00
3. Change "Active Solution Platform" to "x64" and close the configuration window
4. Hold Ctrl key and click all projects under "GameLibs" and "Rage" folder, 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"
2024-04-21 05:36:41 +08:00
- For faster compiles, search "mul" and set "Multiprocessor Compilation" to "Yes (/MP)"
2024-04-23 03:50:29 +08:00
- If you get the error `C1060: Compiler is out of heap space` during build, come back to the above setting and turn it off
2024-04-23 06:38:04 +08:00
7. Right-click the "game" project and select "Properties" and do step 5,6 again
2024-04-23 03:50:29 +08:00
8. Change build the type at the top of the window from "Debug" to "BankRelease"
2024-04-23 06:38:04 +08:00
10. At the top of the window, select `Build > Build Solution` and wait for build to finish
11. Copy output binary to game folder.
2024-03-19 03:31:31 +08:00
2024-04-21 05:36:41 +08:00
> [!WARNING]
2024-04-23 19:48:01 +08:00
> Building shaders and game scripts can be skipped using the [prebuilt files above](#prebuilt-files)<br>
2024-04-23 04:01:01 +08:00
> These steps are here to allow modding or for those who prefer to build from source as much as possible<br>
2024-04-23 03:56:13 +08:00
> If you prefer using prebuilt files, [here is all the instruction to make them work.](#prebuilt-stuff)
2024-03-19 03:31:31 +08:00
2024-03-19 03:45:30 +08:00
## Building Shaders
2024-03-19 03:31:31 +08:00
1. Under "Shaders", right click the "shaders_rc" project and click "Build"
2. (OPTIONAL) Build low quality shaders
2024-03-22 01:07:25 +08:00
1. Right click the "shaders_rc" project and click "Properties"
2. Select `Configuration Properties > NMake`
2024-04-23 03:50:29 +08:00
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 and wait it to finish
2024-04-21 05:36:41 +08:00
3. Copy `X:\gta5\titleupdate\dev_ng\common` to game directory.
2024-03-19 03:31:31 +08:00
2024-03-19 03:45:30 +08:00
## Building Game Scripts
2024-04-21 05:36:41 +08:00
1. Open Command Prompt and Run the following commands:
2024-03-19 03:31:31 +08:00
```batch
X:
cd X:\gta5\src\dev_ng
setenv
cd ..\..\tools_ng\bin\RageScriptEditor
ragScriptEditor
```
2024-04-23 04:01:01 +08:00
3. In the editor, select `File > Open Project` and open `X:\gta5\script\dev_ng\singleplayer\GTA5_SP.scproj`
2024-04-23 04:07:46 +08:00
4. Select `Compiling > Intellibuild > Build Project` and wait until the compiling process finishes.
5. Run OpenIV, select "Windows" under "Grand Theft Auto V"
6. Select the game folder and click "Continue"
7. Open `<Game Directory>\update\update2.rpf\x64\levels\gta5\script`
8. Delete `script.rpf`
9. Click the "Edit mode" button, and copy `X:\gta5\titleupdate\dev_ng\x64\levels\gta5\script\script.rpf` to the OpenIV window.
2024-04-21 05:36:41 +08:00
2024-03-19 03:31:31 +08:00
2024-03-19 03:45:30 +08:00
## Patching Game Assets
2024-04-21 06:35:45 +08:00
2024-04-21 21:34:56 +08:00
1. Install ``update.rpf and update2.rpf from GTA V build 2699`` from [Prerequisites List](#prerequisites)
2024-04-23 04:01:01 +08:00
2. Put `update.rpf` and `update2.rpf` files to `<Game Directory>\update\` folder
2024-04-21 05:36:41 +08:00
* **Dont forget to backup your old files from update folder.**
#### Modifying the RPF Files
If you ever modify the RPF files, dont forget to encrpyt them.<br>
2024-04-23 03:50:29 +08:00
**Here you can see how to do it:**
2024-04-21 05:36:41 +08:00
1. From `rush_patches-master.zip`, copy all files in the `ARCHIVEFIX` folder to a separate location
2024-04-21 05:39:25 +08:00
2. Drag RPF file(s) onto `ArchiveFix.exe`
* Don't drag the both files at the same time, **just drag one by one**, This will not work with that way.
2024-04-21 05:36:41 +08:00
2024-04-23 03:56:13 +08:00
#### Prebuilt Stuff
##### Prebuilt Shaders
2024-04-23 03:50:29 +08:00
1. Go to game directory
2. Put the `common` folder to the game directory.
2024-04-23 19:48:01 +08:00
##### Prebuilt Game Scripts
2024-04-23 03:56:13 +08:00
* Scripts Already included in update2.rpf, you can replace it in future with one that you builded it.
2024-03-19 03:45:30 +08:00
## Running The Game
2024-03-19 03:31:31 +08:00
1. In the game directory, create a file named `launch.bat` and add these contents:
```batch
cd %~dp0
2024-03-22 17:35:30 +08:00
game_win64_bankrelease.exe -noSocialClub -nokeyboardhook -nonetlogs
2024-03-19 03:31:31 +08:00
```
2024-03-22 17:35:30 +08:00
2. (OPTIONAL) Add additional arguments:
2024-04-23 06:50:41 +08:00
- `-kbgame` - Start game with game keyboard enabled
- `-output` - Show console log of game, the game opens a little bit slow.
- `-rag` - Enable support for RAG, the internal game debugging tool
- `-ragUseOwnWindow` - Use it with `-rag` parameter to make game run outside of RAG Render Window
- **DO NOT** Forget to Launch RAG Before launching the game if u using any RAG parameters
- `-DoReleaseStartup` - Start real Story Mode on launch, Ignore if it says unknown parameter/command
- If you dont type this parameter, you will spawned in a random location as a random character with a random clothes
2024-03-21 07:48:24 +08:00
- Additional standard game arguments can be added as well.
2024-04-21 05:57:53 +08:00
- [Here is the almost all the arguments list](other/LAUNCHPARAMS_GTAV.txt)
2024-04-21 05:36:41 +08:00
3. (OPTIONAL) Launch RAG with the following commands in Command Prompt:
2024-03-19 03:31:31 +08:00
```batch
X:
cd X:\gta5\src\dev_ng
setenv
cd ..\..\tools_ng\bin\rag
rag
```
2024-04-06 17:21:12 +08:00
4. Run `launch.bat`
2024-03-19 03:31:31 +08:00
2024-04-06 17:21:58 +08:00
## BankRelease & Debug Controls
2024-03-19 03:31:31 +08:00
2024-04-21 05:57:53 +08:00
[Almost Every Controls & Keys](/other/controls)
2024-04-21 05:36:41 +08:00
2024-04-23 06:38:04 +08:00
# Final Thoughts
2024-04-23 06:50:41 +08:00
Thanks for reading my precious tutorial, please consider starring or forking the repository if this helped u<br>
**Feel free to contribute the repository, you'll be welcomed if you dont make stupid thingies.**
2024-04-23 06:38:04 +08:00
2024-04-21 05:36:41 +08:00
<!-- Made with ❤️ by Smashtika(@yungDoom) -->