Get Started on JetBrains Rider

Prerequisites

Rider Platforms support

Windows (UWP/WinUI) Android iOS Wasm macOS Skia-GTK (Linux) Skia-WPF
Rider for Linux ❌† ✔️† ✔️
Rider for Mac ✔️ ✔️ ✔️† ✔️ ✔️†
Rider for Windows ✔️ ✔️ ✔️† ✔️† ✔️ ✔️

† Notes:

  • Wasm: debugging from the IDE is not available yet on Rider. But you can use the Chromium in-browser debugger instead.

    To start the app from the IDE (using the "Run" button), dotnet core 3.1 must be installed on the machine:

    # dotnet 3.1 sdk is required to launch Wasm app from Rider
    # For Ubuntu, use apt install like that:
    sudo apt install dotnet-sdk-3.1
    

    For Mac, you should install it from here.

  • Skia-GTK on Mac: you need to make sure to install gtk+3 package using the following command line:

    brew install gtk+3
    
  • iOS on Windows: An attached Mac is needed, the iOS simulator will open on the Mac.

  • Android on Linux: Xamarin.Android does not natively support Linux development. Rider has been capable of Android development on Linux in the past, but previous directions are considered obsolete. As of this comment (3 Nov 2021) Xamarin Android builds on Linux fail.

Finalize your environment

  1. Open a command-line prompt, Windows Terminal if you have it installed, or else Command Prompt or Windows Powershell from the Start menu.

  2. Install the tool by running the following command from the command prompt:

    dotnet tool install -g uno.check
    

    To update the tool, if you already have an existing one:

    dotnet tool update -g uno.check
    
  3. Run the tool from the command prompt with the following command:

    uno-check --pre
    
  4. Follow the instructions indicated by the tool

You can find additional information about uno-check here.

Creating a new Uno Platform project

At this time, there isn't a template for the Rider IDE like there is for Visual Studio, so you can create a new project using dotnet new by following these steps:

  1. In your terminal, navigate to the folder that contains your Rider solutions.

  2. Run these commands:

Installs Uno template:

dotnet new -i Uno.ProjectTemplates.Dotnet

Creates a new project:

dotnet new unoapp -o MyApp

You should now have a folder structure that looks like this:
rider-folder-structure

Android

  1. Set Android as your startup project. Run.
    run-android-rider

Note: Whether you're using a physical device or the emulator, the app will install but will not automatically open. You will have to manually open.

Wasm

  1. Select Wasm as your startup project. Run.
    run-wasm-rider
    A new browser window will automatically run your application.

Note: There is no debugging for Wasm within Rider, but you debug using the built in Chrome tools.

macOS

You will be able to build the macOS project.
run-ios-rider
Alternatively, you can use a tool like VNC to run the simulator on a mac.

UWP

You will be able to build the UWP project, however, Rider currently does not support debugging or deploying for UWP.
run-uwp-rider

Video Tutorial

Getting Started Rider Video

Troubleshooting Uno Platform Installation Issues

If you're not sure whether your environment is correctly configured for Uno Platform development, running the uno-check command-line tool should be your first step.

Getting Help

If you continue experiencing issues with Uno Platform, please visit our GitHub Discussions or Discord - #uno-platform channel where our engineering team and community will be able to help you.