Unity
Quick Start

Quick Start

The SendBird SDKs help you to implement real-time chat to any types of your client apps with speed and efficiency. Our Unity SDK provides you with various methods to initialize, configure and build the chat from the client side - no server side implementation is required because our reliable infra management service is delivered with the SDK. This page presents a brief overview of the SDK’s structure and abilities, then lets you go through the preliminary steps of implementing the SDK in your own app.


Step 1: Create a SendBird application

A SendBird application comprises everything that goes in a chatting service such as users, messages, and channels. To create a SendBird application, do the following:

  1. In the SendBird Dashboard, type your email and password to create a new account. You can also sign in or sign up with Google or GitHub accounts.
  2. In the Setup wizard that appears, specify information of your organization which would manage your SendBird applications.
  3. In your dashboard home that appears after completing the setup, click Create App at the top-right corner for a new application (you can also create via the Platform API).

You can implement only one SendBird application per app for your service, regardless of the platforms. All users within a 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 Unity SDK is designed and tested on Mono/.NET 2.0 platform and Unity 5.x.x or higher.


Step 3: Download the latest .NET SDK

Download Latest SDK

WebSocket Library

The Unity 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 Unity 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"); // SendBird Sample Application ID
    ...
}