imnazake / gameplay-message-router

A robust subsystem designed for registering and facilitating communication between unconnected gameplay objects. This system allows you to send and receive messages containing specific data through defined channels, utilizing gameplay tags.

Gameplay Message Router

The Gameplay Message Router is a robust subsystem designed for registering and facilitating communication between unconnected gameplay objects. This system allows you to send and receive messages containing specific data through defined channels, utilizing gameplay tags. Developed by Epic Games, Inc., this subsystem is compatible with Unreal Engine 5.0.0 or higher and currently supported on the Windows platform.

Getting Started

To integrate the Gameplay Message Router into your project, follow these simple steps:

1. Obtain the Lyra game project from the Lyra Github Repo (requires a Github account linked to Epic Games).
2. Copy the 'GameplayMessageRuntime' plugin from the Lyra project's plugins folder and paste it into your project's plugins folder (YourProject/Plugins/GameplayMessageRuntime).
3. Add 'GameplayMessageRuntime' to your YourProject.Build.cs file.
4. Regenerate your project's solution files.

How to Use

1. Set up your message structure:

2. Create a function to send the message:

In your class, create a function to send the message and add a gameplay tag representing the channel:

Note: You can also broadcast messages directly from Blueprint using the BroadcastMessage node.

3. Test it in Blueprint:

Create a child actor class from MyActor C++ class and another actor that doesn't necessarily need to inherit from MyActor.

In Actor01 Blueprint, create a sample message to send on begin play.

In Actor02 Blueprint, specify a channel and select the relevant message structure to receive the message from Actor01.

4. Define gameplay tags and message structures:

Define gameplay tags for sending or receiving messages on specific channels.

Select the structure containing your message data (e.g., SampleMessage).

5. Test the setup:

After placing both actors in the level, the message sent from Actor01 should be displayed on Actor02 when the game begins.

Enjoy seamless communication between gameplay objects using the Gameplay Message Router!

Supported Engine Versions

5.0 or higher

Supported Platforms

• Windows
• Mac
• Linux

Network Replication Support

Not Supported