LogoLogo
API Status
  • 👋Welcome
  • 🌐What is Morpheus Platform?
    • Interoperability
  • â„šī¸Help
    • 📗Glossary
    • 🆘Support
    • Firewall problems
    • EULA
  • CREATION
    • 🎮Unreal Development
      • ⚡Get Started
        • âš’ī¸Download the Editor
        • âĢUpload Content
        • 🌎Creating your own map
        • 📝Morpheus Base Project
        • ❓Differences from Unreal
          • 🧍Character Configuration
        • 📡Morpheus Networking
          • Introduction to Morpheus Networking
          • Network Levels
          • Replicated Properties
          • RPCs
          • Morpheus Render Targets
          • Morpheus Array
          • Networking FAQ
          • Replicating Sublevels
      • 📚Features & Guides
        • 📒Example Plugin
          • Nameplates
          • In-game roles
          • Resizing
        • 🏊Actor Pooling
        • 🔊Audio
        • 🎭Avatars
          • Creating an Avatar
          • Attachments
            • MML Attachments
          • Custom Animation Variables
          • Importing an NFT collection
          • Capsules and Mesh Transforms
        • 🤖Bots
        • đŸŽ™ī¸Chat
          • Unreal Text Chat
        • đŸŽ›ī¸Control Panels
          • Control Panel Configuration
          • DJ booth mission control
          • Observer Controls
        • 🔉Crowd Audio
        • đŸ¤ŧCrowd Rendering
          • Legacy Animated Crowd
            • Animated Crowd Console Commands
            • Attaching static meshes to crowd members
          • Crowd Materials
          • Performance Parameters
          • Live Config Settings
          • Crowd Animation
            • Crowd Anim Blueprint
              • User Guide - Crowd Anim Blueprint
              • Reference Guide - ABP Nodes
                • Animation Playback
                • States and State Machines
                • Variables
                • Transitions
                • Special
                • Blends
                • Additional Notes
        • 🍱Helpers & Extras
          • "Instanced Objects" in Blueprints
          • Objects with "world context"
          • Making DataAsset classes
          • Duplicate Objects
          • The Bootflow Subsystem
          • The "Wait For Condition" System
          • Advanced Graphics settings
          • Listening to inputs on UObjects
          • Morpheus UserID
          • World Services
          • M2Extras: Skins System
        • đŸ–Ĩī¸Loading Screen
        • ⚡Live Config
          • Editing for a World
          • Editing Locally
          • Default Settings
          • Accessing via Blueprint
          • Adding New Settings
          • Overriding Defaults
          • Using Arrays
        • 🧊MML
        • đŸ•ēMotion Capture
        • 📡Networking
        • đŸ“ĸNotifications
        • Raycastable Crowd
        • 🌐Singletons
        • 📱Streaming & Multiplatform
          • GFN on mobile
        • đŸ–Ĩī¸UI
          • "UI Mode"
        • đŸ—ƒī¸User Collections
          • Creating a New Object Definition
          • Accessing from Unreal
            • Creating Objects Definitions
            • Transfer Objects
            • User Collection Views
            • Receiving Updates
        • đŸ“ēVideo Players
          • Embedded Video Player
          • Millicast video streaming
            • How to Setup an In-Game Video Stream
            • Picture-in-Picture mode
          • Streaming Video Player
            • How to Setup a URL Video Player
            • Picture-in-Picture mode
        • 🐞Visual Debugging
          • Inspector
        • đŸĒŸWeb UI
        • Online Services
          • KV Store Service
        • 💠Web Requests
          • Http Requests
            • Legacy HTTP Nodes
          • JSON Handling
          • WebSockets
          • Identity Validation
          • Allowed External URLs
          • Walkthrough Example
            • Example Counter Service
        • âœˆī¸World Travel
          • World Travel in the editor
        • Avatar Physics Assets
        • Action Gameplay Helper Components
      • 🔑Workflows
        • â†—ī¸Upgrade the Editor
          • đŸ–Ĩī¸Version History
        • âš™ī¸Editing Project Settings
        • 📈Profiling
        • đŸ§ēMarketplace Importing
        • đŸ› ī¸Extra Workflows
          • Setup Play-in-Editor
          • Setup Local Asset Validation
          • Adding Gameplay Tags
          • Validating Game Assets
          • Custom Connection Modes
          • Connect Editor to a World
          • Common Issues
      • 📚Useful Reading
        • ⭐Best Practices
    • 🌎Worlds
      • 📩Invite Players
        • Setting Role Groups
      • Persistent Worlds
      • Always on Worlds
    • 📅Running events
      • ✅Large scale events - Checklist
      • 👾Anti-Cheat (EAC)
      • 🎮Player Entry
        • 📱React Native
        • Steam
        • đŸ’ģHardware Reqs
      • đŸŽĨBroadcast
        • 📹OBS Integration
      • Failover
      • 🏁Capacity And Queue Management
  • ADMINS
    • đŸ‘ĒAccess Control
      • Adding metaverse contributors
      • Creating a new project
    • 💲Pricing
      • Development Support
      • Included Usage & Overages
      • Cloud Streaming
      • Access Modes
      • War Room Support
      • Platform SLA
    • âš™ī¸Settings
      • đŸ—ƒī¸Projects
  • APIs and Tooling
    • đŸ–Ĩī¸API Reference
      • Accounts
      • Events
      • Key/Value Store
      • Organizations
      • Realtime
      • User Profile
      • World Builder
      • Worlds
    • đŸ’ģTemplate Web App
      • đŸ’ĸModeration
    • Pixel Streaming
    • 🚀Launcher
  • Integrations
    • 📊Analytics
      • Sending events from web
      • 🎮Sending Events from Unreal
    • đŸ’ŦChat
      • 🎮Integrating Pubnub with your Unreal Project
      • Adding Moderation to Chat
Powered by GitBook
On this page
  • Introduction
  • Creating your Pubnub Application
  • Next Steps

Was this helpful?

  1. Integrations

Chat

How to integrate a 3rd party chat system into your project

PreviousSending Events from UnrealNextIntegrating Pubnub with your Unreal Project

Last updated 2 months ago

Was this helpful?

Introduction

This guide will help projects wanting to use a chat system that integrates with a 3rd party chat provider (as opposed to the default unreal chat system provided). There are a number of benefits for rolling an integrated chat solution in your Unreal project:

  1. Scalability: 3rd party solutions can be better placed to handle the large volume of concurrent users and messages efficiently. This is particularly beneficial for projects developed on our platform, which expect thousands of users in one experience.

  2. Improved Performance: 3rd party chat solution providers are often better optimised for real-time, low-latency communication across global networks.

  3. Advanced Features: many third party solutions contain advanced features that would otherwise be difficult to implement/unavailable. These include features like:

    1. Presence Detection

    2. Built-in Moderation Capabilities

    3. Message Persistence and History

    4. Customizable Channels

For the purposes of this guide, we will be using as our example. Pubnub's feature-rich offers a variety of chat options that you may find useful for your project. They include:

  1. Up to 1 million total messages per month

  2. Data persistence of up to 1GB

  3. Custom function modules for Moderation

  4. Easy integration with Unreal via Pubnub APIs

Follow the steps below to get started with setting up your first Pubnub application!

Creating your Pubnub Application

Once created, set up a new Keyset within the application, with an appropriate name (see above).

You can configure your keyset, however you like; to get started, we recommend configuring as follows:

  1. Presence: ON

    1. Defaults are usually fine

      1. Announce Max: 20

      2. Interval: 30

      3. Stream Filtering: ON

  2. App Context: ON

    1. Region: EU Central (or US)

    2. User Metadata Events: ON

    3. Channel Metadata Events: ON

    4. Membership Events: ON

  3. Message Persistence: ON

    1. Retention: 7days

    2. Enable Delete-From-History: ON

  4. Stream Controller: ON

    1. Enable Wildcard Subscribe: ON (but could be OFF ?)

  5. File Sharing: OFF

  6. Mobile Push Notifications: OFF

  7. Apple Push Notifications: OFF

  8. Firebase Cloud Messaging: OFF

If you want to strictly enable authed users only chatting for your keyset:

  1. EnableAccess Manager: ON

    1. Revoke v3 Token: ON

Next Steps

Once completed, you're ready to integrate with your newly created app and keyset!

Firstly, create an account with . Then create a new app:

To learn how to integrate Pubnub with your Unreal project, !

To learn how to set up custom functions like Modetation for your Pubnub keyset, !

đŸ’Ŧ
Pubnub
free tier
Pubnub
🎮
view our guide here
đŸ’ĸ
view our guide here