README.md 4.7 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
### Furioos compatibility

30 31 32 33
**Unity Render Streaming** is also supported natively by **Furioos** platform https://www.furioos.com/ .
That means that you can easily build a Unity application, upload it on **Furioos** and enjoy all the features of **Unity Render Streaming** without worrying about the deployment and scalability issues of your project.

Please see [Furioos Tutorial](com.unity.renderstreaming/Documentation~/tutorial.md#deploy-to-furioos) section to find out how it works.
S
Samuel Tranchet 已提交
34

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

K
kazuki matsumoto 已提交
79
## Roadmap
80

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

## FAQ

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

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

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