Unity
Quick Start

Quick Start

Through our Chat SDK for Unity, you can efficiently integrate real-time chat into your client app. On the client-side implementation, you can initialize, configure and build the chat with minimal effort. On the server-side, Sendbird ensures reliable infra-management services for your chat within the app. This quick start provides the Chat SDK’s structure and installation steps, then goes through the preliminary steps of implementing the Chat SDK in your own project.

Note: Sendbird server supports Transport Layer Security (TLS) from version 1.0 up to 1.3. For example, in the server regions where TLS 1.3 isn’t available, lower versions from 1.2 to 1.0 will be sequentially supported for secure data transmission.


Step 1: Create a Sendbird application from your dashboard

First, create your Sendbird application which comprises everything required in a chat service such as users, messages, and channels.

  1. In the Sendbird Dashboard, type your email and password to create a new account. You can also sign in with or sign up for a Google account.
  2. When prompted by the setup wizard, enter your organization information to manage Sendbird applications.
  3. Lastly, when your dashboard home appears after completing setup, click Create App at the top-right corner for a new application.

You can integrate only one Sendbird application per app for your service, regardless of the platforms. All users within your Sendbird application can communicate with each other, across all platforms. This means that your users using iOS, Android, web, .NET, and Unity client apps, can all chat with one another without any further setup. Note that all data are limited to the scope of a single application, and users in different Sendbird applications can't talk to each other.


Step 2: Check requirements

The Chat SDK is designed and tested on Mono/.NET 2.0 platform and Unity 5.x.x or higher.


Step 3: Download the latest Chat SDK

Download Latest SDK

WebSocket Library

The Chat SDK uses websocket-sharp for websocket connection. You must include the websocket-sharp.dll as well as the SendBird.dll or SendBird.Unity.dll. You can find websocket-sharp.dll on the same github repository for the .NET SDK.


Step 4: Download the sample UI

Download Sample UI


Step 5: Unity dispatcher

The Chat SDK uses dispatcher pattern to avoid multi-threading issue. This dispatcher must be initialized along with SendBirdClient.Init.

Light Color Skin
Copy
void Awake() {
    SendBirdClient.SetupUnityDispatcher (gameObject); // Set `SendBird` gameobject to DontDestroyOnLoad.
    StartCoroutine (SendBirdClient.StartUnityDispatcher); // Start a Unity dispatcher.

    SendBirdClient.Init ("A7A2672C-AD11-11E4-8DAA-0A18B21C2D82"); // The Sendbird application ID in the sample app 
    ...
}