Untitled

📰Getting Started | ⭐**Updates |** 📝 Guides | 🔢 API | ❓FAQ

Guides Overview

Environment Setup

Clone enklu/enkluplayer

  1. Confirm you have access to Enklu's enkluplayer repository.

  2. If you use a Git GUI like Sourcetree, the cloning process should look something like this:

    1. Select Clone at the top

    2. Input enkluplayer's clone HTTPS URL: https://github.com/enklu/enkluplayer.git which can be found on the repo's GitHub page:

      Untitled

    3. Chose the destination for the repository to be cloned to

      https://s3-us-west-2.amazonaws.com/secure.notion-static.com/988fa818-dc68-4a23-adf0-f541ec887c78/clone1.png

    4. Press the Clone button at the bottom, and wait for the repo to clone locally.

  3. Verify you can see the cloned repo either in your Git GUI or in the chosen destination location

    https://s3-us-west-2.amazonaws.com/secure.notion-static.com/9da12fcc-25a3-42c6-8a28-125fdda21709/clone2.png

Install and Setup Unity

  1. Open Unity Hub.

  2. Select Installs and verify that you have the correct Unity version installed (Found in "enkluplayer/README.md"). The current version should be Unity 2019.4.17.

  3. If you do not have the correct version, install the correct Unity version by selecting Add and choosing the correct version. (if it's not listed, go to the Unity Download Archive and launch it into UnityHub from there)

  4. When installing, include packages: UWP, WebGL, Android, iOS, and Windows (IL2CPP).

  5. After the Unity install is complete, return to Projects.

  6. Open your enkluplayer Unity project by clicking Add:

    https://s3-us-west-2.amazonaws.com/secure.notion-static.com/76c21bd5-ba93-4c8f-a0b0-9faad9ff27a8/unity0.png

  7. Navigate to enkluplayer-uwp and click Select Folder:

    https://s3-us-west-2.amazonaws.com/secure.notion-static.com/1cf70437-60bc-42e6-ab73-9194c0c598d1/Unity1.png

  8. Open the enkluplayer-uwp from Unity Hub, and wait for Unity to load

  9. You should see your Unity project open:

    https://s3-us-west-2.amazonaws.com/secure.notion-static.com/da8324ba-8090-4d3a-a44a-277cad914e09/Unity3.png

Install HoloLens Build Tools

  1. Follow the instructions on the Install The Tools Mixed Reality Site. You can install the emulator and simulator if you'd like but they aren't necessary. At a minimum, you need the following:
    1. Install Visual Studio (2019 16.8 or higher)
      1. Make sure to select MSVC v141 - VS 2017 C++ build tools
    2. Install **Windows 10 SDK (10.0.18362.0) ** BE SURE NOT TO INSTALL THE LATEST*****
  2. Use the default options, make sure the Universal Windows Platform development option is checked, and finish the installation.

Building EnkluPlayer for HoloLens (2 Options)

enkluplayer-uwp via MRTK Build Window (Option 1)

There is now an easier / quicker method for every day builds: Mixed Reality > Toolkit > Utilities > Build Window

  1. Under Unity Build Options, set the Target Device to HoloLens

  2. Under Appx Build Options, make sure you have set Build Platform to ARM64 (for HoloLens 2)

  3. Under Deploy Options set the Target Type to Remote and enter IP, Username and Password (same as when you connect via Device Portal)

  4. Make sure your HoloLens2 is turned on and press Test Connection - you should get a "Successful connection to ..." message

    https://s3-us-west-2.amazonaws.com/secure.notion-static.com/254de318-6592-4249-8924-0e3d29ba4f34/Untitled.png

  5. Press Build all (after the first build this will change to Build all, then install)

  6. Once complete the new build will show up at the bottom of the Deploy Options page and you can Install and Launch it from there! Also take note of the View Player Log button.

    https://s3-us-west-2.amazonaws.com/secure.notion-static.com/83d49d73-654f-4512-a8ca-5ca53df6d47a/Untitled.png

Building through Unity and Visual Studio (Option 2)

  1. Open the build menu with File > Build Settings. Universal Windows Platform should be selected already.

  2. (Optional) Enable Development Build, Autoconnect Profiler, and Script Debugging if you want to create a debug build that the Unity profiler can connect to. As always, more debugging increases the performance impact that Unity has on the generated build.

  3. Click Build and select a folder outside of the Unity Assets folder to build into. This will take several minutes, do not close Unity or turn off your computer during this time.

  4. Navigate to the folder generated, and open the solution file generated. This must be opened in Visual Studio, as other IDEs cannot generate the HoloLens build archives.

  5. In the Solution Explorer right click the Enklu (Universal Windows) project and select Publish > Create app packages...

    https://s3-us-west-2.amazonaws.com/secure.notion-static.com/4b516b7c-fea3-4b85-bd4e-6fc70131782e/b05f36f8-1763-484b-ba49-e57cf885b7a9.png

  6. Select Sideloading and continue.

  7. Use the default certificate for now.

  8. On the package configuration view, set the version number as appropriate, set app bundle generation to Always, and select the proper architecture for your device. HoloLens 2 can run ARM64 while HoloLens 1 runs x86. Production builds use the Master configuration while development builds need to run as Release. (Master builds tend to take longer to create, but can be slightly more performant)

  9. Press Create at the bottom and Visual Studio will generate the app packages. This will take several minutes. Do not close Visual Studio or turn off your computer during this process.

https://s3-us-west-2.amazonaws.com/secure.notion-static.com/1154c9c0-3eba-4db4-ba0d-50079038c83e/048ba7df-d526-44f5-b4bd-51d07ec172a3.png

Sideloading onto HoloLens 2

Finding your IPv4 Address

  1. Startup your HoloLens 2
  2. Press Menu, and then All Apps
  3. Navigate to Network Settings > Advanced under the Wi-Fi network your HoloLens is currently connected to.
  4. Scroll down until you see "IPv4 Address," and remember or write it down to use in the next step.
    1. Alternatively, you can use the built-in voice command "What is my IP?" and a system message should display with the device's current IP address.

Pairing the headset

  1. In your browser, type the IPv4 address you found into the navigation window and hit enter.

  2. You should then see a screen then see a login dialog box or a Setup access screen. If you instead see an "Unsafe connection" or similar screen, click Advanced at the bottom and Proceed anyway.

  3. If you see a login dialog box at the top...

    1. And you have device pairing credentials already, input your device pairing credentials here

    2. But you have never paired your device and therefore have no credentials to input. To create new credentials, purposefully fail the log in 3 times and it will bring you to a Setup access screen

    3. Failing the login will cause your browser to bring up the following window to request a new PIN:

      https://lh6.googleusercontent.com/LW96k13MBlEljU-05NGaJq0uH0EgKTKrbEJHBINP5jzZ593l0mslvU3YbI7LbxmlcV_gmj1ZttfvEPyTI8XVp_N0zUH7QPO5tszfua5diepk20mfzP97tYxiNZQXOox3lxiVo5V-

    4. Requesting a pin will display a code in the lens that you need to input on this page. Then set up your username and password and submit the form.

    5. Now you should be able to retype your IPv4 address into your browser URL bar and use the username and password you just created to log into the device portal.

  4. Navigate to Views / Apps

  5. Choose the file you wish to sideload and click Install

    https://s3-us-west-2.amazonaws.com/secure.notion-static.com/680c99e2-19ba-47b4-98c9-27f62b02544b/Untitled.png

  6. Once it has finished installing, launch it from within the HoloLens or from the list of Installed apps on the Device Portal.

Next: Scripting Overview

Sidebar Table of Contents

Untitled