DOCSEARCHbyAlgolia
Submit Docs

Rally Here Unreal Engine Plugins

website·Indexed 34 days ago

https://docs.rallyhere.gg

Technical documentation for the RHAPI Unreal Engine plugins, detailing data models and structs for matchmaking, platform entitlements, session management, and Pex client/host requests. Includes specifications for structs such as FRHAPI_MatchRequest, FRHAPI_PlatformEntitlement, and FRHAPI_Session, covering member properties, optional fields, and JSON deserialization methods.

Tokens
1.2M
Snippets
6.2K
Records
8.4K
Agent score
47%

What's inside Rally Here

  1. Overview of RallyHere backend game services

    RallyHere is a platform that provides backend services for game development, including core functionality such as authentication, matchmaking, inventory management, and purchasing systems.

  2. Overview of URH_RemoteFileSubsystem

    The URH_RemoteFileSubsystem class is a game instance subsystem plugin used to perform remote file API calls within Unreal Engine.
    class URH_RemoteFileSubsystem
  : public URH_GameInstanceSubsystemPlugin

  3. Overview of URH_AdSubsystem

    The URH_AdSubsystem is a local player subsystem plugin used for serving and responding to ad opportunities for players within an Unreal Engine project.
    class URH_AdSubsystem : public URH_LocalPlayerSubsystemPlugin

  6. Overview of Rally Here Unreal Integration Plugins

    The Rally Here Unreal integration consists of several specialized plugins that handle API communication, implementation logic, debugging, and analytics:

    • RallyHereAPI: An autogenerated plugin that exposes the RallyHere Web API to Unreal. It handles HTTP calls and exposes most structures and enums to Blueprints.
    • RallyHereIntegration: The primary implementation plugin. It wraps raw API calls from RallyHereAPI and provides Blueprint hooks and best-practice caching.
    • RallyHereDebugTool: An ImGui-based tool (using UnrealImGui) for interacting with the RallyHereIntegration layer.
    • AnalyticsRallyHere: An optional implementation of the Unreal Engine Analytics system for sending data to RallyHere.

  7. Overview of RallyHere Metrics Interface

    The RallyHere Game Host Adapter provides an interface for structuring metrics that are compatible with both statsd and graphite. The system utilizes a variety of structs for metric actions (Increment, Set, Unique) and definitions, as well as a registry pointer (RallyHereMetricRegistryPtr) for managing these metrics.

  8. Overview of the GameHostAdapter Library

    The GameHostAdapter library is a required utility for bootstrapping dedicated server allocations across multiple vendors. It is provided as a dynamic library. The library is available on GitHub, and a pre-integrated version is available within the Unreal Integration plugins for reference.

  9. Overview of LocalPlayer plugin components

    The LocalPlayer plugin provides several subsystems and types to manage local player functionality in Unreal Engine:

    • URH_LocalPlayerLoginSubsystem: Handles the login process for the local player.
    • URH_LocalPlayerPresenceSubsystem: Manages the local player's presence.
    • URH_LocalPlayerSessionSubsystem: Manages sessions for the local player.
    • URH_LocalPlayerSubsystem: General subsystem for managing the local player.
    • ERHAPI_LoginResult: Enumeration for login results.
    • ERHAPI_LocalPlayerLoginOSS: Enumeration for Online Subsystem (OSS) login types.
    • FRH_LoginResult: Structure containing detailed login result data.

  10. Overview of PlayerExperience Unreal Plugin Components

    The PlayerExperience plugin provides a framework for collecting and tracking game and network statistics in Unreal Engine. Key components include:

    • Collector & Configuration: URH_PEXCollector handles data collection via stat groups, while URH_PEXCollectorConfig (and its specialized versions for Client, Host, and Dedicated Server) manages configuration.
    • Stat Groups: A hierarchy of stat groups starting from URH_PEXStatGroup, including specialized groups for primary stats (URH_PEXPrimaryStats), game stats (URH_PEXGameStats), and various network stats (URH_PEXNetworkStats and its derivatives).
    • Data Tracking: FRH_StatAccumulator tracks min, max, and average values without storing every individual data point, while FRH_StatCounter tracks current values and summary data.
    • Interfaces: IRH_PEXOwnerInterface and URH_PEXOwnerInterface define the owner of the PlayerExperience data.

  11. Overview of Platform Use Rulesets

    Platform Use Rulesets are an optional system used to manage rules regarding how items are allowed or disallowed to transfer across different platforms. This is particularly useful for handling platform-specific restrictions on currencies and purchasable entitlements.

  12. Overview of the RallyHere Game Host Adapter SDK

    The RallyHere Game Host Adapter is an SDK designed to integrate game instance servers with RallyHere. It provides a unified set of calls to handle multiple different types of game hosting systems. To ensure compatibility and allow RallyHere to update hosting providers without requiring changes to the game server code, developers should target and use the C API directly.