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
  • Overview
  • Integration
  • How to enable

Was this helpful?

  1. CREATION
  2. Unreal Development
  3. Features & Guides
  4. Chat
  5. PubNub Text Chat
  6. Legacy Text Chat

Cloud Chat

Text chat between the web and in event experience

Last updated 1 year ago

Was this helpful?

Experimental - Customers are encouraged to test and use this feature in their experiences, but it may still require some additional support

Overview

The ability to chat on web and in game, including:

  • Chat from Web to Unreal and back

  • Works on Mobile and Desktop

  • Text appears in game above the head

  • Ability to hide and show the widget, and custom sizing

  • User name and profile image appending to the message

Integration

  1. Make sure you have a safe internal launch context id set up for your editor users.

  2. Configure the variable Social.Chat.Editor.LaunchContextId in deployment.json with this value (see below)

How to enable

  1. Enable TextChat.UseCloudChat in game.json.

  2. Make sure your in-game HUD is set up to use the new chat system

The following settings in game.json influence the Text Chat feature:

Setting

Description

Default Value

TextChat.UseCloudChat

Enables the cloud chat functionality

true

TextChat.ForceMobileView

Forces mobile view regardless of detected platform

false

The following deployment.json influence the Text

Setting
Description
Default Value

Social.Chat.LaunchContextSource

Determines how the client should determine the launch context id to use for chat.

The values are as follows:

“LiveConfigWorldId” (use the legacy M2.Domains.WorldId value) - this is how the previous system worked

“LiveConfigChatLaunchContext” - a setting provided from live config (Social.Chat.LaunchContextId)

“CommandLineLaunchContext” - use the -LaunchContextId command line argument the game was booted from (default behaviour if not set)

CommandLineLaunchContext (the game uses the commandline argument -LaunchContextId)

Social.Chat.LaunchContextId

Use this launch context id for chat.

Only when Social.Chat.LaunchContextSource is set to LiveConfigChatLaunchContext)

Social.Chat.Editor.LaunchContextSource

Similar to Social.Chat.LaunchContextSource, but determine how the editor should find its chat launch context.

LiveConfigChatLaunchContext

Social.Chat.Editor.LaunchContextId

Set this to a “known good” (safe/internal) launch context that should be used for chat in your project.

This is required for editor users to use chat.

You can create one in the M2 Web Platform Admin UI

M2.Domains.WorldId

(LEGACY)

The launch context id in the web to scope the chat to.

This must match the web portals if you want cross-experience chat.

The in-and-out-experience chat is backed by . For battle-tested, in-experience only chat, see .

🎮
📚
🎙️
PubNub
Legacy Text Chat
Chat via text within or outside the Morpheus experience