Unreal Engine Crowd Control Documentation
The Crowd Control Unreal Plugin allows game developers to implement Crowd Control functionality into their Unreal Engine games. The plugin handles the WebSocket connection, authentication, and effect lifecycle for you - you register effects and react when they trigger. If you are just starting out, please read the Tutorial first.
Requirements
- Unreal Engine 5.0–5.4 (a UE 4.27 branch is also available)
- Windows (Win64)
Features
- Application (appID) authentication - configure your
ApplicationIDand viewers authorize the game with a short code/URL. Legacy Twitch/YouTube/Discord platform login is also supported. - Effect components - a
CrowdControlEffectComponentyou add to any actor: it carries the effect's menu metadata, registers itself, receives its own trigger callback, and automatically responds to Crowd Control. Timed effects self-manage their duration with pause/resume support. - Global effect delegates - bind
OnEffectTrigger,OnTimedEffectTrigger, andOnParameterEffectTriggeron the subsystem to route effects yourself. - Effect responses - report success, temporary failure, or permanent failure, with optional viewer-facing messages.
- Menu reports - show/hide effects and mark them available/unavailable based on game state.
- Pack metadata - report live game state to Crowd Control.
- Session control - automatic by default, or manual via
StartGameSession/StopGameSession. - Custom effects - upload, list, and delete custom effects at runtime.
Getting the Plugin
- Plugin (UE5): https://github.com/WarpWorld/CrowdControl-Unreal/tree/master
- Full example project: https://github.com/WarpWorld/CrowdControl-Unreal/tree/5.4-ExampleProject