Overview
Building Ryujinx from source is intended for developers who want to contribute code. If you just want to use the emulator, download pre-built releases instead.Prerequisites
Install .NET SDK
Download .NET 10.0 SDK
Install the .NET 10.0 (or higher) SDK
Verify SDK version
Your SDK version must meet or exceed the version specified in
global.json:global.json
Get the Source Code
Choose one of these methods:- Git Clone (Recommended)
- Download ZIP
Building the Project
Quick Build
From the project root directory:Built files will be created in the
build/ directory.Build Configuration Options
Platform Access on Windows
Publishing Ryujinx
For a self-contained executable:- Windows x64
- Linux x64
- macOS Universal
- Linux ARM64
Self-contained builds include the .NET runtime, making them larger but not requiring .NET SDK installation on the target system.
CI Build Commands
The GitHub Actions CI uses these commands (from.github/workflows/build.yml:54):
Build
Test
Publish
System Files Location
After building, Ryujinx stores its system files in the user folder:Windows
Windows
Linux
Linux
macOS
macOS
Supported Platforms
Ryujinx builds for multiple platforms (from.github/workflows/build.yml:21-25):
| Platform | Runtime ID | OS Runner |
|---|---|---|
| Windows x64 | win-x64 | windows-latest |
| Windows ARM64 | win-arm64 | windows-latest |
| Linux x64 | linux-x64 | ubuntu-latest |
| Linux ARM64 | linux-arm64 | ubuntu-latest |
| macOS x64 | osx-x64 | macos-13 |
| macOS Universal | osx-universal | Custom build |
Troubleshooting
SDK version mismatch
SDK version mismatch
Error: The current .NET SDK does not support targeting .NET 10.0Solution: Install .NET 10.0 SDK or higher. Verify with:
Build errors after git pull
Build errors after git pull
Solution: Clean and rebuild:
Missing dependencies
Missing dependencies
Solution: Restore NuGet packages:
Platform-specific build failures
Platform-specific build failures
Linux: Install required dependencies:macOS: Install Xcode Command Line Tools:
Build Performance Tips
IDE Setup
Visual Studio (Windows)
Install Visual Studio 2022
Download Visual Studio 2022 or later
Visual Studio Code (Cross-platform)
Install VS Code
Download Visual Studio Code
Install C# extension
Install the C# Dev Kit extension
Rider (Cross-platform)
Install JetBrains Rider
Download JetBrains Rider
Next Steps
Coding Style
Learn Ryujinx’s C# conventions
Debugging
Set up debugging tools
Testing
Run and write tests