Repository navigation
Home
Welcome to the GodotEOS documentation! This wiki provides comprehensive documentation for the GodotEOS GDExtension, which integrates Epic Online Services (EOS) with Godot Engine.
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.
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
- Create Epic Developer Account
- Set up your EOS Product
- Configure Authentication
- Create Client Credentials
- Enable Game Services
- Integrate GodotEOS
The GodotEOS integration is organized into several subsystems, each handling specific aspects of the Epic Online Services functionality:
- Platform β EOS Platform initialization and lifecycle management
- Authentication β User login/logout, authentication callbacks
- User Info β User information caching and queries
- Friends β Friends list management and friend information
- Achievements β Achievement querying and unlocking
- Leaderboards β Leaderboard queries and user score management
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.
| 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 |
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