Skip to content

Update Setup guide #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
+26 −11
Open

Update Setup guide #6

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
025914d
update setup please...
4z0t Apr 6, 2025
8a99e61
update setup guide
4z0t Sep 3, 2025
b14018b
Update SETUP.md
4z0t Sep 3, 2025
4ae5858
wip
4z0t Sep 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 26 additions & 11 deletions SETUP.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,29 +5,44 @@ Install newest version [here](https://www.python.org/downloads/).

# Compilers

You will need GCC and Clang compilers.
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).

## Clang

Clang compiler installation:
* Goto [github releases of llvm](https://github.com/llvm/llvm-project/releases/tag/llvmorg-18.1.8)
* Download **clang+llvm-18.1.8-x86_64-pc-windows-msvc.tar.xz**
* Unpack into preferred location

* Goto [github releases of llvm](https://github.com/llvm/llvm-project/releases)
* Download latest one with **-x86_64-pc-windows-msvc** suffix
* Install into preferred location
* You need path to `/bin/clang++.exe`

## Visual Studio

* Goto [Visual Studio]( https://visualstudio.microsoft.com) official website
* Download latest version and install it
* Via *Visual Studio Installer* install **C++ x64/x86 build tools** (althrough I'm not sure if this is only one needed component, I'd suggest installing 'Desktop development with C++')

## GCC

GCC compiler installation:
* Install [MSYS2](https://www.msys2.org/)
* Install GCC x32/x64 via MSYS console:
* x32: pacman -S mingw-w64-i686-gcc
* x64: pacman -S mingw-w64-x86_64-gcc

* Install [chocolatey](https://chocolatey.org/)
* Run `choco install mingw --x86 -y --no-progress` which is gonna be installed at `C:\ProgramData\mingw64`.
* You need paths to `/mingw32/bin/g++.exe` and `/mingw32/bin/ld.exe`

After everything installed you need to clone patches repo (right now only 4z0t's fork is compatible).
# Patcher

After everything installed you need to clone patches repo.

Now you can setup build script:

```bat
python main.py [Path to patches folder] [Path to clang++.exe] [Path to ld.exe] [Path to g++.exe]
```
After you successfully build, you have to test what you've got somehow.

After you successfully build, you have to test what you've got.
You have 2 options:

* Running patched game with files from FAF client gamedata
* Running patched game with files from FAF repo

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

# Decompiler

TODO
TODO
Loading