Skip to main content

Setup Guide

Installation​

From FAB Marketplace​

  1. Purchase and download ElysChat from the FAB Marketplace
  2. Enable the plugin in your project's .uproject file or via Edit → Plugins
  3. Restart the editor

Manual Installation​

Copy the ElysChat folder to your project's Plugins/ directory and rebuild.

Prerequisites​

  • Unreal Engine 5.6+
  • GameplayTags plugin enabled (included with UE)

Quick Setup​

1. Create a Chat Configuration​

Create a Data Asset of type UERPChatConfig:

  1. Content Browser → Right-click → Miscellaneous → Data Asset
  2. Select ERPChatConfig
  3. Configure your channels:
Channel IDDisplay NameScopeSlash Commands
localLocalProximity/local, /l
globalGlobalGlobal/global, /g
groupGroupGroup/group, /p
guildGuildGuild/guild, /gu
dmWhisperDirectMessage/w, /whisper
gmGameMasterGameMaster/gm

2. Add Components​

PlayerController — Add UERPChatComponent:

UPROPERTY(VisibleAnywhere, BlueprintReadOnly)
UERPChatComponent* ChatComponent;

// In constructor
ChatComponent = CreateDefaultSubobject<UERPChatComponent>(TEXT("ChatComponent"));

PlayerState — Add UERPSocialComponent:

UPROPERTY(VisibleAnywhere, BlueprintReadOnly)
UERPSocialComponent* SocialComponent;

Character (optional) — Add UERPLanguageComponent and UERPChatBubbleComponent:

UPROPERTY(VisibleAnywhere, BlueprintReadOnly)
UERPLanguageComponent* LanguageComponent;

UPROPERTY(VisibleAnywhere, BlueprintReadOnly)
UERPChatBubbleComponent* ChatBubble;

3. Initialize the Subsystem​

In your GameMode BeginPlay:

UERPChatSubsystem* ChatSub = GetGameInstance()->GetSubsystem<UERPChatSubsystem>();
ChatSub->SetConfig(YourChatConfig);

4. Register Players​

In your PlayerState BeginPlay:

UERPChatSubsystem* ChatSub = GetGameInstance()->GetSubsystem<UERPChatSubsystem>();
ChatSub->RegisterPlayer(PlayerId, DisplayName, this);

5. Build Your Chat UI​

Create a Widget Blueprint inheriting from UERPChatWidgetBase and bind to the chat component in your HUD.