DOCSEARCHbyAlgolia
Submit Docs

Ludeo SDK Documentation

website·Indexed 33 days ago

https://docs.ludeo.com/docs/core/

Developer guides for integrating the Ludeo SDK into Unity and Unreal Engine. Ludeo enables game developers to capture and replay gameplay moments as instantly-playable, browser-based experiences. The documentation covers SDK initialization, state management using context stacks, multiplayer architecture, and the use of Creator Lab for turning moments into playable Ludeos.

Tokens
76.4K
Snippets
153
Records
477
Agent score
55%

What's inside Ludeo

  1. Overview of Ludeo SDK State Management

    The Ludeo SDK uses a context stack-based approach to track and restore gameplay state between Creator Flow (capture) and Player Flow (playback). Key principles include:

    • Context Stack: Hierarchical organization (Objects → Components → Attributes).
    • Delta Tracking: Only state changes are tracked in Creator Flow.
    • Object-Oriented Structure: State matches the game's object structure.
    • Efficient Serialization: Optimized for high-frequency gameplay calls.

    Main mechanisms provided by the Unreal plugin:

    • FLudeoRoomWriter: Tracks gameplay state and player actions (available when a room is open).
    • FLudeoReadableObject: Restores gameplay state (available after calling FLudeoSession::GetLudeo()).
    • Optional Reference Managers: ULudeoSaveGameManager (capture) and ULudeoLoadGameManager (playback) can save/restore the world using UPROPERTY(SaveGame) with FLudeoSaveGameSpecification and FLudeoLoadGameSpecification.

  2. Overview of Ludeo playable marketing content

    Ludeo is a marketing technology platform that enables game studios to embed interactive gameplay experiences directly into marketing channels (such as YouTube, Twitch, Discord, social media, and web pages) instead of using static videos. It works by capturing game state and replaying it within a web-based container, allowing users to interact with a short, controlled segment of the game in their browser without downloading the full game.

  3. Overview of Ludeo playable marketing content

    Ludeo is a marketing technology platform that allows game studios to create interactive gameplay experiences for marketing channels (YouTube, Twitch, Discord, social media, and web pages) using their actual game engine. Instead of static videos, Ludeo captures game state and replays it in a web-based container, allowing users to interact with short, controlled segments of the game in a browser without downloading the full game.

  4. Overview of the Ludeo Integration Co-Pilot

    The Integration Co-Pilot provides engine-specific skills that guide an IDE through the Ludeo SDK integration process. It uses a staged approach, starting with a curated slice of the game to ensure a quick working integration before expanding to full coverage. It is compatible with any IDE supporting skill.md files, including Cursor, Claude Code, VS Code, and JetBrains.

  5. Overview of Creator Lab

    Creator Lab is a web-based tool (creators.ludeo.com) that acts as the bridge between a game and the Ludeo platform. It allows developers and creators to browse gameplay moments captured by the SDK and convert them into playable Ludeos without writing additional code. Key capabilities include trimming moments, setting objectives, testing Ludeos locally or in the cloud, and publishing them for public play.

  6. Overview of Tracy Profiler support in Ludeo SDK

    The Ludeo SDK includes built-in support for the Tracy Profiler, a real-time tool for analyzing CPU zones, function timing, thread behavior, and GPU timing. This functionality is available exclusively in the Development build of the SDK and should not be shipped in production builds.

  7. Overview of Ludeo State Management

    The Ludeo SDK uses a context stack-based approach to track and restore gameplay state. It employs delta tracking (tracking only changes rather than full snapshots) in Creator Flow and organizes state in an object-oriented hierarchy (Objects → Components → Attributes) for efficient serialization.

    Two primary interfaces are used:

    • DataWriter: Used in Creator Flow to track gameplay state and player actions.
    • DataReader: Used in Player Flow to restore gameplay state from Ludeo.

  8. Overview of Ludeo playable marketing content

    Ludeo is a marketing technology platform that enables game studios to embed interactive gameplay experiences directly into marketing channels (such as YouTube, Twitch, Discord, social media, and web pages) instead of using static videos. It works by capturing specific gameplay moments and allowing users to interact with them in a web-based container without needing to download the full game.

  9. Overview of Creator Lab

    Creator Lab is the bridge between a game and the Ludeo platform. It allows developers and creators to browse gameplay moments captured by the SDK, turn those moments into playable Ludeos by setting objectives and start/end points, and manage the publishing and testing of those Ludeos.

  10. Overview of Ludeo Unity Plugin Architecture

    The Ludeo Unity plugin provides a C# API that wraps a core C SDK. It is organized around a set of core classes that manage the Ludeo lifecycle. The typical lifecycle flow is: LudeoManager → LudeoSession → LudeoRoom → LudeoPlayer.

    Key classes and their responsibilities:

    • LudeoManager: Static entry point for SDK initialization and session creation.
    • LudeoSession: Manages platform connection, activation, rooms, and session events.
    • LudeoRoom: Manages gameplay state and players for a single Ludeo moment.
    • LudeoPlayer: Represents a player in a room and controls gameplay begin/end.
    • LudeoRoomWriter: Used in Creator Flow to create writable objects and send actions.
    • LudeoWritableObject / LudeoWritableComponent: Track gameplay state attributes in Creator Flow.
    • LudeoDataReader: Provides restore data (via LudeoReadableObject / LudeoReadableComponent) in Player Flow.
    • LudeoHelpers: Integration support utilities.

  11. Understand Ludeo Unreal Plugin core terminology

    The Ludeo Unreal plugin uses the following key concepts for gameplay recording and state management:

    • Capture: The process of recording game state and gameplay video during active gameplay.
    • Client: The application using the SDK (typically the game itself).
    • Cloud Playback: Streaming and interacting with gameplay hosted on cloud servers, allowing playable experiences without local installation.
    • Creator Lab: An interface used to configure captured gameplay moments, such as selecting start points and setting objectives.
    • Diff-based Tracking: A state tracking method that minimizes bandwidth by sending only changes to the game state rather than full snapshots.
    • Completion Delegate: A delegate bound to an asynchronous Ludeo function call that fires exactly once upon operation completion.

  12. Use Cloud Testing for GPU and environment validation

    Cloud Testing allows you to run builds on dedicated cloud GPU machines to reproduce cloud-only behavior, validate Player Flow with real Ludeo payloads, and evaluate streaming latency.

    Prerequisites:

    • A Windows build must be submitted and assigned to an environment.
    • Setup is managed in the Test Machines section of Studio Lab.

    Key Capabilities:

    • Stream the game to a browser to observe encoding and input feel.
    • Load specific Ludeos by ID to verify LudeoSelected paths and state restoration.
    • Test against different GPU tiers (mid-range, legacy, high-end).
    • Set environment variables and launch arguments per session.
    • Access game and host-level logs from Studio Lab.