How to Install RenoDX on Windows: Complete Setup Guide
Run .\scripts\setup-dev-env.ps1 -Install from the cloned repository to automatically install the Windows SDK, compiler toolchains, and Reshade dependencies required to build RenoDX on Windows.
RenoDX is a DirectX modding engine that provides advanced shader manipulation capabilities for Windows games. Installing RenoDX on Windows requires configuring a specialized development environment with specific compiler toolchains and the Reshade add-on framework. This guide walks through the automated setup process using the official PowerShell installer and explains the architecture behind the deployment scripts.
Prerequisites for Installing RenoDX
Before running the installation script, ensure your Windows system meets the following requirements. According to the README.md and CONTRIBUTING.md documentation, you need:
- MSVC 2022 Build Tools – Required for compiling C++ components and HLSL shaders.
- CMake and Ninja – Build system generators used by the project presets.
- LLVM/Clang – Alternative compiler toolchain supported by the build system.
- Windows 10/11 SDK – Minimum version
10.0.26100.0must be installed to accessfxc.exeand other essential libraries. - Reshade – A recent version must be present on the target machine, as RenoDX uses the Reshade add-on API.
- Git – For cloning the
clshortfuse/renodxrepository.
Step-by-Step Installation Guide
1. Clone the Repository
First, download the source code to your local machine. The repository contains the automated setup script at scripts/setup-dev-env.ps1.
git clone https://github.com/clshortfuse/renodx.git
cd renodx
2. Run the Automated Setup Script
The scripts/setup-dev-env.ps1 script handles tool detection, downloads, and SDK configuration. You can run it in preview mode first to assess your current environment:
# Preview mode - shows status without making changes
.\scripts\setup-dev-env.ps1
To perform a full installation, use the -Install flag. This creates the .\bin directory, downloads managed tools, attempts Windows SDK installation via winget, and copies fxc.exe into the project:
.\scripts\setup-dev-env.ps1 -Install
If you already have the SDK but need to update the managed tools (DXC, Slang, GLSLANG, 3DMigoto), use the -Update flag instead:
.\scripts\setup-dev-env.ps1 -Update
3. Customize Installation Paths and Tools
The script supports several parameters defined in setup-dev-env.ps1 lines 28-34:
-Bin <path>– Specifies a custom directory for tool binaries instead of the default.\bin.-Tools dxc,slang,glslang– Limits installation to specific tools rather than the full suite.
Example using a custom binary directory:
.\scripts\setup-dev-env.ps1 -Bin D:\renodx_tools -Install
Understanding the Setup Script Architecture
The setup-dev-env.ps1 installer is organized into discrete functions that automate environment preparation. Understanding these helps troubleshoot installation issues.
Core Functions
Initialize-BinDir– Creates the localbinfolder if it does not exist.Get-ToolDownloadInfo/Get-GitHubReleaseAssetDownloadInfo– Resolves download URLs for managed tools like DXC (via GitHub releases) and Slang/GLSLang (via direct URLs).Install-ToolFromArchive– Extracts downloaded ZIP archives and copies required binaries (dxc.exe,dxcompiler.dll,slangc.exe,glslang.exe,cmd_Decompiler.exe) into.\bin.Test-WindowsSdk– Detects installed Windows SDKs by scanning the registry (HKLM:\SOFTWARE\Microsoft\Windows Kits\Installed Roots) and copiesfxc.exeinto the project bin directory.Install-WindowsSdk– Invokes winget to install the SDK when the-Installflag is present and the SDK is missing.
The script references minimum version requirements defined in cmake/tool-versions.cmake to determine whether existing tools need updates.
Verification Process
When you run the script with -Install or -Update, the verification routine (lines 48-57) reports the detected SDK version and status of each managed tool. The environment is ready when all core files—fxc.exe plus the required compiler binaries—are present in your bin directory.
Building RenoDX After Installation
Once the environment setup completes, compile the project using one of the CMake presets defined in the repository. The CONTRIBUTING.md file specifies three main presets:
# Build with Clang
cmake --preset clang-x64
cmake --build --preset clang-x64-release
# Alternative using Ninja
cmake --preset ninja-x64
cmake --build --preset ninja-x64-release
# Alternative using Visual Studio
cmake --preset vs-x64
cmake --build --preset vs-x64-release
These commands build the generic library and optional targets like the devkit or MCP bridge (documented in docs/DEVKIT_MCP.md).
Manual Windows SDK Installation
If the script cannot install the SDK automatically (for example, when winget is unavailable), install it manually using:
winget install --id Microsoft.WindowsSDK -e --silent
Alternatively, download the installer directly from Microsoft's developer website. The SDK must provide fxc.exe (the legacy HLSL compiler) which the build system requires for shader processing.
Summary
- Install RenoDX on Windows by running
scripts/setup-dev-env.ps1 -Installafter cloning theclshortfuse/renodxrepository. - The automated script manages MSVC 2022 Build Tools, CMake, Ninja, LLVM, and the Windows 10/11 SDK (minimum
10.0.26100.0). - The installer downloads and extracts DXC, Slang, GLSLang, and 3DMigoto into
.\binwhile copyingfxc.exefrom your system SDK. - Use
-Updateto refresh tools without reinstalling the SDK, and-Bin <path>to specify custom binary locations. - Build the project using CMake presets like
clang-x64orninja-x64once the environment is configured.
Frequently Asked Questions
What are the minimum system requirements for RenoDX?
RenoDX requires Windows 10 or 11 with the Windows SDK version 10.0.26100.0 or newer. You need approximately 10GB of free space for the SDK, compiler tools, and repository. The build process requires MSVC 2022 Build Tools or Clang/LLVM as supported by the CMake presets in the repository.
Can I install RenoDX without the Windows SDK?
No. The Windows SDK is mandatory because RenoDX relies on fxc.exe (the legacy HLSL compiler) and Windows-specific DirectX headers located in the SDK. The setup-dev-env.ps1 script attempts automatic installation via winget, but you can install it manually if the automated approach fails.
How do I update existing RenoDX tools without reinstalling everything?
Use the -Update flag when running the setup script. This mode skips SDK installation attempts and only refreshes the managed tools (dxc, slang, glslang, 3dmigoto) by comparing your current versions against the minimum requirements in cmake/tool-versions.cmake. Run .\scripts\setup-dev-env.ps1 -Update from the repository root.
What should I do if the setup script cannot find fxc.exe?
Verify that your Windows SDK is properly installed and accessible. The script's Test-WindowsSdk function searches the registry path HKLM:\SOFTWARE\Microsoft\Windows Kits\Installed Roots to locate the SDK root. If the SDK is installed but not detected, manually copy fxc.exe from your SDK's bin\x64 folder into the project's .\bin directory, or run winget install --id Microsoft.WindowsSDK to repair the installation.
Have a question about this repo?
These articles cover the highlights, but your codebase questions are specific. Give your agent direct access to the source. Share this with your agent to get started:
curl -s "https://instagit.com/install.md" Maintain an open-source project? Get it listed too →