|
1 |
| -# unity-cloud-reference-project |
2 |
| -Public slack channel: [#cloud-st-reference-project](https://unity.slack.com/messages/C04AT7P0FHT/) <br/> |
3 |
| -[View this project in Backstage](https://backstage.corp.unity3d.com/catalog/default/component/unity-cloud-reference-project) <br/> |
4 |
| -# Converting to public repository |
5 |
| -Any and all Unity software of any description (including components) (1) whose source is to be made available other than under a Unity source code license or (2) in respect of which a public announcement is to be made concerning its inner workings, may be licensed and released only upon the prior approval of Legal. |
6 |
| -The process for that is to access, complete, and submit this [FORM](https://docs.google.com/forms/d/e/1FAIpQLSe3H6PARLPIkWVjdB_zMvuIuIVtrqNiGlEt1yshkMCmCMirvA/viewform). |
| 1 | +# Unity Reference Project |
| 2 | + |
| 3 | +<img src="https://img.shields.io/badge/unity-2021.3.15-green.svg?style=flat-square" alt="unity 2021.3.15f1"> |
| 4 | + |
| 5 | +<img src="ReferenceProject/Packages/Documentation~/images/ucrp-scene-list.png" width="32%" /> <img src="ReferenceProject/Packages/Documentation~/images/ucrp-collab-1.png" width="32%" /> <img src="ReferenceProject/Packages/Documentation~/images/ucrp-collab-2.png" width="32%" /> |
| 6 | + |
| 7 | +## A Unity project for building a collaborative 3D design review tool |
| 8 | + |
| 9 | +> **Important**: Unity Reference project is an experimental project. For early access, contact your Unity Sales partner. |
| 10 | +
|
| 11 | +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. |
| 12 | + |
| 13 | +## Get support |
| 14 | + |
| 15 | +To connect and find support, join the [Unity forum](https://forum.unity.com/forums/unity-cloud.868/). |
| 16 | + |
| 17 | +### Supported platforms and files |
| 18 | + |
| 19 | +The Unity Reference Project is compatible with the [latest Unity Long Term Support](https://unity.com/releases/2021-lts) (LTS) and tested on the following platforms: |
| 20 | + |
| 21 | +- Windows |
| 22 | +- MacOS |
| 23 | +- iOS |
| 24 | +- Android |
| 25 | +- WebGL |
| 26 | +- Tethered VR headsets |
| 27 | + |
| 28 | +It supports the following file formats: `.3dm`, `.3ds`, `.3dxml`, `.asm`, `.catpart`, `.catproduct`, `.cgr`, `.dae`, `.dwg`, `.dxf`, `.fbx`, `.gds`, `.glb`, `.gltf`, `.iam`, `.ifc`, `.igs`, `.iges`, `.ipt`, `.jt`, `.neu`, `.nwc`, `.nwd`, `.obj`, `.par`, `.plmxml`, `.prc`, `.prt`, `.psm`, `.pvs`, `.pvz`, `.pxz`, `.pwd`, `.rfa`, `.rvt`, `.rvm`, `.sab`, `.sat`, `.sldasm`, `.sldprt`, `.step`, `.stepx`, `.stepz`, `.stl`, `.stp`, `.stpx`, `.stpxz`, `.stpz`, `.u3d`, `.usd`, `.usda`, `.usdc`, `.usdz`, `.vda`, `.vrml`, `.wrl`, `.xas`, `.xpr`. |
| 29 | + |
| 30 | +## Contents |
| 31 | + |
| 32 | +- [Unity Reference Project](#unity-reference-project) |
| 33 | + - [A Unity project for building a collaborative 3D design review tool](#a-unity-project-for-building-a-collaborative-3d-design-review-tool) |
| 34 | + - [Get support](#get-support) |
| 35 | + - [Supported platforms and files](#supported-platforms-and-files) |
| 36 | + - [Contents](#contents) |
| 37 | + - [Overview](#overview) |
| 38 | + - [Get the project](#get-the-project) |
| 39 | + - [Configure Unity services](#configure-unity-services) |
| 40 | + - [Sign into your Unity account](#sign-into-your-unity-account) |
| 41 | + - [Create an ID for your application](#create-an-id-for-your-application) |
| 42 | + - [Set the App Id in the Unity Editor](#set-the-app-id-in-the-unity-editor) |
| 43 | + - [Upload assets to review](#upload-assets-to-review) |
| 44 | + - [Open the project for the first time](#open-the-project-for-the-first-time) |
| 45 | + - [Run the project](#run-the-project) |
| 46 | + - [View 3D assets](#view-3d-assets) |
| 47 | + - [Manage assets](#manage-assets) |
| 48 | + - [Troubleshooting](#troubleshooting) |
| 49 | + - [You can't stream your asset](#you-cant-stream-your-asset) |
| 50 | + - [Bugs](#bugs) |
| 51 | + - [License](#license) |
| 52 | + - [Tell us what you think!](#tell-us-what-you-think) |
| 53 | + |
| 54 | +## Overview |
| 55 | + |
| 56 | +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. |
| 57 | + |
| 58 | +This project features Unity services that make it easier to: |
| 59 | + |
| 60 | +- Authenticate with your Unity account. |
| 61 | +- List and select an asset from cloud storage. |
| 62 | +- Stream a large 3D asset from cloud storage (vast support for 3D formats). |
| 63 | +- Collaborate online with voice chat and user avatars. |
| 64 | +- Share a deep-link to an asset for others to view. |
| 65 | + |
| 66 | +It also lets you customize your application. For example, you can: |
| 67 | + |
| 68 | +- Customize navigation modes. |
| 69 | +- Localize your application. |
| 70 | +- Add a view that you can toggle to troubleshoot performance. |
| 71 | +- Customize the user interface and tools. |
| 72 | +- Add and customize tools for VR. |
| 73 | + |
| 74 | +## Get the project |
| 75 | + |
| 76 | +* To get the Reference project, you can clone or download it. |
| 77 | + |
| 78 | +## Configure Unity services |
| 79 | + |
| 80 | +Configuring Unity services typically involves signing into your Unity account and registering your application. |
| 81 | + |
| 82 | +### Sign into your Unity account |
| 83 | + |
| 84 | +* To sign in, go to the [Asset Manager](https://dashboard.unity3d.com/digital-twins/). |
| 85 | + |
| 86 | +### Create an ID for your application |
| 87 | + |
| 88 | +For your application to function effectively with Unity streaming services and deep linking, you must first create an App Id. |
| 89 | + |
| 90 | +> **Important**: If you do not set an App Id, your project will fail to build. |
| 91 | +
|
| 92 | +To create an `App Id`, follow these steps: |
| 93 | + |
| 94 | +1. Log into the [Asset Manager](https://dashboard.unity3d.com/digital-twins/). |
| 95 | +2. Select **Developer Hub** > **Registered Applications**. |
| 96 | +3. Select the **+ Register an application**. |
| 97 | +4. Enter the application name in the **App Name** field. |
| 98 | +5. (Optional) Add a description for your application in the **Description** field. |
| 99 | +6. Select **Create**. |
| 100 | +7. Copy your `App Id` to your clipboard. |
| 101 | + |
| 102 | +#### Set the App Id in the Unity Editor |
| 103 | + |
| 104 | +To use the `App Id`, follow these steps: |
| 105 | + |
| 106 | +1. Open the Unity Reference Project in the Unity Editor. |
| 107 | +2. Go to **Edit > Project Settings > Unity Cloud > App Registration**. |
| 108 | +3. Paste your `App Id` in the **App Id** field. |
| 109 | +4. Select **Refresh** to update the application data in the Unity Cloud Portal. |
| 110 | + |
| 111 | +### Upload assets to review |
| 112 | + |
| 113 | +Before you can view assets in the Unity Reference Project, you must upload them to the portal. |
| 114 | + |
| 115 | +To access assets in a different organization, change organizations in the upper-right of the dashboard page. |
| 116 | + |
| 117 | +To upload an asset: |
| 118 | + |
| 119 | +1. In the [Asset Manager](https://dashboard.unity3d.com/digital-twins/), select **+ New**. |
| 120 | +2. Name the asset. |
| 121 | +3. Drag your 3D asset and its dependent files into the upload area. |
| 122 | +4. Select **Create**. |
| 123 | + |
| 124 | +Once the asset finishes processing, you can stream through the Unity Reference Project. |
| 125 | + |
| 126 | +## Open the project for the first time |
| 127 | + |
| 128 | +Once you have downloaded the project, follow these steps: |
| 129 | + |
| 130 | +1. Check that you have installed the [2021 LTS Unity Editor](https://unity.com/releases/2021-lts). |
| 131 | +2. To add the project to the Unity Hub, select **Open**. |
| 132 | +3. Select the folder called **ReferenceProject** in the downloaded repository. |
| 133 | + |
| 134 | +> **Note**: The first time you open the project, Unity will import all assets, including packages it depends on, which will take longer than usual. |
| 135 | +
|
| 136 | +4. [Set your App Id](#create-an-id-for-your-application). |
| 137 | +5. Open the `Main` scene (`Assets/_Application/Scenes/Main.unity`). |
| 138 | + |
| 139 | +## Run the project |
| 140 | + |
| 141 | +After you run the `Main` scene, you must sign in. |
| 142 | + |
| 143 | + |
| 144 | +### View 3D assets |
| 145 | + |
| 146 | +1. To open an asset in the viewer, select it from the list. |
| 147 | +2. (Optional) To move the camera, you can do any of the following: |
| 148 | + - select |
| 149 | + - touch |
| 150 | + - drag-and-drop |
| 151 | + - zoom in and out |
| 152 | + - scroll |
| 153 | + - pinch |
| 154 | +</br> To change the navigation mode, select the icon in the lower-left corner. |
| 155 | + |
| 156 | +### Manage assets |
| 157 | + |
| 158 | +1. To return to your asset list, select the folder icon in the upper-left corner. |
| 159 | +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. |
| 160 | +3. To sign out of your Unity account, select the avatar icon in the upper-right corner. |
| 161 | + |
| 162 | +## Troubleshooting |
| 163 | + |
| 164 | +### You can't stream your asset |
| 165 | + |
| 166 | +To correctly stream your asset, you need to [set your App Id](#create-an-id-for-your-application). |
| 167 | + |
| 168 | +## Bugs |
| 169 | + |
| 170 | +Report bugs in the Unity Reference Project using GitHub Issues. Report Unity Editor bugs using the [Unity bug submission process](https://unity3d.com/unity/qa/bug-reporting). |
| 171 | + |
| 172 | +## License |
| 173 | + |
| 174 | +For legal information or third-party license information, see [LICENSE.md](LICENSE.md). |
| 175 | + |
| 176 | +## Tell us what you think! |
| 177 | + |
| 178 | +Thank you for taking a look at the project! To help us improve and provide greater value, please consider providing [feedback on our forum](https://forum.unity.com/forums/unity-cloud.868/) about your experience with the Unity Reference Project. Thank you! |
0 commit comments