¶ 🚀 Supabase UE5 Plugin Wiki
Version 1.35.3 | Roadmap 2025 | Unreal Engine 5.4-5.6
Welcome to the comprehensive documentation for the Supabase UE5 Plugin by Seven Mountains Labs. This plugin provides robust, production-ready integration between Unreal Engine 5 and Supabase, featuring thread-safe operations, comprehensive error handling, and Blueprint-friendly interfaces.
¶ 📋 Table of Contents
¶ 🎯 Getting Started
¶ 🏗️ Core Architecture
¶ 🔐 Authentication
¶ 📊 Database Operations
¶ 📄 File Operations
¶ 📦 Persistence
¶ ⚡ Real-time Features
¶ 🛠️ Advanced Features
¶ 🎮 Blueprint Integration
¶ 🔧 Utilities & Helpers
¶ 📱 Platform Support
¶ 🐛 Troubleshooting
¶ 🌟 Key Features
¶ Production-Ready Architecture
- Singleton Subsystem: Thread-safe, game instance-scoped subsystem
- Health Monitoring: Automatic connection and token refresh
- Error Recovery: Comprehensive error handling and recovery mechanisms
- Memory Safety: Proper cleanup and memory management
¶ Blueprint-Friendly Design
- Static Manager Interface: Easy access through USupabaseManager
- Async Operations: Non-blocking operations with proper callback handling
- Event System: Rich event broadcasting for UI integration
- Data Structures: Well-defined structs for all Supabase data types
¶ Real-time Capabilities
- WebSocket Integration: Thread-safe real-time subscriptions
- Channel Management: Automatic subscription and cleanup
- Event Broadcasting: Unreal-native event system integration
- Connection Recovery: Automatic reconnection with exponential backoff
¶ Security & Authentication
- Token Management: Automatic token refresh and validation
- Session Persistence: Secure session storage and restoration
- Multi-auth Support: Email/password with extensible auth system
- Credential Protection: Secure handling of API keys and tokens
¶ 🚀 Quick Start
¶ 1. Installation
// Add to your project's .uproject plugins section
{
"Name": "Supabase",
"Enabled": true
}
¶ 2. Basic Setup
// C++ Setup
USupabaseConnection* Connection = NewObject<USupabaseConnection>();
Connection->SupabaseServerUrl = TEXT("https://your-project.supabase.co");
Connection->SupabaseCredentials.AnonymousKey = TEXT("your-anon-key");
// Initialize through Manager
USupabaseManager::InitializeSupabase(this, Connection);
¶ 3. Blueprint Setup
Use the Initialize Supabase node in Blueprint with your connection settings.
¶ 4. First Query
// Async query example
UAsyncQuery* QueryTask = UAsyncQuery::AsyncQuery(
this,
TEXT("users"),
TEXT("*"),
TArray<FQueryFilter>()
);
QueryTask->OnSuccess.AddDynamic(this, &AMyActor::OnQuerySuccess);
QueryTask->Activate();
¶ 📋 System Requirements
| Component | Requirement |
|---|---|
| Unreal Engine | 5.5.0+ |
| Platforms | Win64, Mac, Linux, Android, iOS |
| Dependencies | WebBrowserWidget, HTTP, WebSockets |
| Build System | Visual Studio 2022+ / Xcode 14+ |
¶ 🏢 Plugin Information
| Detail | Value |
|---|---|
| Version | 1.34.2 |
| Developer | Mountain Labs |
| Support | Discord Community |
| Documentation | Google Docs |
| Marketplace | Epic Fab Store |
¶ 🔗 Quick Links
¶ Essential Resources
- Installation Guide - Get up and running in 5 minutes
- API Reference - Complete function and class documentation
- Examples - Working code samples and tutorials
- Migration Guide - Upgrading from previous versions
¶ Community & Support
- Discord Server - Community support and discussions
- GitHub Issues - Bug reports and feature requests
- FAQ - Frequently asked questions and solutions
¶ Advanced Topics
- Performance Guide - Optimization best practices
- Security Guide - Secure implementation patterns
- Deployment Guide - Production deployment strategies
¶ 📈 Latest Updates (v1.35.3)
¶ ✅ Production Enhancements
- Thread-Safe Operations: All async operations now properly handle threading
- Memory Management: Fixed memory leaks in async operations
- Error Recovery: Enhanced error handling and recovery mechanisms
- Health Monitoring: Automatic connection health checks and token refresh
¶ 🔧 Technical Improvements
- Subsystem Architecture: Migrated to UGameInstanceSubsystem for better lifecycle management
- Event System: Improved event broadcasting and cleanup
- WebSocket Stability: Enhanced real-time connection stability
- Blueprint Integration: Better Blueprint node organization and error reporting
¶ 🐛 Bug Fixes
- Fixed async operation cleanup issues
- Resolved WebSocket connection edge cases
- Corrected token refresh timing
- Improved error message clarity
¶ 🎯 Next Steps
- Install the Plugin - Download and set up in your project
- Configure Connection - Set up your Supabase project connection
- Explore Examples - Learn from working code samples
- Join Community - Connect with other developers
This wiki is actively maintained and updated with each plugin release. For the most current information, always refer to the latest version documentation.