setup-existing-project.md

Contents | Home > Use an Existing Project with Cluster Display

Quick Start: Use an Existing Project with Cluster Display

This guide describes how to enable Cluster Display in an existing Unity project.

NOTE: Cluster Display rendering requires URP or HDRP 14.0.3 or newer.

1. Navigate to your project's Packages\manifest.json.

2. Add the cluster display packages:

       "com.unity.cluster-display": "file:{path to package}/source/com.unity.cluster-display",
       "com.unity.cluster-display.graphics": "file:{path to package}/source/com.unity.cluster-display.graphics"

3. You should now see in your Project Settings a section for Cluster Display. Check the Enable On Play option.

4. Select the Cluster Rendering subsection. Click the Set up Cluster Renderer button. This will create a new Cluster Renderer component in your scene, as well as add a Cluster Camera component to existing cameras. You can edit your projection settings from the Settings window or in the Inspector.

5. Edit your Project Settings as per the following recommendations:

   • In Quality > Other, set VSync Count to Every V Blank.

   

   • In Player > Other Settings > Configuration, set Scripting Backend to IL2CPP. (Currently broken, use managed)

   • In Player > Other Settings > Configuration, enable the Use Incremental GC option (checkbox) to help avoiding framerate jitters caused by garbage collection.

   • In Player > Resolution and Presentation > Resolution, set Fullscreen Mode to FullScreen Window (see Standalone Player Settings for more details).

   

   • Verify that your Unity project has Run in Background set to true

   

6. To run your Cluster Display-enabled game, create a standalone build and follow the directions for Mission Control.