For AI agents: this page in Markdown: https://www.pubnub.com/docs/chat/unity-chat-sdk/build/configuration.md. Documentation index: https://www.pubnub.com/llms-full.txt.

Initial configuration

Initialize and configure the Unity SDK and Unity Chat SDK before building your chat app.

Unity SDK is a prerequisite

You must install the Unity SDK before installing the Unity Chat SDK.

Prerequisites​

  1. Sign in or create an account on the Admin Portal.
  2. Create an app to get your Publish Key and Subscribe Key.

A new app receives demo keys automatically. You can create multiple keysets per app. Use separate keysets for production and test environments.

Required keyset settings

Enable these features on your keyset in the Admin Portal:

  • App Context - Store user and channel data
  • Presence - Track online/offline status
  • Message Persistence - Store message history

Download the SDKs​

Install the Unity SDK before installing the Unity Chat SDK.

Source code​

Download the source code from GitHub: Unity SDK and Unity Chat SDK.

Package Manager​

  1. Open Unity Editor and navigate to Window -> Package Manager.
  2. In the Package Manager window, click + and select Add package from git URL.
  3. Paste the PubNub Unity package links and click Add. Do it for both SDKs.
https://github.com/pubnub/unity.git?path=/PubNubUnity/Assets/PubNub
  
https://github.com/pubnub/unity-chat.git?path=/unity-chat/PubnubChatUnity/Assets/PubnubChat

Add Unity package

WebGL configuration​

Enable WebGL build mode only for builds

Using UnityWebGLHttpClientService outside of WebGL builds (including the editor) might cause unexpected behavior due to UnityWebRequest being thread-unsafe.

The Unity Chat SDK is compatible with WebGL builds. Configure your project for WebGL:

  1. Go to Edit -> Project Settings -> Player and set Managed Stripping Level to Minimal.

    Additional HTTP setup

    If for some reason you can't turn on the Secure option in either PNConfiguration or the Scriptable Object config file, then you need to also go to Project Settings -> Player -> WebGL Settings and set the Allow downloads over HTTP option to Always allowed. Player settings

  2. Install the WebGL Threading Patcher. Navigate to Window -> Package Manager, click +, select Add package from git URL, paste the link to the Threading Patcher's GIT repository, and click Add.

These steps configure your project for WebGL builds only. Configure other targets as needed.

Initialize PubNub​

Use the CreateInstance() method to create a Chat SDK instance. Pass PNConfiguration for keys and user ID, and PubnubChatConfig for chat-specific features.

1

Initialize PubNub for WebGL​

1

If you already have a PubNub instance set up for WebGL, you can pass it to the overloaded CreateInstance method.

Method signatures​

Three overloads of CreateInstance are available:

  • CreateInstance(PubnubChatConfig chatConfig, PNConfiguration pubnubConfig, bool webGLBuildMode = false, bool unityLogging = false)
  • CreateInstance(PubnubChatConfig chatConfig, PNConfigAsset configurationAsset, string userId)
  • CreateInstance(PubnubChatConfig chatConfig, Pubnub pubnub)

The PubnubChatConfig parameters apply to all overloads.

PubnubChatConfig​

TypingTimeout#
Type: int
Default: 5000
Specifies the default timeout after which the typing indicator automatically stops when no typing signals are received. The default value is set to 5000 milliseconds (5 seconds).
Feature
Typing Indicator
TypingTimeoutDifference#
Type: int
Default: 1000
Specifies the difference in time between actually sending the typing indicator and the value of TypingTimeout. This is designed to cover for any network lag that may occur. The default value is set to 1000 milliseconds (1 second).
Feature
Typing Indicator
StoreUserActivityTimestamp#
Type: bool
Default: false
Specifies if you want to track the user's global presence in your chat app. The user's activity is tracked through the LastActiveTimeStamp parameter on the User object.
Feature
User's last online activity, global presence
StoreUserActivityInterval#
Type: int
Default: 60000
Specifies how often the user global presence in the app should be updated. Requires StoreUserActivityTimestamp to be set to true. The default value is set to 60000 milliseconds (1 minute).
Feature
User's last online activity, global presence
SyncMutedUsers#
Type: bool
Default: false
Specifies if you want to persist the mute list for regular chat users beyond the scope of a single session. When set to true, the mute list is saved and retrieved during client initialization.
Feature
Moderation as user
EmitReadReceiptEvents#
Type: Dictionary<string, bool>
Default: {"public": false, "group": true, "direct": true}
Controls whether read receipt events are emitted per channel type. Keys are channel type strings ("public", "group", "direct"), values are booleans. By default, read receipts are enabled for group and direct channels but disabled for public channels.
Feature
Read Receipts
RateLimitFactor#
Type: int
Default: 2
Exponential backoff factor used by the rate limiter when a channel's send limit is exceeded. A value of 2 means each retry waits twice as long as the previous attempt.
Feature
Send messages
RateLimitsPerChannel#
Type: RateLimitPerChannel
Default: all 0 (disabled)
Per-channel-type rate limit in milliseconds applied between SendText() calls. Set to 0 to disable rate limiting for that channel type. See below for the RateLimitPerChannel fields.
Feature
Send messages
PushNotifications#
Type: PushNotificationsConfig
Default: no default
Configuration for mobile push notifications. See below for PushNotificationsConfig options.
Feature
Mobile Push Notifications

RateLimitPerChannel​

Configure per-channel-type rate limiting by setting the RateLimitsPerChannel property of PubnubChatConfig:

DirectConversation#
Type: int
Default: 0
Minimum milliseconds between SendText() calls on direct channels. 0 disables rate limiting.
GroupConversation#
Type: int
Default: 0
Minimum milliseconds between SendText() calls on group channels. 0 disables rate limiting.
PublicConversation#
Type: int
Default: 0
Minimum milliseconds between SendText() calls on public channels. 0 disables rate limiting.
UnknownConversation#
Type: int
Default: 0
Minimum milliseconds between SendText() calls on channels with an unrecognized type. 0 disables rate limiting.

PushNotificationsConfig​

Configure mobile push notifications by setting the PushNotifications property of PubnubChatConfig:

SendPushes#
Type: bool
Default: false
Specifies whether push notifications are enabled for sending messages. When true, the SDK automatically adds push notification payloads to messages sent on registered channels.
DeviceToken#
Type: string
Default: no default
The unique device token obtained from the push notification service (APNs or FCM). This identifies the device that will receive push notifications.
DeviceGateway#
Type: PNPushType
Default: PNPushType.FCM
The push notification gateway to use. Options include PNPushType.FCM for Firebase Cloud Messaging (Android) or PNPushType.APNS2 for Apple Push Notification service (iOS).
APNSTopic#
Type: string
Default: no default
The bundle identifier for your iOS app. Required when using APNs.
APNSEnvironment#
Type: PushEnvironment
Default: PushEnvironment.Development
The APNs environment to use. Options are PushEnvironment.Development or PushEnvironment.Production.

PNConfiguration​

required
PublishKey required#
Type: string
Default: no default
Specifies the key used to publish messages on a channel.
Feature
Send messages
SubscribeKey required#
Type: string
Default: no default
Specifies the key used to subscribe to a channel.
Feature
Receive messages
UserId required#
Type: string
Default: no default
Unique User ID that becomes your app's current user. It's a string of up to 92 characters that identifies a single client (end user, device, or server) that connects to PubNub. Based on User ID, PubNub calculates pricing for your apps' usage. User ID should be persisted and remain unchanged. If you don't set userId, you won't be able to connect to PubNub.
Feature
n/a
AuthKey#
Type: string
Default: no default
Authentication key for Access Manager. Use it for all requests made to PubNub APIs to authenticate users in your application and grant them access to PubNub resources (other users' metadata and channels).
Feature
Access Manager

Additional options (when using PNConfiguration)​

webGLBuildMode#
Type: bool
Default: false
Enables WebGL transport (sets httpTransportService to UnityWebGLHttpClientService).
unityLogging#
Type: bool
Default: false
Enables Unity-specific logger (UnityPubNubLogger).

PNConfigAsset + userId​

required
configurationAsset required#
Type: PNConfigAsset
Default: no default
Scriptable Object containing your PubNub keys and configuration.
userId required#
Type: string
Default: no default
Client User ID used to initialize the PubNub instance created from the asset.

Existing Pubnub instance​

required
pubnub required#
Type: Pubnub
Default: no default
Existing PubNub client instance to use for the chat.

Output parameters​

TypeDescription
ChatOperationResult<Chat>Returns a new PubNub chat instance on success or a null with error data on failure.

Next steps​

After initialization, you can:

Was this page useful?

Last updated on