README.md 4.8 KB
Newer Older
1 2
# Unity Render Streaming

3
<img src="https://img.shields.io/badge/unity-2019.4-green.svg?style=flat-square" alt="unity 2019.4">
4

K
kazuki matsumoto 已提交
5
**Unity Render Streaming** is a solution that provides Unity's high quality rendering abilities via browser. It's designed to meet the needs of tasks like viewing car configurators or architectural models on mobile devices.  
6
This solution's streaming technology takes advantage of [WebRTC](https://webrtc.org/), and developers can even use the [WebRTC package](https://github.com/Unity-Technologies/com.unity.webrtc) to create their own unique solutions. 
7

8
<img src="com.unity.renderstreaming/Documentation~/images/browser_hdrpscene.png" width=500 align=center>
9

K
Kazuki Matsumoto 已提交
10
This repository manages 1 package and 2 templates. Details can be found in the `README.md` for each package.
11

K
Kazuki Matsumoto 已提交
12
- [com.unity.template.renderstreaming-hd](com.unity.template.renderstreaming-hd/Packages/com.unity.template.renderstreaming-hd/README.md)
13
- [com.unity.template.renderstreaming-rtx](com.unity.template.renderstreaming-rtx/Packages/com.unity.template.renderstreaming-rtx/README.md)
14
- [com.unity.renderstreaming](com.unity.renderstreaming/README.md)
K
Kazuki Matsumoto 已提交
15 16 17 18 19

## Branch

| Branch                                                                                         | Status         |
| ---------------------------------------------------------------------------------------------- | -------------- |
20
| [release/2.1.0](https://github.com/Unity-Technologies/UnityRenderStreaming/tree/release/2.1.0) | Stable         |
K
Kazuki Matsumoto 已提交
21
| [develop](https://github.com/Unity-Technologies/UnityRenderStreaming/tree/develop)             | In development |
22

23
## Requirements
K
kazuki matsumoto 已提交
24

25
Please see [Requirements](com.unity.renderstreaming/Documentation~/index.md#requirements) section.
K
kazuki matsumoto 已提交
26

S
Samuel Tranchet 已提交
27 28 29 30 31 32 33 34
### Furioos compatibility

**Unity Render Streaming** is also supported natively by Furioos platform https://www.furioos.com/ .
That means that you can easily build a RenderStreaming application, upload it on Furioos and enjoy all the features of RenderStreaming without worrying about the deployment and scalability issues of your project.
To do so, the requirement is to select "FurioosSignaling" in the "Signaling server type" parameter of the RenderStreaming script.
This allow your application to connect to Furioos services when running on the managed virtual machines.
Then just build a standalone Windows version of your application, zip it and upload it on your account at https://portal.furioos.com/ .

K
kazuki matsumoto 已提交
35 36
### License

37
- `com.unity.renderstreaming` -  [LICENSE.md](com.unity.renderstreaming/LICENSE.md)
K
kazuki matsumoto 已提交
38

K
Kazuki Matsumoto 已提交
39 40
- `com.unity.template.renderstreaming-hd` -  [LICENSE.md](com.unity.template.renderstreaming-hd/Packages/com.unity.template.renderstreaming-hd/LICENSE.md)

41
- `com.unity.template.renderstreaming-rtx` -  [LICENSE.md](com.unity.template.renderstreaming-rtx/Packages/com.unity.template.renderstreaming-rtx/LICENSE.md)
K
kazuki matsumoto 已提交
42 43

## Package Structure
44 45 46

```
<root>
47 48 49 50 51 52 53 54 55 56 57 58
├── com.unity.renderstreaming
│   ├── Documentation~
│   ├── Editor
│   └── Samples~
├── com.unity.template.renderstreaming-hd
│   ├── Assets
│   │   ├── Plugins
│   │   ├── Scenes
│   │   ├── Scripts
│   │   └── Tests
│   ├── Packages
│   └── ProjectSettings
K
Kazuki Matsumoto 已提交
59 60 61 62 63 64 65 66
├── com.unity.template.renderstreaming-rtx
│   ├── Assets
│   │   ├── Plugins
│   │   ├── Scenes
│   │   ├── Scripts
│   │   └── Tests
│   ├── Packages
│   └── ProjectSettings
K
Kazuki Matsumoto 已提交
67
├── EmptyProjectForTest~
68
├── RenderStreamingSampleSrc~
69 70
|   ├── RS_HDRPSampleSrc_1.x
│   └── RS_URPSampleSrc_1.x
71
└── WebApp
72 73 74
    ├── public
    ├── src
    └── test
75 76
```

K
kazuki matsumoto 已提交
77
## Roadmap
78

79 80 81 82 83 84 85 86 87
| Version | Focus                                                   |
| ------- | ------------------------------------------------------- |
| `1.0`   | - First release                                         |
| `1.1`   | - Upgrade HDRP version 5.16                             |
| `1.2`   | - Unity 2019.3 support                                  |
| `2.0`   | - Multi camera <br>- DirectX12 (DXR) Support            |
| `2.1`   | - Unity 2019.4 support <br>- Add bitrate control sample |
| `2.2`   | - Add video receiver <br>- HDRP/URP on Linux support    |
| `2.3`   | - Gyro input remote control <br>- iOS platform sample   |
88 89 90

## FAQ

K
Kazuki Matsumoto 已提交
91
Read [this page](com.unity.renderstreaming/Documentation~/faq.md) and [Unity Forum](https://forum.unity.com/forums/unity-render-streaming.413/)
92

K
kazuki matsumoto 已提交
93
## Contributors
94 95 96

- [@karasusan](https://github.com/karasusan)
- [@hiroki-o](https://github.com/hiroki-o)
K
Kazuki Matsumoto 已提交
97
- [@flame99999](https://github.com/flame99999)
98
- [@koseyile](https://github.com/koseyile)
99
- [@sindharta](https://github.com/sindharta)
K
Kazuki Matsumoto 已提交
100
- [@kannan-xiao4](https://github.com/kannan-xiao4)
S
Samuel Tranchet 已提交
101
- [@samuel-tranchet](https://github.com/samuel-tranchet)