Get started

1. Set up the Unity Editor: Link your Unity Gaming Services project with the Unity Editor, and install the required packages.
2. Create a Unity Cloud Code module: Create and compile a module directly in the Editor.
3. Deploy the module: Deploy the module to the Cloud Code service, or run it on a local Cloud Code server for testing.
4. Call the module function from your game: Call the module endpoint from your game client.

Video walkthrough

Set up the Unity Editor

Access Cloud Code in the Unity Dashboard

1. In the Unity Dashboard, go to Development > Products.
2. Select Cloud Code.

Link project

1. In Unity Editor, select Edit > Project Settings > Services.
2. Link your project.
   If your project doesn't have a Unity project ID:
   1. Select Create a Unity Project ID > Organizations, then select an organization from the dropdown.
   2. Select Create project ID.
   
   If you have an existing Unity project ID:
   1. Select Use an existing Unity project ID.
   2. Select an organization and a project from the dropdowns.
   3. Select Link project ID.

Install required packages

• Deployment (

  com.unity.services.deployment

  )
• Cloud Code (

  com.unity.services.cloudcode

  ), version 3.0.0 or later

Install and set up .NET

1. In the Unity Editor, open the Preferences window.
   • On Windows, select Edit > Preferences.. > Cloud Code.
   • On macOS, select Unity > Settings.. > Cloud Code.
2. In the .NET development environment section, modify your .NET path to the one you have installed.
3. Select Apply.

Set up the Deployment window

• In Unity Editor versions 2021.3+, select Window > Deployment.
• In Unity Editor versions 2022+, select Services > Deployment.

1. In the Unity Editor, open the Deployment window.
2. In the Deployment window, select Deployment Settings.
3. In the new Environments window, select an environment from the Editor Environment dropdown.

Create a Unity Cloud Code module

Deploy the module

Call a module function from your game

SayHello

SDK setup

1. Ensure the service is enabled via the Cloud Code page in the Unity Dashboard.
2. Ensure that you have installed both the Cloud Code and the Authentication SDKs from the Unity Package Manager.
3. Create a new C# Monobehaviour script in Unity Editor. For more information, refer to Creating and using scripts in the Unity Manual.

Call the module function

SayHello

HelloWorld

using Unity.Services.Authentication;using Unity.Services.CloudCode;using Unity.Services.CloudCode.GeneratedBindings;using Unity.Services.Core;using UnityEngine;public class TestModule : MonoBehaviour{    private async void Start()    {        // Initialize the Unity Services Core SDK        await UnityServices.InitializeAsync();        // Authenticate by logging into an anonymous account        await AuthenticationService.Instance.SignInAnonymouslyAsync();        try        {            // Call the function within the module and provide the parameters we defined in there            var module = new HelloWorldBindings(CloudCodeService.Instance);            var result = await module.SayHello("World");            Debug.Log(result);        }        catch (CloudCodeException exception)        {            Debug.LogException(exception);        }    }}

1. Attach the

   TestModule

   script to a GameObject in your scene.
2. If you use a local Cloud Code server, make sure that it's running. Refer to Execute modules on the local server.
3. In the toolbar, select Play to enter Play mode.

SayHello

Next steps