A toolkit for creating powerful cloud-based 3D experiences that stream to traditionally out of reach low-powered devices.

• Getting Started
• Contributing
• License
• Code of Conduct

Problem: The world is becoming increasingly mobile, but the demand for high-fidelity 3D content is only growing. We needed a scalable approach to make this sort of content available on low-powered, low-bandwidth devices.

The 3DStreamingToolkit project's purpose is to provide an approach for developing 3D server applications that stream frames to other devices over the network. Specifically:

1. Server-side libraries for remotely rendering 3D scenes
2. Client-side libraries for receiving streamed 3D scenes
3. Low-latency audio and video streams using WebRTC
4. High-performance video encoding and decoding using NVEncode

Here's a high-level diagram of the components we've built (in green), and how they interact with the underlying WebRTC and NVEncode technologies we've leveraged. For a full description, check out our wiki page on WebRTC.

If you don't wish to build the toolkit yourself, you can download our latest build here.

These steps will ensure your development environment is configured properly, and then they'll walk you through the process of building our code.

• Windows 10 Anniversary Update / Windows Server 2012 R2 / Windows Server 2016 (see which version of Windows you have)
• Visual Studio 2017
• Windows 10 SDK - 10.0.14393.795
• Latest NVIDIA driver (required for NVEncode)
• CUDA Toolkit 9.1 (required for NVEncode)
• Unity 2017.4.4f1 LTS release (Optional, but required for Unity server and client samples)

Note: Before running our setup.cmd script, please ensure powershell is set to enable unrestricted script execution. The setup.cmd script will use AzCopy if installed, which will speed up the dependency downloads. Download the latest stable AzCopy from http://aka.ms/downloadazcopy.

Run .\setup.cmd from the command line. This will install and configure the following:

• 32bit and 64bit Debug, Release, Exes, Dlls and PDBs from this commit Chromium m62 release
• M62 WebRTC native and UWP extensions, which add nvencode support, frame prediction (for HoloLens), video frame updates and native buffers to webrtc. These will be applied to the above
• Pre-built NvPipe library used in our WebRTC extension to enable NVIDIA-accelerated zero latency video compression
• CUDA Toolkit 9.1 pre-built Release libraries used by NvPipe - cudart64_91 and nvToolsExt64_1
• 32bit and 64bit Debug and Release libraries for DirectX Toolkit
• Release libraries for OpenGL - Freeglut, Glew and glext

Once you see Libraries retrieved and up to date you may proceed.

• Open the 3DStreamingToolkit solution in Visual Studio
• Build the solution (Build -> Build Solution) in the desired configuration (Build -> Configuration Manager -> Dropdowns at the top). We encourage using Release and x64.
• Done!

Note: We no longer support x86 server builds that are using nvencode. This is due to 32-bit support gradually being deprecated/removed from CUDA.

If you're seeing errors, check out the troubleshooting guide and then file an issue.

After you've built the solution, you'll likely want to start one sample server implementation, and one sample client implementation. We've provided example client and server applications to demonstrate the behaviors the toolkit provides.

Note: We advise you to try Spinning Cube and StreamingDirectxClient to begin, as these are the simpliest sample implementations.

To run one server and one client, navigate to the location under Build\<Platform>\<Configuration>\ and start the exe.To identify what <Platform> and <Configuration> are, see your desired configuration from section: the actual build. Recall the note encourages using Release and x64.

Once you start both a server and client implementation, you will need to give it a signaling server. If you need to set one up, please see our wiki on Signaling Service for an easy local or cloud-based implementation. After connecting, you should be seeing success! If you're instead seeing errors, check out the Troubleshooting guide and then file an issue. Additionally, you can see more information about our other sample implementations here.

These resources will be critical to your success in configuring and scaling applications.

• Sample implementation configuration files
• Configuring and deploying services
• Configuring authentication

• General Wiki
• Building WebRTC from source
• WebRTC Homepage
• NVEncode Homepage
• NvPipe original source

Read our contributing guide to learn about our development process, how to propose bug fixes and improvements, and how to build and test your changes.

MIT

Streaming and Cloud Gaming Restrictions

You may not directly or indirectly distribute Your Project Content by means of streaming or broadcasting where Your Project Content is primarily executed on a server and transmitted as a video stream or via low level graphics render commands over the open Internet to end user devices without a separate license from Unity. This restriction does not prevent end users from remotely accessing Your Project Content from an end user device that is running on another end user device.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.