Plugin Documentation

ClusterLink
SocketCluster realtime client

A realtime client for the SocketCluster server protocol: channels, publish/subscribe, auth and codecs.

v1.0.0
UE 4.27–5.0+
Win64 · Win32
Category Networking
Alpha XP
ClusterLink diagram
ClusterLink — architecture & feature overview

Overview

ClusterLink connects to a SocketCluster server, subscribes to channels, publishes messages, and handles auth and codec engines. The SocketCluster|* Blueprint nodes describe the protocol it speaks.

Fork note The six SC* modules and every USC* class were renamed to ClusterLink* for UE 4.27–5.0+, while the SocketCluster protocol names (enums, categories) were intentionally kept. A latent JSON-minify bug was fixed and helpers added.

Requirements

RequirementDetails
Unreal Engine4.27–5.0+
LanguageBlueprints and/or C++
PlatformsWin64 · Win32

Installation

  1. Copy the ClusterLink folder into your project's Plugins/ directory.
  2. C++ projects: regenerate project files and build. Blueprint-only projects can launch the editor directly.
  3. Open Edit → Plugins and confirm ClusterLink is enabled.

Client API

NodeTypeDescription
Create / ConnectCallableCreate and connect a SocketCluster client socket.
Subscribe / Publish / Watch (channels)CallableChannel pub/sub.
Clients / Version / DestroyCallableManage active client sockets.
Num ClientsPureNumber of active client sockets.
Is Valid Channel NamePureValidate a channel name (non-empty, no whitespace).

Utility node pack

General-purpose networking utilities added to UClusterLinkClient — available from Blueprints and C++.

NodeTypeDescription
CRC32 Of BytesPureCRC32 checksum of a byte array.
MD5 Of String / SHA1 Of StringPureHex digests of a UTF-8 string.
Make Guid StringPureNew random GUID (hyphenated).
Now Unix SecondsPureCurrent UTC time as Unix seconds.
Unix Seconds To ISO8601PureUnix seconds → ISO-8601 UTC string.
Format Byte SizePureHuman-readable size, e.g. 1536 → 1.5 KB.
Random TokenPureRandom alphanumeric token (ids, nonces).
XOR Bytes With KeyPureXOR bytes with a repeating key (obfuscation, not encryption).
Is Valid HostnamePureRFC-952/1123-style hostname validation.

Credits

© Alpha XP — alphaxp.net. Developed and maintained for UE 4.27–5.0+.