Skip to content

Building WPR

Jump to bottom
Bubbleshum edited this page May 22, 2026 · 2 revisions

Building WPR

Warning

WPR is currently in active alpha development.

Build instructions and dependencies may change frequently.

Requirements

Before building WPR, ensure the following tools are installed.

Requirement Notes
.NET 8 SDK Required
Git Required
Rider or Visual Studio Recommended
Android SDK Required for Android builds
Android Workload Required for Android builds
Vulkan Drivers Recommended

Recommended Development Environment

WPR is primarily developed using:

  • Rider
  • .NET 8
  • Avalonia UI

Visual Studio should also work for desktop development.

Cloning The Repository

Clone the repository using Git:

git clone https://github.com/Bubbleshum/WPR.git
cd WPR

Restoring Dependencies

Restore required NuGet packages:

dotnet restore

Building Desktop Version

Windows

Build the desktop version using:

dotnet build

Release Build

dotnet build -c Release

Running Desktop WPR

Run directly using:

dotnet run

Or launch the compiled executable from the build output directory.

Building Android Version

Android support is currently experimental.

Install Android Workload

Install the required .NET Android workload:

dotnet workload install android

Android SDK

Ensure the Android SDK is installed and configured correctly.

Required components typically include:

  • Android SDK Platform
  • Build Tools
  • Platform Tools

Build Android APK

Build the Android version using:

dotnet build -f net8.0-android

Running On Android

After building:

  1. Install the generated APK
  2. Grant storage permissions if prompted
  3. Launch WPR

Rider Setup

Rider is the recommended IDE for WPR development.

Recommended Rider Features

  • Avalonia support
  • Android support
  • .NET debugging
  • Vulkan debugging tools
  • Git integration

Visual Studio Setup

Visual Studio can also be used for development.

Recommended workloads:

  • .NET Desktop Development
  • Mobile Development with .NET

Vulkan Requirements

Some rendering paths rely on Vulkan support.

Recommended:

  • updated GPU drivers
  • Vulkan-capable hardware

Common Build Problems

Missing Android Workload

Install using:

dotnet workload install android

Missing SDK Errors

Ensure:

  • .NET 8 SDK is installed
  • Android SDK paths are configured correctly
  • environment variables are valid

Vulkan Errors

Possible causes:

  • outdated GPU drivers
  • unsupported hardware
  • missing Vulkan runtime

NuGet Restore Failures

Try:

dotnet restore

or:

dotnet clean
dotnet restore

Build Configuration

Current primary targets include:

Target Status
Windows Desktop ✅ Active
Android ✅ Experimental
Linux ⚠️ Experimental

Debugging

Useful debugging approaches include:

  • console output
  • Rider debugger
  • Visual Studio debugger
  • Vulkan validation layers
  • Android logcat

Logging

Logging support is still evolving during alpha development.

Useful information when debugging includes:

  • stack traces
  • console output
  • device information
  • GPU information

Contributing

If you plan to contribute:

  • keep pull requests focused
  • test your changes
  • follow existing code style
  • document unusual behaviour

See:

Keeping Updated

WPR changes rapidly during development.

To update your local repository:

git pull

You may also occasionally need to:

  • clean the solution
  • restore packages again
  • rebuild completely

Thank You

Thank you for helping develop and preserve Windows Phone gaming ❤️

Clone this wiki locally