Skip to content

EpicDashboardSetup

Jump to bottom
Jakub Hubacek edited this page Oct 2, 2025 · 3 revisions

🛠️ Epic Online Services Dashboard Setup Guide

Location: Epic Games Developer Portal

This guide provides essential steps for setting up your Epic Online Services (EOS) product. For detailed instructions, refer to the official Epic documentation.

Prerequisites

  • ✅ Epic Games Developer Account - Sign up here
  • ✅ Organization created in the Developer Portal
  • ✅ Basic understanding of Epic Online Services concepts

Quick Setup Steps

1. Create Your Product

Navigate to Your Products and create a new product. See Product Creation Guide for details.

Required: Note your Product ID for GodotEOS configuration.

2. Enable Epic Account Services

Go to Product Settings → Epic Account Services and enable the service. Configure OAuth settings as needed. See Epic Account Services Setup.

3. Create Clients and Policies

Create a client in Product Settings → Clients. Configure policies for your game features. See Client Management.

Required: Save your Client ID and Client Secret securely.

Essential Policies for GodotEOS

Epic provides several predefined client policies. For GodotEOS, we found that the GameClient /w UnlockAchievements policy worked best for our implementation. See the Client Policy Reference for all available options.

4. Set Up Game Services

Enable required services in Game Services:

Create definitions for achievements, leaderboards, and stats as needed.

Configure Deployment

In Product Settings → Deployments, create or select your deployment. This is where your game services data lives.

Required: Note your Deployment ID for GodotEOS configuration.

5. Configure Sandbox

Set up Sandbox for testing and Live for production. See Deployment Management.

Required: Note your Sandbox ID and Deployment ID.

Finding Your IDs

  • Product ID: Found in Product Settings → General
  • Sandbox ID: Found in Product Settings → Sandboxes
  • Deployment ID: Found in Product Settings → Deployments
  • Client ID/Secret: Found in Product Settings → Clients

6. Test Your Setup

Use the Epic Online Services Web Portal to test your configuration:

  • Login with test accounts
  • Verify achievements unlock
  • Check leaderboard submissions
  • Test friend relationships

See Testing Guide for detailed testing procedures.

GodotEOS Integration

Required Configuration

In your Godot project, initialize GodotEOS with your credentials:

# Initialize EOS with your credentials
var init_result = EOS.initialize({
    "product_name": "Your Game Name",
    "product_version": "1.0.0",
    "product_id": "your-product-id",        # From Step 1
    "sandbox_id": "your-sandbox-id",        # From Step 5
    "deployment_id": "your-deployment-id",  # From Step 5
    "client_id": "your-client-id",          # From Step 3
    "client_secret": "your-client-secret"   # From Step 3 (keep secure!)
})

Environment-Specific Settings

# Sandbox configuration (development)
const SANDBOX_CONFIG = {
    "client_id": "sandbox-client-id",
    "client_secret": "sandbox-client-secret",
    "sandbox_id": "sandbox-id"
}

# Live configuration (production)
const LIVE_CONFIG = {
    "client_id": "live-client-id",
    "client_secret": "live-client-secret",
    "deployment_id": "live-deployment-id"
}

Testing Your Setup

  1. Test in Sandbox: Always test EOS integration in your Sandbox environment first
  2. Verify Authentication: Test login flows (Launcher, Device ID, Developer)
  3. Check Services: Test achievements, leaderboards, and stats functionality
  4. Monitor Logs: Use Epic's developer tools for debugging

Troubleshooting

Common Issues

  • Invalid Credentials: Verify Client ID/Secret and environment settings
  • Service Not Working: Check that services are enabled and properly configured
  • Authentication Failures: Review OAuth settings and redirect URIs

Support Resources

Key Concepts

Stats, Achievements & Leaderboards Relationship

  • Stats: Numerical values tracking player progress (e.g., total_kills, high_score)
  • Achievements: Milestones unlocked manually or when stats reach thresholds
  • Leaderboards: Rankings based on stat values, updated automatically

See Game Services Overview for detailed relationships.

Quick Reference

Service Dashboard Location GodotEOS Usage Documentation
Authentication Product Settings → Epic Account Services EOS.Auth Auth Guide
Achievements Game Services → Achievements EOS.Achievements Achievements
Leaderboards Game Services → Leaderboards EOS.Leaderboards Leaderboards
Stats Game Services → Stats EOS.Achievements (stats methods) Stats
Friends Game Services → Friends EOS.Friends Friends
User Info Game Services → User Info EOS.UserInfo User Info

Troubleshooting

Common Issues

"Invalid Client" Error

  • Verify Client ID and Secret are correct
  • Ensure client has proper policies configured
  • Check if client is enabled in the correct sandbox

"Invalid Deployment" Error

  • Confirm Deployment ID matches your sandbox/deployment setup
  • Verify deployment is published (for live environment)

Authentication Fails

  • Check Product ID is correct
  • Ensure Epic Account Services are enabled
  • Verify sandbox configuration

Services Not Working

  • Confirm services are enabled in Game Services
  • Check that definitions are created and published
  • Verify client policies include required permissions

Getting Help

This guide focuses on GodotEOS essentials. For comprehensive Unreal Engine setup, see the official Epic documentation.

Clone this wiki locally