HopeBing/unity-cloud-reference-project

A Unity project for building an immersive experience to facilitate interactive real-time 3D design reviews

Unity Reference Project

A Unity project for building a collaborative 3D design review tool

Important: Unity Reference project is an experimental project. For early access, contact your Unity Sales partner.

The Unity Reference Project is a fully functional collaborative design review tool for 3D assets. It's a Unity project that you can build on to create your own custom viewer application. It also lets you take advantage of any improvements that Unity publishes to GitHub.

Get support

To connect and find support, join the Unity forum.

Supported platforms

The Unity Reference Project is currently compatible with Unity Editor 2021.3.15f1 (LTS) and will occassionally be updated to support newer versions. Builds are tested on the following platforms:

• Windows
• MacOS (Intel and Apple Silicon)
• iOS
• Android
• WebGL
• Tethered VR headsets

Contents

• Unity Reference Project
  • A Unity project for building a collaborative 3D design review tool
  • Get support
    • Supported platforms and files
  • Contents
  • Overview
  • Prerequisites
  • Get the project
  • Configure Unity services
    • Sign into your Unity account
    • Create an ID for your application
      • Set the App Id in the Unity Editor
    • Upload assets to review
  • Open the project for the first time
    • Setup VR
  • Run the project
    • View 3D assets
    • Manage assets
  • Troubleshooting
    • You can't stream your asset
  • Bugs
  • License
  • Tell us what you think!

Overview

The Unity Reference Project is a Unity project intended to be used as a starting point for building a collaborative 3D asset review tool. It can be built for many platforms, including WebGL, making it highly accessible and simple to share. The Unity Reference Project is designed to be highly customizable so you can add, remove, or change its features, tools, and UI; while still being able to pull in the latest updates with minimal conflicts.

This project lets you customize your application. For example, you can:

• Customize navigation modes.
• Localize your application.
• Add a view that you can toggle to troubleshoot performance.
• Customize the user interface and tools.
• Add and customize tools for VR.

It also leverages Unity services that make it easier to:

• Authenticate with your Unity account.
• List and select an asset from cloud storage.
• Stream a large 3D asset from cloud storage (vast support for 3D formats).
• Online multiplayer collaboration.
• Share a deep-link to an asset for others to view.

Prerequisites

MacOS

To open this Unity project on MacOS, you must have the Xcode command line tools installed.

1. Open the Terminal app on MacOS
2. Enter the following command xcode-select --install

Get the project

• To get the Reference project, you can clone or download it.

Configure Unity services

Configuring Unity services typically involves signing into your Unity account and registering your application.

Sign into your Unity account

Important: The packages used in this project recently switched to services hosted on Azure. When you sign in, ensure the toggle next to the Sign In button says Using Azure. If you were using a release prior to version 0.2.0 then you will need to register a new App Id and upload your assets to be processed again.

• To sign in, go to the Digital Twin dashboard.

Create an ID for your application

For your application to function effectively with Unity streaming services and deep linking, you must first create an App Id.

Important: If you do not set an App Id, your project will fail to build.

To create an App Id, follow these steps:

1. Log into the Digital Twin dashboard and ensure you have selected "Using Azure".
2. Select Developer Hub > Registered Applications.
3. Select the + Register an application.
4. Enter the application name in the App Name field.
5. (Optional) Add a description for your application in the Description field.
6. Select Create.
7. Copy your App Id to your clipboard.

Set the App Id in the Unity Editor

To use the App Id, follow these steps:

1. Open the Unity Reference Project in the Unity Editor.
2. Go to Edit > Project Settings > Unity Cloud > App Registration.
3. Paste your App Id in the App Id field.
4. Select Refresh to update the application data in the Unity Cloud Portal.

Upload assets to review

Before you can view assets in the Unity Reference Project, you must upload them to the portal.

To access assets in a different organization, change organizations in the upper-right of the dashboard page.

To upload an asset:

1. In the Digital Twin dashboard, select + New.
2. Name the asset.
3. Drag your 3D asset and its dependent files into the upload area.
4. Select Create.

Once the asset finishes processing, you can stream through the Unity Reference Project.

Open the project for the first time

Once you have downloaded the project, follow these steps:

1. Check that you have installed the 2021 LTS Unity Editor.
2. To add the project to the Unity Hub, select Open.
3. Select the folder called ReferenceProject in the downloaded repository.

Note: The first time you open the project, Unity will import all assets, including packages it depends on, which will take longer than usual.

4. Set your App Id.
5. Open the Main scene (Assets/_Application/Scenes/Main.unity).

Setup VR

To enable VR navigation, follow these steps:

1. Activate the OpenXR plug-in by going to Edit > Project Settings > XR Plug-in Management.
2. Ensure that Initialize XR on Startup is unchecked.
3. Your VR hardware must be connected prior to running the app in order to be detected.
4. (Optional) To launch the app in VR, use the MainVR scene found in Assets/_VR/_Applications/Scenes.

Run the project

After you run the Main scene, you must sign in.

View 3D assets

• To open an asset in the viewer, select it from the list.
• To move the camera, you can do any of the following:
  • select
  • touch
  • drag-and-drop
  • zoom in and out
  • scroll
  • pinch
• To change the navigation mode, select the icon in the lower-left corner.

Manage assets

1. To return to your asset list, select the folder icon in the upper-left corner.
2. If you need to access personal settings, select the cog icon in the top-right corner. From there, you can change between English and French localization or toggle the display of frame rate information.
3. To sign out of your Unity account, select the avatar icon in the upper-right corner.

Troubleshooting

You can't stream your asset

To correctly stream your asset, you need to set your App Id.

Bugs

Report bugs in the Unity Reference Project using GitHub Issues. Report Unity Editor bugs using the Unity bug submission process.

License

For legal information or third-party license information, see LICENSE.md.

Tell us what you think!

Thank you for taking a look at the project! To help us improve and provide greater value, please consider providing feedback on our forum about your experience with the Unity Reference Project. Thank you!