Get started with the Supabase UE5 Plugin in under 5 minutes
Version 1.34.2 | Production Ready | Unreal Engine 5.5+
Before you begin, ensure you have:
Supabase folder to your project’s Plugins directoryPlugins folder doesn’t exist, create it in your project rootAdd the plugin reference to your project’s .uproject file:
{
"Plugins": [
{
"Name": "Supabase",
"Enabled": true
}
]
}
https://your-project.supabase.co)eyJ...)eyJ...) - Optional but recommendedIn your Game Instance Blueprint:
Create Connection Settings:
Server URL: "https://your-project.supabase.co"
Anonymous Key: "your-anon-key-here"
Service Key: "your-service-key-here" (optional)
Connection Name: "Main"
// In your GameInstance.cpp BeginPlay()
void AMyGameInstance::BeginPlay()
{
Super::BeginPlay();
// Get the Supabase subsystem
USupabaseSubsystem* Supabase = GetSubsystem<USupabaseSubsystem>();
// Create connection configuration
USupabaseConnection* Connection = NewObject<USupabaseConnection>();
Connection->SupabaseServerUrl = TEXT("https://your-project.supabase.co");
Connection->SupabaseCredentials.AnonymousKey = TEXT("your-anon-key-here");
Connection->SupabaseCredentials.ServiceKey = TEXT("your-service-key-here");
Connection->ConnectionName = TEXT("Main");
// Initialize the connection
Supabase->InitializeConnection(Connection);
// Bind to connection events (optional)
Supabase->OnConnectionStateChanged.AddDynamic(this, &AMyGameInstance::OnSupabaseConnected);
}
Look for these log messages in your Output Log:
LogTemp: Supabase subsystem initialized successfully
LogTemp: Connection established to: https://your-project.supabase.co
LogTemp: Supabase connection test passed
Try a simple query to test everything works:
*UAsyncQuery* Query = UAsyncQuery::AsyncQuery(
this,
TEXT("your_table_name"),
TEXT("*"),
TArray<FQueryFilter>()
);
Query->OnSuccess.AddDynamic(this, &AMyClass::OnQuerySuccess);
Query->Activate();
https://YourProject/Plugins/Supabase/.uproject → Generate Visual Studio project files)Now that you’re set up, explore these guides:
🎉 Congratulations! You’ve successfully set up the Supabase UE5 Plugin. You now have access to production-ready database integration with comprehensive error handling, automatic connection management, and thread-safe operations.
For detailed documentation on specific features, visit the main plugin documentation or join our Discord community for support.