未验证 提交 64ea3423 编写于 作者: K Kazuki Matsumoto 提交者: GitHub

doc: Fixed documents to upgrade package version 2.1.0 (#320)

* update documents

* Updated changelog

* upgrade package version
上级 c1888026
# Unity Render Streaming
<img src="https://img.shields.io/badge/unity-2019.3-green.svg?style=flat-square" alt="unity 2019.3">
<img src="https://img.shields.io/badge/unity-2019.4-green.svg?style=flat-square" alt="unity 2019.4">
**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.
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.
......@@ -17,34 +17,12 @@ This repository manages 1 package and 2 templates. Details can be found in the `
| Branch | Status |
| ---------------------------------------------------------------------------------------------- | -------------- |
| [release/2.0.2](https://github.com/Unity-Technologies/UnityRenderStreaming/tree/release/2.0.2) | Stable |
| [release/2.1.0](https://github.com/Unity-Technologies/UnityRenderStreaming/tree/release/2.1.0) | Stable |
| [develop](https://github.com/Unity-Technologies/UnityRenderStreaming/tree/develop) | In development |
## Operating Environment
## Requirements
This solution is compatible with `Unity 2019.3`.
| Platform | Graphics API | Hardware Encoder | Software Encoder |
| ----------- | ------------ | ------------------------------------------------- | ------------------ |
| Windows x64 | DirectX11 | :white_check_mark: (Require NVIDIA Graphics card) | :white_check_mark: |
| Windows x64 | DirectX12 | :white_check_mark: (Require NVIDIA Graphics card) | :white_check_mark: |
| Windows x64 | OpenGL | | |
| Windows x64 | Vulkan | | |
| Linux x64 | OpenGL | :white_check_mark: (Require NVIDIA Graphics card) | |
| Linux x64 | Vulkan | | |
| MacOS | OpenGL | | |
| MacOS | Metal | | :white_check_mark: |
### Supported Browsers
Browser support depends on the status of each browser's WebRTC support.
- Desktop Chrome
- Desktop Firefox
- Desktop Safari
- Desktop Microsoft Edge (Chromium-based)
- Android Chrome
- iOS Safari
Please see [Requirements](com.unity.renderstreaming/Documentation~/index.md#requirements) section.
### Furioos compatibility
......@@ -98,13 +76,15 @@ Then just build a standalone Windows version of your application, zip it and upl
## Roadmap
| 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 2020.1 support <br>- Bitrate control sample |
| 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 |
## FAQ
......
......@@ -9,7 +9,7 @@
"com.unity.test-framework": "1.1.11",
"com.unity.textmeshpro": "2.0.1",
"com.unity.ugui": "1.0.0",
"com.unity.webrtc": "2.0.2-preview",
"com.unity.webrtc": "2.1.0-preview.1",
"com.unity.modules.ai": "1.0.0",
"com.unity.modules.androidjni": "1.0.0",
"com.unity.modules.animation": "1.0.0",
......
......@@ -14,7 +14,7 @@
"com.unity.textmeshpro": "2.0.1",
"com.unity.timeline": "1.2.10",
"com.unity.ugui": "1.0.0",
"com.unity.webrtc": "2.0.2-preview",
"com.unity.webrtc": "2.1.0-preview.1",
"com.unity.modules.ai": "1.0.0",
"com.unity.modules.androidjni": "1.0.0",
"com.unity.modules.animation": "1.0.0",
......
{
"dependencies": {
"com.unity.2d.sprite": {
"version": "1.0.0",
"depth": 0,
"source": "builtin",
"dependencies": {}
},
"com.unity.2d.tilemap": {
"version": "1.0.0",
"depth": 0,
"source": "builtin",
"dependencies": {}
},
"com.unity.ads": {
"version": "3.4.7",
"depth": 0,
"source": "registry",
"dependencies": {
"com.unity.ugui": "1.0.0"
},
"url": "https://packages.unity.com"
},
"com.unity.analytics": {
"version": "3.3.5",
"depth": 0,
"source": "registry",
"dependencies": {
"com.unity.ugui": "1.0.0"
},
"url": "https://packages.unity.com"
},
"com.unity.collab-proxy": {
"version": "1.2.16",
"depth": 0,
"source": "registry",
"dependencies": {},
"url": "https://packages.unity.com"
},
"com.unity.editorcoroutines": {
"version": "1.0.0",
"depth": 1,
"source": "registry",
"dependencies": {},
"url": "https://packages.unity.com"
},
"com.unity.ext.nunit": {
"version": "1.0.0",
"depth": 1,
"source": "registry",
"dependencies": {},
"url": "https://packages.unity.com"
},
"com.unity.ide.rider": {
"version": "1.1.4",
"depth": 0,
"source": "registry",
"dependencies": {
"com.unity.test-framework": "1.1.1"
},
"url": "https://packages.unity.com"
},
"com.unity.ide.vscode": {
"version": "1.2.1",
"depth": 0,
"source": "registry",
"dependencies": {},
"url": "https://packages.unity.com"
},
"com.unity.inputsystem": {
"version": "1.0.0",
"depth": 0,
"source": "registry",
"dependencies": {},
"url": "https://packages.unity.com"
},
"com.unity.postprocessing": {
"version": "2.3.0",
"depth": 0,
"source": "registry",
"dependencies": {},
"url": "https://packages.unity.com"
},
"com.unity.purchasing": {
"version": "2.0.6",
"depth": 0,
"source": "registry",
"dependencies": {},
"url": "https://packages.unity.com"
},
"com.unity.test-framework": {
"version": "1.1.14",
"depth": 0,
"source": "registry",
"dependencies": {
"com.unity.ext.nunit": "1.0.0",
"com.unity.modules.imgui": "1.0.0",
"com.unity.modules.jsonserialize": "1.0.0"
},
"url": "https://packages.unity.com"
},
"com.unity.textmeshpro": {
"version": "2.0.1",
"depth": 0,
"source": "registry",
"dependencies": {
"com.unity.ugui": "1.0.0"
},
"url": "https://packages.unity.com"
},
"com.unity.timeline": {
"version": "1.2.10",
"depth": 0,
"source": "registry",
"dependencies": {},
"url": "https://packages.unity.com"
},
"com.unity.ugui": {
"version": "1.0.0",
"depth": 0,
"source": "builtin",
"dependencies": {
"com.unity.modules.ui": "1.0.0"
}
},
"com.unity.webrtc": {
"version": "file:C:/com.unity.webrtc",
"depth": 0,
"source": "local",
"dependencies": {
"com.unity.editorcoroutines": "1.0.0"
}
},
"com.unity.modules.ai": {
"version": "1.0.0",
"depth": 0,
"source": "builtin",
"dependencies": {}
},
"com.unity.modules.androidjni": {
"version": "1.0.0",
"depth": 0,
"source": "builtin",
"dependencies": {}
},
"com.unity.modules.animation": {
"version": "1.0.0",
"depth": 0,
"source": "builtin",
"dependencies": {}
},
"com.unity.modules.assetbundle": {
"version": "1.0.0",
"depth": 0,
"source": "builtin",
"dependencies": {}
},
"com.unity.modules.audio": {
"version": "1.0.0",
"depth": 0,
"source": "builtin",
"dependencies": {}
},
"com.unity.modules.cloth": {
"version": "1.0.0",
"depth": 0,
"source": "builtin",
"dependencies": {
"com.unity.modules.physics": "1.0.0"
}
},
"com.unity.modules.director": {
"version": "1.0.0",
"depth": 0,
"source": "builtin",
"dependencies": {
"com.unity.modules.audio": "1.0.0",
"com.unity.modules.animation": "1.0.0"
}
},
"com.unity.modules.imageconversion": {
"version": "1.0.0",
"depth": 0,
"source": "builtin",
"dependencies": {}
},
"com.unity.modules.imgui": {
"version": "1.0.0",
"depth": 0,
"source": "builtin",
"dependencies": {}
},
"com.unity.modules.jsonserialize": {
"version": "1.0.0",
"depth": 0,
"source": "builtin",
"dependencies": {}
},
"com.unity.modules.particlesystem": {
"version": "1.0.0",
"depth": 0,
"source": "builtin",
"dependencies": {}
},
"com.unity.modules.physics": {
"version": "1.0.0",
"depth": 0,
"source": "builtin",
"dependencies": {}
},
"com.unity.modules.physics2d": {
"version": "1.0.0",
"depth": 0,
"source": "builtin",
"dependencies": {}
},
"com.unity.modules.screencapture": {
"version": "1.0.0",
"depth": 0,
"source": "builtin",
"dependencies": {
"com.unity.modules.imageconversion": "1.0.0"
}
},
"com.unity.modules.subsystems": {
"version": "1.0.0",
"depth": 1,
"source": "builtin",
"dependencies": {
"com.unity.modules.jsonserialize": "1.0.0"
}
},
"com.unity.modules.terrain": {
"version": "1.0.0",
"depth": 0,
"source": "builtin",
"dependencies": {}
},
"com.unity.modules.terrainphysics": {
"version": "1.0.0",
"depth": 0,
"source": "builtin",
"dependencies": {
"com.unity.modules.physics": "1.0.0",
"com.unity.modules.terrain": "1.0.0"
}
},
"com.unity.modules.tilemap": {
"version": "1.0.0",
"depth": 0,
"source": "builtin",
"dependencies": {
"com.unity.modules.physics2d": "1.0.0"
}
},
"com.unity.modules.ui": {
"version": "1.0.0",
"depth": 0,
"source": "builtin",
"dependencies": {}
},
"com.unity.modules.uielements": {
"version": "1.0.0",
"depth": 0,
"source": "builtin",
"dependencies": {
"com.unity.modules.imgui": "1.0.0",
"com.unity.modules.jsonserialize": "1.0.0"
}
},
"com.unity.modules.umbra": {
"version": "1.0.0",
"depth": 0,
"source": "builtin",
"dependencies": {}
},
"com.unity.modules.unityanalytics": {
"version": "1.0.0",
"depth": 0,
"source": "builtin",
"dependencies": {
"com.unity.modules.unitywebrequest": "1.0.0",
"com.unity.modules.jsonserialize": "1.0.0"
}
},
"com.unity.modules.unitywebrequest": {
"version": "1.0.0",
"depth": 0,
"source": "builtin",
"dependencies": {}
},
"com.unity.modules.unitywebrequestassetbundle": {
"version": "1.0.0",
"depth": 0,
"source": "builtin",
"dependencies": {
"com.unity.modules.assetbundle": "1.0.0",
"com.unity.modules.unitywebrequest": "1.0.0"
}
},
"com.unity.modules.unitywebrequestaudio": {
"version": "1.0.0",
"depth": 0,
"source": "builtin",
"dependencies": {
"com.unity.modules.unitywebrequest": "1.0.0",
"com.unity.modules.audio": "1.0.0"
}
},
"com.unity.modules.unitywebrequesttexture": {
"version": "1.0.0",
"depth": 0,
"source": "builtin",
"dependencies": {
"com.unity.modules.unitywebrequest": "1.0.0",
"com.unity.modules.imageconversion": "1.0.0"
}
},
"com.unity.modules.unitywebrequestwww": {
"version": "1.0.0",
"depth": 0,
"source": "builtin",
"dependencies": {
"com.unity.modules.unitywebrequest": "1.0.0",
"com.unity.modules.unitywebrequestassetbundle": "1.0.0",
"com.unity.modules.unitywebrequestaudio": "1.0.0",
"com.unity.modules.audio": "1.0.0",
"com.unity.modules.assetbundle": "1.0.0",
"com.unity.modules.imageconversion": "1.0.0"
}
},
"com.unity.modules.vehicles": {
"version": "1.0.0",
"depth": 0,
"source": "builtin",
"dependencies": {
"com.unity.modules.physics": "1.0.0"
}
},
"com.unity.modules.video": {
"version": "1.0.0",
"depth": 0,
"source": "builtin",
"dependencies": {
"com.unity.modules.audio": "1.0.0",
"com.unity.modules.ui": "1.0.0",
"com.unity.modules.unitywebrequest": "1.0.0"
}
},
"com.unity.modules.vr": {
"version": "1.0.0",
"depth": 0,
"source": "builtin",
"dependencies": {
"com.unity.modules.jsonserialize": "1.0.0",
"com.unity.modules.physics": "1.0.0",
"com.unity.modules.xr": "1.0.0"
}
},
"com.unity.modules.wind": {
"version": "1.0.0",
"depth": 0,
"source": "builtin",
"dependencies": {}
},
"com.unity.modules.xr": {
"version": "1.0.0",
"depth": 0,
"source": "builtin",
"dependencies": {
"com.unity.modules.physics": "1.0.0",
"com.unity.modules.jsonserialize": "1.0.0",
"com.unity.modules.subsystems": "1.0.0"
}
}
}
}
......@@ -15,7 +15,7 @@
"com.unity.textmeshpro": "2.0.1",
"com.unity.timeline": "1.2.10",
"com.unity.ugui": "1.0.0",
"com.unity.webrtc": "2.0.2-preview",
"com.unity.webrtc": "2.1.0-preview.1",
"com.unity.modules.ai": "1.0.0",
"com.unity.modules.androidjni": "1.0.0",
"com.unity.modules.animation": "1.0.0",
......
......@@ -4,69 +4,129 @@ All notable changes to com.unity.renderstreaming package will be documented in t
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
## [2.1.0] - 2020-08-28
### Added
- Add a sample used Built-in Render Pipeline as graphics render pipeline
### Changed
- Upgrading WebRTC to `2.1.0-preview`
### Fixed
- Fixed the issue when pressing multiple buttons on a keyboard
## [2.0.2] - 2020-05-14
- Changed: Upgrading input system to 1.0.0
- Changed: Upgrading WebRTC to 2.0.2-preview
- Fixed: Fix documents
### Changed
- Upgrading input system to `1.0.0`
- Upgrading WebRTC to `2.0.2-preview`
### Fixed
- Fix documents
## [2.0.1] - 2020-05-01
- Fixed: Fixed versioning issue
### Fixed
- Fixed versioning issue
## [2.0.0] - 2020-04-30
- Changed: Upgrading input system to 1.0.0-preview.6
- Changed: Upgrading WebRTC to 2.0.0-preview
- Changed: Update URP/HDRP sample
### Changed
- Upgrading input system to `1.0.0-preview.6`
- Upgrading WebRTC to `2.0.0-preview`
- Update URP/HDRP sample
## [1.2.2] - 2020-03-06
- Fixed: Fix build error when build standalone
### Fixed
- Fix build error when build standalone
## [1.2.1] - 2020-02-28
- Changed: Upgrading WebRTC to 1.1.1-preview
### Changed
- Upgrading WebRTC to `1.1.1-preview`
## [1.2.0] - 2020-02-25
- Added: Adding AudioStreamer class
- Added: Adding the flag to select encoder
- Changed: Upgrading Unity version to 2019.3
- Changed: Upgrading HDRP to 7.1.7
- Changed: Upgrading input system to 1.0.0-preview.1
- Changed: Upgrading WebRTC to 1.1.0-preview
- Fixed: Display the mouse pointer in the correct position
- Fixed: Try downloading webserver from a known version if the current version doesn't exist
### Added
- Adding `AudioStreamer` class
- Adding the flag to select encoder
### Changed
- Upgrading Unity version to `2019.3`
- Upgrading HDRP to `7.1.7`
- Upgrading input system to `1.0.0-preview.1`
- Upgrading WebRTC to `1.1.0-preview`
### Fixed
- Display the mouse pointer in the correct position
- Try downloading webserver from a known version if the current version doesn't exist
## [1.1.2] - 2019-09-20
- Fixed: Fix image links for Japanese documentation on Unity website
Fixed
- Fix image links for Japanese documentation on Unity website
## [1.1.1] - 2019-09-14
- Fixed: Fix image links for documentation on Unity website
### Fixed
- Fix image links for documentation on Unity website
## [1.1.0] - 2019-09-13
- Added: Adding menu to download web app
- Changed: Upgrading input system to 0.9.4-preview
- Changed: Upgrading HDRP to 5.16.1-preview
- Changed: Adding keyboard event to reset camera position
### Added
- Adding menu to download web app
### Changed
- Upgrading input system to `0.9.4-preview`
- Upgrading HDRP to `5.16.1-preview`
- Adding keyboard event to reset camera position
## [1.0.0] - 2019-08-22
- Added: Eliminates the necessity of user interaction when installing an HDRP sample
- Added: Adding a check to automatically set HDRP render pipeline settings on initial setup
- Changed: Refactor RenderStreamingHDRPAutomator to use json instead of ScriptableObject
- Fixed: Blit Render Texture using customRender instead of beginCameraRendering
### Added
- Eliminates the necessity of user interaction when installing an HDRP sample
- Adding a check to automatically set HDRP render pipeline settings on initial setup
### Changed
- Refactor `RenderStreamingHDRPAutomator` to use json instead of ScriptableObject