Use the Unity Cluster Display package (com.unity.cluster-display) to display synchronously the same Unity Scene across multiple machines through display clustering.
This repository contains all packages, resources and sample projects related with Unity Cluster Display.
To learn about the Unity Cluster Display package (concepts, features, and workflows) read the Cluster Display package documentation in this repository.
- Unity 2023.1 or newer
- Windows 10
The Cluster Display package is licensed under the Apache License, Version 2.0.
We appreciate your interest in contributing to the Unity Cluster Display package.
It's important to note that this package is provided as is, without any maintenance or release plan.
Therefore, we are unable to monitor bug reports, accept feature requests, or review pull requests for this package.
However, we understand that users may want to make improvements to the package.
In that case, we recommend that you fork the repository. This will allow you to make changes and enhancements as you see fit.
Use these Unity packages to develop and enable the Cluster Display functionality in the Editor.
| Package | Description |
|---|---|
| com.unity.cluster-display | The main required package which implements the core Cluster Display functionality. |
| com.unity.cluster-display.graphics | Toolkit package providing rendering features for Cluster Display, such as non-standard projections and overscan. |
| com.unity.cluster-display.rpc | Package required for Remote Procedural Call (RPC) support to make builds that run on multiple machines and simulate the same scene in-sync with each other. |
This repository also includes code and tools to build plugins used in the packages above.
| Plugin | Description |
|---|---|
| Quadro Sync plugin | Code and script to develop, build and install the plugin to support Nvdia Quadro Sync features in Cluster display package (com.unity.cluster-display). |
| RPC Source Generators | Tools to develop, build, and deploy the source generators for the Cluster Display Remote Procedural Call (RPC) package (com.unity.cluster-display.rpc). |
Use these Unity demo projects to try out the Cluster Display features in various contexts.
| Project | Description |
|---|---|
| GraphicsDemoProject | Unity demo project to try out Cluster Display in HDRP with various Unity features. |
| Mosys | Unity demo project to try out Cluster Display with a Mo-Sys camera tracking device. |
| VirtualCameraTest | Unity demo project to try out Cluster Display with a Live Capture Virtual Camera. |
Use these Unity projects to run various tests against the Cluster Display packages.
| Project | Description |
|---|---|
| ClusterRenderTest | Unity project to test a cluster render. |
| ClusterSyncTest | Unity project to test a cluster sync. |
| GraphicsTestsHDRP | Unity project to test Cluster Display with graphics in HDRP. |
| GraphicsTestsURP | Unity project to test Cluster Display with graphics in URP. |
| LiveEditingTests | Unity project to test Cluster Display and live editing. |
| MissionControlTests | Unity project to test Cluster Display with Mission Control. |
| RPCTests | Unity project to perform remote procedure call (RPC) tests with Cluster Display. |
See also Sample Projects page for more details.
| Source folder | Description |
|---|---|
| Cluster Display Mission Control | Manage multiple computers working together to form a Cluster Display and load, start and stop executables built with Unity for display on the clustered screens. |