DOCSEARCHbyAlgolia
Submit Docs

mod.io Documentation

website·Indexed 40 days ago

https://docs.mod.io

Developer resources for mod.io, a middleware provider for user-generated content (UGC). Includes documentation for the REST API, C++ SDK, Embed Hub, and ModBot, as well as guides on dependency management, monetization, and cross-platform support for consoles (Xbox, PlayStation), mobile, and VR.

Tokens
237.5K
Snippets
931
Records
1.7K
Agent score
66%

What's inside mod.io

  1. Overview of mod.io Rules-Based Moderation

    Rules-Based Moderation automatically processes content submitted through the mod.io REST API against a series of user-defined checks. If checks match, specified actions are triggered. Content can match multiple rules unless a 'Deny' action is encountered, which stops further processing and returns an error to the user. Rules are grouped into rulesets based on the target endpoint (action).

  2. Overview of mod.io Metrics Export

    The Metrics Export feature is a premium service for game studios that delivers detailed logs of player interactions on mod.io directly to a studio's own cloud infrastructure (AWS S3 or Azure Blob Storage). Data is delivered daily at midnight UTC in Apache Parquet format, partitioned by date (YYYYMMDD). mod.io retains exportable data for 30 days by default, though this and the delivery interval can be configured upon request.

  3. Overview of mod.io Unity Component UI

    Component UI is a framework for building customized in-game User Generated Content (UGC) browsers in Unity. It consists of a collection of modular parts (Resource objects, Property Containers, and Properties) that can be combined to create a fully branded UI. For a fully featured implementation, developers are encouraged to explore the Template UI integration.

  4. Overview of ModBot for mod.io Discord integration

    ModBot is a Discord bot designed for mod.io that automatically notifies communities when new User Generated Content (UGC) goes live or when existing UGC is updated. It is built using modio-rs and twilight.

  5. Overview of mod.io Embed Hub

    Embed Hub is a premium feature that allows you to embed the mod.io browser into your website, launcher, or game. It is highly customizable, providing control over styling, enabled features, and layout. It can be used as a web-based browser or as an in-game/launcher UI overlay for managing User Generated Content (UGC) libraries. To gain access to this feature, contact developers@mod.io.

  6. Overview of mod.io Collections

    Collections allow users to curate and organize playlists of user-generated content (UGC) for other players to discover and subscribe to. Collections are displayed on user game profiles and creator profile pages. When a user subscribes to a collection, they are automatically subscribed to all the mods included in that collection, which are then downloaded and installed in-game (depending on the specific in-game integration).

  7. Overview of the mod.io Component UI framework

    The Component UI framework is a set of specifications, UI components, and editor tooling designed to integrate mod.io plugin data and events into a game's user interface. It allows developers to customize in-game UI to match a specific brand or game style, whether by adding functionality to existing screens or creating dedicated browser and discovery sections. It is the foundational backbone for in-game UI built using mod.io's Unreal Engine and Unity plugins.

  8. Overview of mod.io Component UI for Unreal Engine

    The Component UI framework for Unreal Engine allows developers to integrate mod.io plugin data and events into their game's UI. It is designed to abstract plugin-specific code, allowing UI implementation in C++, UMG/Blueprint, or a combination of both, without requiring engine-level changes. The framework includes default components, component interfaces for communication, infrastructure classes/helper functions for event registration, and a full Template UI implementation of a mod browser for reference or customization.

  9. Overview of Custom SSO via OpenID Connect

    Custom SSO is a premium feature that allows a studio's identity provider to act as the single required authentication source for users accessing UGC in a game. It uses the OpenID Connect (OIDC) specification, making it stateless and ideal for game clients that cannot use traditional OAuth 2.0 web-redirect flows. The process involves the studio's identity provider generating a signed ID Token, which mod.io verifies using a public JWK (JSON Web Key) set to grant a mod.io access token.

  10. Overview of the Mutator Framework

    The Mutator framework allows developers to expose specific interaction points to modders. It supports two primary types of interactions: Asset Replacements (swapping assets like skins or data assets) and Mutator Events (modifying or injecting new game behaviors). This system lowers the technical barrier for modders by providing a defined framework with default implementations.

  11. Overview of the mod.io C++ SDK

    The mod.io C++ SDK is a C++17 cross-platform wrapper around the mod.io REST API. It allows developers to browse, install, update, and manage user-generated content (UGC) without blocking the game thread. The SDK provides a consistent interface for communicating with mod.io services (searching, subscriptions, user state) and managing local content (downloads, updates, installs, and removals).

  12. Overview of mod.io Template UI layouts and widgets

    The mod.io Template UI for Unreal Engine consists of several key layouts and widgets designed for keyboard, mouse, and gamepad navigation with responsive scaling for different aspect ratios. Key components include:

    • WBP_ModioModBrowser: The main layout for the mod browser.
    • WBP_ModioDefaultModTile: The individual mod tiles that populate the browser.
    • WBP_ModioModDetailsDialog: The dialog displaying specific mod details. The thumbnail gallery in this layout should maintain a 16:9 aspect ratio.
    • WBP_ModioFilterPanel: A panel using radio and check boxes for filtering and sorting, organized into expandable/collapsible sub-categories.
    • WBP_ModioDefaultTOSDialog: A component used to implement Terms of Use dialogs.