Skip to content

Commit 4ddb9bb

Browse files
committed
Release 0.1.0
develop @7cd97d0c0b93b241887bf3268a65350095cc2090
1 parent f050c77 commit 4ddb9bb

File tree

1,510 files changed

+69403
-48
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,510 files changed

+69403
-48
lines changed

.gitattributes

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Collapse Unity-generated files on GitHub
2+
*.asset linguist-generated
3+
*.mat linguist-generated
4+
*.meta linguist-generated
5+
*.prefab linguist-generated
6+
*.unity linguist-generated
7+
8+
# com.unity.coding
9+
* text=auto eol=lf
10+
11+
# match .editorconfig
12+
*.vcproj eol=crlf
13+
*.bat eol=crlf
14+
*.cmd eol=crlf
15+
*.xaml eol=crlf
16+
*.tt eol=crlf
17+
*.t4 eol=crlf
18+
*.ttinclude eol=crlf
19+
20+
*.vcxproj eol=crlf
21+
*.vcxproj.filters eol=crlf
22+
23+
*.csproj eol=crlf
24+
*.pyproj eol=crlf
25+
*.props eol=crlf
26+
*.targets eol=crlf
27+
28+
*.sln eol=crlf
29+
*.sln.template eol=crlf

.github/workflows/validate_catalog.yaml

Lines changed: 0 additions & 22 deletions
This file was deleted.

.gitignore

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
**/TMP_NO_VERSIONING/*
2+
**/TMP_NO_VERSIONING*
3+
4+
**/Plugins/Editor/JetBrains*
5+
**/node_modules/**
6+
7+
.yamato/unfolded/**
8+
.Editor/**
9+
artifacts/**
10+
build/**
11+
.build_script/**
12+
node_modules/**
13+
.DS_Store
14+
.npmrc
15+
!Documentation~
16+
!.Documentation
17+
npm-debug.log
18+
build.sh.meta
19+
build.bat.meta
20+
.idea/
21+
.vs/
22+
.vscode/
23+
24+
[Ll]ibrary/
25+
[Tt]emp/
26+
[Ll]ogs/
27+
[Oo]bj/
28+
[Bb]uilds/
29+
30+
*.csproj
31+
*.csproj.meta
32+
*.unityproj
33+
*.sln
34+
*.suo
35+
*.tmp
36+
*.user
37+
*.userprefs
38+
*.pidb
39+
*.booproj
40+
*.svd
41+
*.pdb
42+
*.opendb
43+
*.keystore
44+
ReferenceProject/obj
45+
ReferenceProject/UserSettings
46+
!Native~
47+
!**/Native~/**/*.sln
48+
Native~/**/x64/
49+
50+
#Fastlane
51+
ReferenceProject/builds/**
52+
ReferenceProject/.idea/*
53+
ReferenceProject/Assets/Unity Cloud/Resources
54+
ReferenceProject/Assets/Unity Cloud/Resources.meta
55+
ReferenceProject/Assets/Unity Cloud.meta
56+
57+
ReferenceProject/Assets/Samples
58+
ReferenceProject/Assets/Samples.meta
59+
ReferenceProject/UIElementsSchema

LICENSE.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Unity Cloud Reference Project © 2023 Unity Technologies.
2+
3+
This software is subject to, and made available under, the Unity Terms of Service (see https://unity.com/legal). Your use of this software constitutes your acceptance of such terms.
4+
5+
Unless expressly provided otherwise, the software under this license is made available strictly on an “AS IS” BASIS WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. Please review the Terms of Service for details on these and other terms and conditions.

README.md

Lines changed: 178 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,178 @@
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!

ReferenceProject/Assets/AddressableAssetsData.meta

Lines changed: 8 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)