From 835f31437818176bb1eafa9d9eaa860f87c50e4f Mon Sep 17 00:00:00 2001 From: Michael <15317421+ActualMandM@users.noreply.github.com> Date: Sun, 23 Feb 2025 13:34:39 -0800 Subject: [PATCH] Transfer old README to BUILDING.md --- BUILDING.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 BUILDING.md diff --git a/BUILDING.md b/BUILDING.md new file mode 100644 index 00000000..0f76f32b --- /dev/null +++ b/BUILDING.md @@ -0,0 +1,12 @@ +# Building +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 +``` +2. Place `default.xex` and `default.xexp` 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. +5. Under Solution Explorer, right-click and choose "Switch to CMake Targets View". +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`, `save`, `update`, etc). +8. Run or debug **UnleashedRecomp**. The initial compilation might take a while to complete due to code and shader recompilation.