Skip to content
Jan Mesarč edited this page Oct 7, 2025 · 8 revisions

GodotEOS Wiki

Welcome to the GodotEOS documentation! This wiki provides comprehensive documentation for the GodotEOS GDExtension, which integrates Epic Online Services (EOS) with Godot Engine.


Overview

GodotEOS is a GDExtension that provides seamless integration between Godot Engine and Epic Online Services, enabling developers to implement online features such as authentication, achievements, leaderboards, and social features in their Godot games.


πŸš€ Getting Started

Before diving into the specific subsystems, make sure you have:

  • βœ… Godot Engine 4.3 and higher installed
  • βœ… Epic Online Services SDK configured
  • βœ… GodotEOS GDExtension properly set up in your project
  • πŸ“‹ Epic Dashboard Setup - Complete EOS product configuration guide

Quick Setup Checklist

  1. Create Epic Developer Account
  2. Set up your EOS Product
  3. Configure Authentication
  4. Create Client Credentials
  5. Enable Game Services
  6. Integrate GodotEOS

Subsystems

The GodotEOS integration is organized into several subsystems, each handling specific aspects of the Epic Online Services functionality:

Core Systems

  • Platform β€” EOS Platform initialization and lifecycle management

Authentication & User Management

  • Authentication β€” User login/logout, authentication callbacks
  • User Info β€” User information caching and queries

Social Features

  • Friends β€” Friends list management and friend information
  • Achievements β€” Achievement querying and unlocking
  • Leaderboards β€” Leaderboard queries and user score management

Documentation Notes

Each subsystem page documents:

  • Supported API surface β€” What functionality is currently implemented
  • Usage examples β€” How to use the subsystem in your Godot project
  • Known limitations β€” Current restrictions and unsupported features
  • API reference β€” Available methods and properties

Use these pages as a developer-facing quick reference for what functionality is available via the GodotEOS singleton and underlying subsystems.


EOS Integration Progress

Subsystem Status Description
Platform βœ… Core Foundation for all EOS operations
Authentication βœ… Ready Login/logout and user management
User Info βœ… Ready User profile data caching
Friends βœ… Ready Social friend management
Achievements βœ… Ready Achievement and stats system
Leaderboards βœ… Ready Competitive ranking system
Presence πŸ”„ Planned User online status
Reports πŸ”„ Planned Player reporting functionality
Metrics πŸ”„ Planned Telemetry and analytics
TitleStorage πŸ”„ Planned Cloud-based title storage
UI πŸ”„ Planned Epic Games overlay UI
AntiCheat πŸ“… Future Anti-cheat systems
Sessions πŸ“… Future Multiplayer session management
Lobby πŸ“… Future Lobby matchmaking
Invites πŸ“… Future Custom invitation system
Mods πŸ“… Future Modding support

Contributing

This documentation is maintained alongside the GodotEOS project. For questions, issues, or contributions:

  • Issues: Report bugs or request features
  • Pull Requests: Submit documentation improvements

Built with ❀️ for the Godot community

Clone this wiki locally