Compatibility with Relay Server

Only use komodo-unity v0.5.0 and up if you are using komodo-relay v1.1.0 and up. Read more:

• https://github.com/gelic-idealab/komodo-unity/pull/80#issuecomment-958175441
• https://github.com/gelic-idealab/komodo-relay/releases/tag/v1.1.0

Installation

Install Unity. If it’s not already installed, install Unity version 2020.x. Make sure to check the box for WebGL Build Support.

Create a WebGL Project. Create a new Unity project, version 2020.x, type 3D, name [YourProjectName]. Choose File > Build Settings. Choose WebGL under Platform. Select Switch Platform.

Add Scoped Registries to manifest.json. In File Explorer, open [YourProjectName] > Packages > manifest.json.

Edit the file to add the following two scoped registries:

{ // this is the beginning of manifest.json  
  "scopedRegistries": [
    {
      "name": "Packages from jillejr",
      "url": "https://npm.cloudsmith.io/jillejr/newtonsoft-json-for-unity/",
      "scopes": [
        "jillejr"
      ]
    },
    {
      "name": "OpenUPM",
      "url": "https://package.openupm.com",
      "scopes": [
        "com.de-panther",
        "com.atteneder",
        "com.graingeridealab"
      ]
    }
  ],
  "dependencies": {
    //... (these are dependencies that are already in the file)
  }
} // this is the end of manifest.json

JSON does not support comments, so take out all // and everything after them. [1]

Save the file and return to the Unity Editor. Unity should alert you that two new scoped registries are available. [2]

Install KomodoCore. In the Unity Editor main window, choose Window > Package Manager. Click the [ Packages: In Project v ] (the second dropdown) in the upper left. Look for the entry GELIC-IDEALab > KomodoCore. Select Install. Wait for the package to be loaded, then skip to “Add Scenes.” This method of installing KomodoCore uses OpenUPM, but there are two alternative installation methods. [3]

Copy WebGLTemplates. Select Window > Komodo > Copy WebGLTemplates. In the Project window, there should now be a folder under Assets titled “WebGLTemplates.”

Add Scenes. Go to File > Build Settings. Add Packages/KomodoCore/KomodoCoreAssets/Scenes/Main and Packages/KomodoCore/KomodoCoreAssets/Scenes/Outdoors/Outdoors to Scenes in Build.

Select the Komodo WebXR Template. While still in the Build Settings window, choose Player Settings…. Make sure the tab selected is the WebGL icon. Expand the Resolution and Presentation panel. Select KomodoWebXRFullView in the WebGL templates option. [4]

Test the project. Press [ > ] (the play button at the center top of the Unity Editor). Check the console for errors. If it runs without errors, congratulations!

Develop a module with KomodoCore. Follow the Guide to Developing Modules with Komodo. [6]

Footnotes

1. If for some reason the above is not up-to-date, the latest version of the scoped registries can always be found in the development repository — komodo-unity/Komodo/Packages/manifest.json.

2. If not, go to Edit > Project Settings > Package Manager > Scoped Registries and check to see that Packages from jillejr and OpenUPM are listed and reflect the structure of manifest.json.

3. Alternative install methods:

   1. If you have downloaded the Komodo package manually Click [ + v ] (the plus-button dropdown) in the upper left. Choose Add package from disk… Find and select [KomodoPackageLocation]/KomodoCore/package.json. Wait for the package to be loaded, then skip to “Add Scenes.”

   2. If you have downloaded or cloned the komodo-unity repository Click [ + v ] (the plus-button dropdown) in the upper left. Choose Add package from disk…. Find and select komodo-unity/Komodo/Assets/Packages/KomodoCore/package.json. Wait for the package to be loaded, then skip to “Add Scenes.”

4. If you only see Default and Minimal as options, the WebGLTemplates folder did not copy properly.

5. TODO — add Unity manual link here.

6. TODO — add link to this guide, which will detail how to perform Unity-level changes, Configuration- and Extension-level changes, and Package-level changes to the Komodo project. Until then, know that when you are using Komodo with your own server, you should change relay.js so that API_BASE_URL and RELAY_BASE_URL point to your own komodo-portal and komodo-relay deployments. If you are developing on the University of Illinois campus, please contact idealab@library.illinois.edu to request access to the Komodo development server connection credentials.

Licenses and Attributions

Komodo Astronaut is remixed from Astronaut by Poly by Google and licensed under CC-BY 3.0.

Low Poly Trees - Pack by LMHPOLY is licensed under a custom license.

VR UI Kit: Material Design System by Space Bear, Inc: the license can be found in <projectLocation>\Packages\KomodoCore\KomodoCoreAssets\Text\Fonts - VRUI - Material Design\Roboto\LICENSE.txt or here.

WorldSkies Free Skybox Pack is by PULSAR BYTES.

Sandpaper is from Toptal Subtle Patterns

Contains Tiles084 from AmbientCG.com, licensed under CC0 1.0 Universal.

De-Panther / unity-webxr-export is licensed under the Apache License 2.0.

atteneder / glTFast is licensed under the Apache License 2.0.

Siccity / GLTFUtility is licensed under the MIT License.

googlevr / tilt-brush-toolkit is licensed under the Apache License 2.0.

socketio / socketio is licensed under the MIT License.

vpenades / SharpGLTF is licensed under the MIT License.

SixLabors / ImageSharp is licensed under the Apache License 2.0.