|
| 1 | +# Unity Render Streaming Template |
| 2 | + |
| 3 | +This document describes the way to start using the template package of Unity Render Streaming. |
| 4 | + |
| 5 | +### Download the Package |
| 6 | + |
| 7 | +Download the template package from [Github Release](https://github.com/Unity-Technologies/com.unity.webrtc/releases). Please download the package below. |
| 8 | + |
| 9 | +- `com.unity.template.renderstreaming-x.x.x-preview.tgz` |
| 10 | + |
| 11 | + |
| 12 | + |
| 13 | +> [!NOTE] |
| 14 | +> This process made for temporary use. It is not needed if these packages are registered to PackageManager in the future. |
| 15 | +
|
| 16 | +### Install the package |
| 17 | + |
| 18 | +Put the package in a dedicated folder in order to use them as a project template. |
| 19 | +The project template can be selected as a template when creating a new Unity project. |
| 20 | + |
| 21 | + |
| 22 | + |
| 23 | +When using the template package, put the tgz file in the following folders. |
| 24 | +Move `com.unity.template.renderstreaming-x.x.x-preview.tgz` to this folder |
| 25 | + |
| 26 | +``` |
| 27 | + <Unity Editor Root>/Data/Resources/PackageManager/ProjectTemplates |
| 28 | +``` |
| 29 | + |
| 30 | +After moving the packages, open the Unity Hub and create a new project. Confirm that `Render Streaming` has been added as a template. |
| 31 | + |
| 32 | +### Launch the Web application |
| 33 | + |
| 34 | +To launch web application, Select an item **Edit / Render Streaming / Download web app** from the menu bar. |
| 35 | + |
| 36 | + |
| 37 | + |
| 38 | +Be shown the command prompt when execute the file. Confirm that the following log displays in the command prompt. The web server's address should be displayed. Details on web server command options can be found on the [Web server](webserver.md) page. |
| 39 | + |
| 40 | + |
| 41 | + |
| 42 | +The web server's source code is located in the `WebApp` folder. Additionally, [Node.js](https://nodejs.org) must be installed in order to run the source code. Download the installer from the website. |
| 43 | + |
| 44 | +### Unity Settings |
| 45 | + |
| 46 | +Open the `Assets/Scenes/samplescene.unity` sample scene. |
| 47 | + |
| 48 | + |
| 49 | + |
| 50 | +Select `RenderStreaming` in the Hierarchy. Check the `Render Streaming` components in the Inspector. |
| 51 | + |
| 52 | + |
| 53 | + |
| 54 | +Set the address of the web server you just activated under the `URL Signaling` parameter. For details on the various settings in the Inspector. |
| 55 | + |
| 56 | +### Accessing the Web Page |
| 57 | + |
| 58 | +Launch one of the [supported browsers](../index.md) from the list. |
| 59 | +Access the Web server's address. The following web page will be displayed. |
| 60 | + |
| 61 | + |
| 62 | + |
| 63 | +If this doesn't happen, it's possible that the browser version is too old. Be sure to install the latest version. |
0 commit comments