README.md 5.0 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
<img src="https://img.shields.io/badge/unity-2020.2-green.svg?style=flat-square" alt="unity 2020.2">
5

K
kazuki matsumoto 已提交
6
**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.  
7
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. 
8

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

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

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

## Branch

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

24
## Requirements
K
kazuki matsumoto 已提交
25

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

S
Samuel Tranchet 已提交
28 29 30 31 32 33 34 35
### 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 已提交
36 37
### License

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

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

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

## Package Structure
45 46 47

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

K
kazuki matsumoto 已提交
80
## Roadmap
81

82 83 84 85 86 87 88 89
| 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    |
90 91
| `3.0`   | - iOS platform support <br>- AR Foundation sample       |
| `3.1`   | - Android platform support                              |
92 93 94

## FAQ

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

K
kazuki matsumoto 已提交
97
## Contributors
98 99 100

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