Set up the Realms sample#

Follow these instructions to set up the Realms sample in the Unity Editor. It requires Unity Editor version 2021.3 or later with the Linux Build Support module. You also need to sign into your Unity account to link the Unity Editor to your UGS projects.

1. Download the Realms sample files.
2. Install the Unity Editor version 2021.3 LTS or later and make sure you enable the Linux Build Support module. The best way to do this is through the Unity Hub.
3. Load the sample project in the Unity Editor.
4. Log into the Unity Editor if you haven’t already.

   The sample project includes a README.md file with general instructions. Follow this guide before reviewing the additional instructions for interacting with the sample project in that README.

5. If you haven’t already done so, contact the Unity Realms team to complete the setup:
   1. If your project hasn’t already enabled Realms, contact the Realms team with the Organization ID, Project ID, and Environment ID. The Realms team will manually enable the feature for that project.
6. In the Unity Editor:
   1. Select Edit > Project Settings > Services, then link the Unity project you want to use to the Unity Editor project.
   2. Select File > Build Settings, then select Dedicated Server as the platform and Linux as the target platform.
   3. Build the server executable (server.x86_64).