Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion com.unity.renderstreaming/Documentation~/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Please check [this page](samples.md).

## Project template

Project templates are on the [GitHub repository](https://github.com/Unity-Technologies/UnityRenderStreaming).
Project templates are on the [**GitHub Release** page](https://github.com/Unity-Technologies/UnityRenderStreaming/releases/tag/3.0.2-preview). Please see [this instruction](template.md).

## Furioos compatibility

Expand Down
63 changes: 63 additions & 0 deletions com.unity.renderstreaming/Documentation~/template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# Unity Render Streaming Template

This document describes the way to start using the template package of Unity Render Streaming.

### Download the Package

Download the template package from [Github Release](https://github.com/Unity-Technologies/com.unity.webrtc/releases). Please download the package below.

- `com.unity.template.renderstreaming-x.x.x-preview.tgz`

![Download template package](images/download_template_package.png)

> [!NOTE]
> This process made for temporary use. It is not needed if these packages are registered to PackageManager in the future.

### Install the package

Put the package in a dedicated folder in order to use them as a project template.
The project template can be selected as a template when creating a new Unity project.

![Template unityhub](images/template_in_unityhub.png)

When using the template package, put the tgz file in the following folders.
Move `com.unity.template.renderstreaming-x.x.x-preview.tgz` to this folder

```
<Unity Editor Root>/Data/Resources/PackageManager/ProjectTemplates
```

After moving the packages, open the Unity Hub and create a new project. Confirm that `Render Streaming` has been added as a template.

### Launch the Web application

To launch web application, Select an item **Edit / Render Streaming / Download web app** from the menu bar.

![Menu download webapp](images/download_webapp.png)

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.

![Launch Web Server command](images/launch_webserver_public_mode_on_windows.png)

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.

### Unity Settings

Open the `Assets/Scenes/samplescene.unity` sample scene.

![HDRP scene](images/hdrpscene.png)

Select `RenderStreaming` in the Hierarchy. Check the `Render Streaming` components in the Inspector.

![Render Streaming inspector](images/renderstreaming_inspector.png)

Set the address of the web server you just activated under the `URL Signaling` parameter. For details on the various settings in the Inspector.

### Accessing the Web Page

Launch one of the [supported browsers](../index.md) from the list.
Access the Web server's address. The following web page will be displayed.

![Browser HDRP scene](images/browser_hdrpscene.png)

If this doesn't happen, it's possible that the browser version is too old. Be sure to install the latest version.
11 changes: 8 additions & 3 deletions com.unity.renderstreaming/Documentation~/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,10 +61,15 @@ When the select download folder window appears, click on `Select Folder` to down

![Select Download folder](images/select_download_folder.png)

After the download is finished and a new explorer window is opened, click on `webserver.exe` to start
Unity RenderStreaming web server.
After the download is finished and a `powershell` or `cmd` window is opened, and run `webserver.exe` with `-w` option. Please refer to [this page](webapp.md) for commandline options.

![Web Server](images/webserver.png)
```
.\webserver.exe -w
```

You can see logs on the commandline like below.

![Launch web server](images/launch_webserver_public_mode_on_windows.png)

## Install samples

Expand Down