On this page

PubNub Unity Chat API & SDK Docs v1.1.0

This SDK offers a set of handy methods to create your own feature-rich chat or add a chat to your existing application.

It exposes various PubNub APIs to Unity with twists:

  • Tailored specifically to the chat use case by offering easy-to-use methods that let you do exactly what you want, like StartTyping() (a message) or Join() (a channel).
  • Meant to be easy & intuitive to use as it focuses on features you would most likely build in your chat app, not PubNub APIs and all the technicalities behind them.
  • Offers new chat options, like quotes, threads, or read receipts, that let you build a full-fledged app quickly.

Go to the Learn section to find out more about:

Get started

Assuming you have read the Learn section and understand the idea behind the Unity Chat SDK's architecture, you can move to the Build section and start creating your own chat.

Get the SDK

Read Initial configuration for instructions on how to install the Unity Chat SDK.

Follow these steps:

  1. Create a PubNub account in Admin Portal and a sample app. You'll need the publish and subscribe keys from your app's keyset to start building a chat.

    Required keyset configuration

    To use the GetChannels(), GetChannelSuggestions(), GetUsers(), and GetUserSuggestions() methods in the Chat SDKs with Access Manager, you must uncheck the Disallow Get All Channel Metadata and Disallow Get All User Metadata checkboxes in the App Context section of your keyset configuration in the Admin Portal.

  2. Start building your own chat app:

    a. Initialize the Unity Chat SDK.

    b. Create channels, users, messages, and all other chat features.

Last updated on