Skip to content

Commit 39a477b

Browse files
authored
Update Setup guide (#6)
1 parent 1752a66 commit 39a477b

1 file changed

Lines changed: 26 additions & 11 deletions

File tree

SETUP.md

Lines changed: 26 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,29 +5,44 @@ Install newest version [here](https://www.python.org/downloads/).
55

66
# Compilers
77

8-
You will need GCC and Clang compilers.
8+
You will need GCC and Clang compilers and some components of Visual Studio (Yes, patching game engine that was originally built with Visual Studio requires it's components).
9+
10+
## Clang
911

1012
Clang compiler installation:
11-
* Goto [github releases of llvm](https://github.com/llvm/llvm-project/releases/tag/llvmorg-18.1.8)
12-
* Download **clang+llvm-18.1.8-x86_64-pc-windows-msvc.tar.xz**
13-
* Unpack into preferred location
13+
14+
* Goto [github releases of llvm](https://github.com/llvm/llvm-project/releases)
15+
* Download latest one with **-x86_64-pc-windows-msvc** suffix (or installer **-win64.exe**)
16+
* Install into preferred location
1417
* You need path to `/bin/clang++.exe`
1518

19+
## Visual Studio
20+
21+
* Goto [Visual Studio]( https://visualstudio.microsoft.com) official website
22+
* Download latest version and install it
23+
* Via *Visual Studio Installer* install 'Desktop development with C++'
24+
25+
## GCC
26+
1627
GCC compiler installation:
17-
* Install [MSYS2](https://www.msys2.org/)
18-
* Install GCC x32/x64 via MSYS console:
19-
* x32: pacman -S mingw-w64-i686-gcc
20-
* x64: pacman -S mingw-w64-x86_64-gcc
28+
29+
* Install [chocolatey](https://chocolatey.org/)
30+
* Run `choco install mingw --x86 -y --no-progress` which is gonna be installed at `C:\ProgramData\mingw64`.
2131
* You need paths to `/mingw32/bin/g++.exe` and `/mingw32/bin/ld.exe`
2232

23-
After everything installed you need to clone patches repo (right now only 4z0t's fork is compatible).
33+
# Patcher
34+
35+
After everything installed you need to clone patches repo.
2436

2537
Now you can setup build script:
38+
2639
```bat
2740
python main.py [Path to patches folder] [Path to clang++.exe] [Path to ld.exe] [Path to g++.exe]
2841
```
29-
After you successfully build, you have to test what you've got somehow.
42+
43+
After you successfully build, you have to test what you've got.
3044
You have 2 options:
45+
3146
* Running patched game with files from FAF client gamedata
3247
* Running patched game with files from FAF repo
3348

@@ -40,4 +55,4 @@ In preferences set default C++ formatter to `ms-vscode.cpptools`.
4055

4156
# Decompiler
4257

43-
TODO
58+
TODO

0 commit comments

Comments
 (0)