thirdpartymirrors/UnleashedRecomp
1
0
Fork 0
mirror of https://github.com/hedge-dev/UnleashedRecomp.git synced 2026-04-26 12:21:39 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update BUILDING.md

Browse source
This commit is contained in:
Hyper 2025-02-24 08:36:10 +00:00 • committed by GitHub
parent b73d7711b1
commit ca964d85dd
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 22 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
BUILDING.md
View file

@ -1,12 +1,29 @@
# Building # Building
## Windows
### Pre-requisites
- Git
- Visual Studio 2022
- CMake
- clang
> [!NOTE]
> The required versions of CMake and clang can be obtained via Visual Studio Installer as part of the **Desktop development with C++** workload.
### Instructions
1. Clone **UnleashedRecomp** with submodules (or run `update_submodules.bat` to ensure submodules are pulled). 1. Clone **UnleashedRecomp** with submodules (or run `update_submodules.bat` to ensure submodules are pulled).
``` ```
git clone --recurse-submodules https://github.com/hedge-dev/UnleashedRecomp.git git clone --recurse-submodules https://github.com/hedge-dev/UnleashedRecomp.git
``` ```
2. Place `default.xex` and `default.xexp` in `./UnleashedRecompLib/private/`. 2. Place `default.xex` and `default.xexp` in `./UnleashedRecompLib/private/`.
3. Decompress `shader.ar` and place the resulting file in `./UnleashedRecompLib/private/`. 3. Decompress `shader.ar` and place the resulting file in `./UnleashedRecompLib/private/`.
4. Open the repository directory in Visual Studio 2022 and wait for CMake generation to complete. If you don't plan to debug, switch to the `x64-Clang-Release` configuration. 4. Open the repository directory in Visual Studio 2022 and wait for CMake generation to complete. If you don't plan to debug, switch to the `Release` configuration.
5. Under Solution Explorer, right-click and choose "Switch to CMake Targets View". > [!NOTE]
6. Right-click the **UnleashedRecomp** project and choose "Set as Startup Item", then choose "Add Debug Configuration". > If you need a Release-performant build and want to iterate on development without debugging, it is highly recommended that you use the `RelWithDebInfo` configuration for faster compile times.
7. Add a `currentDir` property to the first element under `configurations` in the generated JSON and set its value to the path to your game directory (where root is the directory containing `dlc`, `game`, `save`, `update`, etc). 5. Under Solution Explorer, right-click and choose **Switch to CMake Targets View**.
8. Run or debug **UnleashedRecomp**. The initial compilation might take a while to complete due to code and shader recompilation. 6. Right-click the **UnleashedRecomp** project and choose **Set as Startup Item**, then choose **Add Debug Configuration**.
7. Add a `currentDir` property to the first element under `configurations` in the generated JSON and set its value to the path to your game directory (where root is the directory containing `dlc`, `game`, `update`, etc).
8. Start **UnleashedRecomp**. The initial compilation may take a while to complete due to code and shader recompilation.
## Linux
TODO