Get started

Deploying Hello World

Prerequisites

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 menu.
     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 dropdown menus.
     3. Select Link project ID.

UnityEditor.CloudProjectSettings.projectId

SDK installation

1. In the Unity Editor, open Window > Package Manager.
2. In the Package Manager, select the Unity Registry list view.
3. Search for

   com.unity.services.cloudcode

   , or locate the Cloud Code package in the list.
4. Select the package, then click Install.

SDK setup

1. Ensure the service is enabled via the Cloud Code service dashboard page.
2. Ensure that you have installed both the Cloud Code and the Authentication SDKs.
3. Sign into your cloud project from within Unity Editor by selecting Edit > Project Settings... > Services.
4. Create a new C# Monobehaviour script in Unity Editor. Refer to Creating and using scripts in the Unity Manual.
5. In the script, initialize the Core SDK using await

   UnityServices.InitializeAsync()

   .
6. In the script, initialize the Authentication SDK.

await AuthenticationService.Instance.SignInAnonymouslyAsync();

Authentication

Writing your first script

name

string

module.exports = async ({ params, logger }) => {  const name = params.name;  const message = `Hello, ${name}. Welcome to Cloud Code!`;  logger.debug(message);  return {    welcomeMessage: message,  };};

using System.Collections.Generic;using Unity.Services.Authentication;using Unity.Services.CloudCode;using Unity.Services.Core;using UnityEngine;/* * Note: You must have a published script to use the Cloud Code SDK. * You can publish a script from the Unity Dashboard - https://cloud.unity.com */public class CloudCodeExample : MonoBehaviour{    /*     * CloudCodeResponse represents the response from the script, used for deserialization.     * In this example, the script returns a JSON in the format     * {"welcomeMessage": "Hello, arguments['name']. Welcome to Cloud Code!"}     */    class CloudCodeResponse    {        public string welcomeMessage;    }    /*     * Initialize all Unity Services and Sign In an anonymous player.     * You can perform this operation in a more centralized spot in your project     */    public async void Awake()    {        await UnityServices.InitializeAsync();        await AuthenticationService.Instance.SignInAnonymouslyAsync();    }    /*     * Populate a Dictionary<string,object> with the arguments and invoke the script.     * Deserialize the response into a CloudCodeResponse object     */    public async void OnClick()    {        var arguments = new Dictionary<string, object> { { "name", "Unity" } };        var response = await CloudCodeService.Instance.CallEndpointAsync<CloudCodeResponse>("hello-world", arguments);    }}

Deploy a Cloud Code script

Configure the UGS CLI

1. Install the UGS CLI.
2. Configure your Project ID and Environment as such:
   

   ugs config set project-id <your-project-id>

   
   

   ugs config set environment-name <your-environment-name>

3. Configure a Service Account with the required roles for Cloud Code and environments management. Refer to Get Authenticated.

Deploy the script

ugs deploy <path-to-js-file>

Next steps

Integration