Unreal Engine 5 Documentation has been moved to the Epic Developer Community

HoloLens 2 Emulator Quick Start

Instructions for configuring and running the HoloLens 2 Emulator with Unreal Engine 4.

Choose your operating system:

Windows

macOS

Linux

Prerequisite Topics

In order to understand and use the content on this page, make sure you are familiar with the following topics:

HoloLens2Emulator.png

The HoloLens Emulator lets you test holographic applications on your PC without a physical HoloLens. The emulator uses a Hyper-V virtual machine. The human and environmental inputs that are usually read by Hololens sensors are simulated from your keyboard, mouse, or Xbox controller. Applications don't need to be modified to run on the emulator; applications don't know that they aren't running on a real HoloLens.

1 - Verify System Requirements

Steps

  1. Verify that you have installed the necessary prerequisites to run the HoloLens 2 Emulator. See HoloLens 2 Prerequisites for more information.

2 - Install the HoloLens 2 Emulator

Steps

  1. Download and install the HoloLens 2 Emulator .

    HL2EmulatorInstallationLink.png

  2. Review the default settings and proceed, but make sure to install the Emulator , the Emulator Image , and the Visual Studio Templates .

    HL2EmulatorInstallation_Items.png

  3. Once the HoloLens 2 Emulator is installed, you should see a success message. Click the Close button.

    hololens2eumlatorsuccess.png

If the emulator fails to install, review the HoloLens 2 Prerequisites.

3 - Run the HoloLens 2 Emulator

Steps

  1. Run the HoloLens 2 Emulator by pressing the Windows key, typing in HoloLens , and selecting HoloLens 2 Emulator .

    HoloLensEmulatorInMenu.png

  2. The HoloLens 2 Emulator loads into a separate window.
    HoloLens2Emulator.png

  3. Review the HoloLens 2 Emulator controls.

    • Walk forward, back, left, and right : Use the W,A,S, and D keys on your keyboard, or the left stick on an Xbox controller.

    • Look up, down, left, and right : Click and drag the mouse, use the arrow keys on your keyboard, or the right stick on an Xbox controller.

    • Air tap gesture : Right-click the mouse, press the Enter key on your keyboard, or use the A button on an Xbox controller.

    • Bloom/System gesture : Press the Windows key or F2 key on your keyboard or press the B button on an Xbox controller.

    • Hand movement for scrolling : Simultaneously hold the Alt key and the right mouse button, and drag the mouse up or down, or in an Xbox controller, hold the right trigger and A button down, and move the right stick up and down.

    • Hand movement and orientation : Hold the Alt key and drag the mouse up or down, left or right to move the hand, or use the arrow keys and Q or E to rotate, and tilt the hand. For an Xbox controller, hold the left or right bumper, and use the left thumbstick to move the hand left, right, forward, and back, the right thumbstick to rotate it, and up or down on the Dpad to raise or lower the hand.

4 - Install a Package to the HoloLens 2 Emulator

If you do not already have an app built and available for the HoloLens 2 Emulator, see Packaging an Unreal Project for the HoloLens 2 for more information on packaging for the HoloLens 2 Emulator.

In the steps below, you will load two files, an *.appxbundle file and an *.appx file. The *.appxbundle file is the game's package. The *.appx file is the dependency package containing supporting files for the target architecture (arm64 or x64). The dependency package only needs to be installed a single time per device. If you have already installed the dependency file, just continue with the installation without selecting an optional package. If you reflash your device, you'll lose everything that had been deployed to the device, including any dependency packages.

  1. From the right-hand menu, open the Device Portal for the HoloLens 2 Emulator.

    DevicePortalButton.png

  2. The Windows Device Portal will open up in a browser window.

    DevicePortal.png

  3. In the Windows Device Portal , select Views > Apps from the toolbar.

    DeployApps2.png

  4. Click the Choose File button, and browse to the location of your project, such as \Unreal Projects\TestProject\Hololens .

    ChooseFileButton.png

    BrowseToAppxPackage.png

  5. Select the .appxbundle file to specify the package you want to install.

    ChooseAppxBundle.png

  6. Select the Allow me to select optional packages option, and select Next .

    The *.appx file is the dependency package and only needs to be installed a single time per device. If you have already installed the dependency file, just continue with the installation without selecting an optional package.

    CheckSelectOptionalPackages.png

  7. Select the Choose File button, and browse to the location of your project, such as \Unreal Projects\TestProject\Hololens .

    ChooseOptionalPackage_ChooseFileButton.png

    BrowseToOptionalPackage.png

  8. Select the *.appx file for the platform you are targeting (x64 for the emulator, arm64 for the device), and click Next .

    ChooseAppx.png

  9. Click the Install button.

    InstallPackages_Emulator.png

  10. Wait for the app to finish installing.

    InstallationProgress.png Success_PackageRegistered.png

  11. Once the app installation is complete, scroll through All Apps on the Emulator to find your app.

    AllApps.png AppOnDevice.png

5 - On Your Own!

Now that you have your app installed on the HoloLens 2 Emulator, try running the app to load an Unreal Project.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss