DOCSEARCHbyAlgolia
Submit Docs

CurseForge for Studios Documentation

website·Indexed 43 days ago

https://docs.curseforge.com

Developer resources for integrating CurseForge into games to enable a built-in mod ecosystem. Includes documentation for the REST API and the cfcore-sdk-ue Unreal Engine plugin, covering mod discovery, installation, user-generated content (UGC) creation, monetization of premium mods, cloud cooking build pipelines, and content moderation.

Tokens
87.4K
Snippets
200
Records
468
Agent score
68%

What's inside CurseForge for Studios

  1. Overview of CurseForge for Studios

    CurseForge for Studios allows game developers to integrate modding support into their games. Developers can make their games available on the CurseForge website, enabling content creators to upload mods and players to download them. It supports multiple platforms including PC and consoles (e.g., Xbox, PlayStation).

  2. Overview of CurseForge for Studios UGC capabilities

    CurseForge for Studios provides game studios with a secure environment to host, distribute, and manage user-generated content (UGC). It is designed to enhance player engagement and extend game lifespan while maintaining brand safety through a 3-layer moderation system (automatic filtering, human review, and community reporting) that is compliant with console requirements.

  3. Overview of Silent Authentication in CurseForge for Studios

    Silent authentication allows players to sign in using their existing platform identity (Steam, PlayStation Network, Xbox Live, Epic Games, or GOG Galaxy) transparently during SDK initialization without a login prompt.

    Key Constraints:

    • Not supported for Nintendo Switch.
    • First-time users will be presented with a one-time Terms of Use and Privacy Policy consent screen; they must accept this before a CurseForge account is created on their behalf.

  4. Overview of the CurseForge In-Game Mod Browser

    The In-Game Mod Browser is a white-labeled user interface that allows players to discover, install, and manage mods directly within a game. Key capabilities include:

    • Curated Discovery: Featured mod carousels and configurable shelves for popular or new content.
    • Browsing & Searching: Category-based browsing with sorting (time, popularity, release date) and search by name, keywords, or author.
    • Mod Detail Pages: Displays descriptions, media (screenshots/videos), ratings, and comments.
    • Lifecycle Management: Direct installation, updating, and deletion of mods.
    • Cross-platform Support: Consistent experience across all major platforms.
    • Customization: Fully white-labeled UI allowing modifications to colors, fonts, and layouts to match game branding.

  6. Overview of CurseForge AAA Studio services

    CurseForge provides an 'AAA Playbook' for game studios to build and manage modding ecosystems. This offering is divided into three primary pillars: Technology, Content, and Go-To-Market, designed to protect the studio's brand, engage the author community, and scale the game's UGC (User Generated Content) ecosystem.

  7. Overview of the CurseForge In-Game Mod Browser

    The In-Game Mod Browser is a user interface integrated into games that allows players to discover, install, and manage mods directly. Key capabilities include:

    • Mod Discovery: Browsing by category with sorting (time, popularity, release date) and searching by name, keywords, or authors.
    • Mod Details: Dedicated mod pages showing descriptions, media (screenshots/videos), ratings, and comments.
    • Lifecycle Management: Direct installation, updating, and deletion of mods.
    • Content Creation: Ability for players to upload new creations to the CurseForge mod repository from within the game.
    • Customization: The UI is fully white-labeled, supporting custom colors, fonts, and layouts to match game branding.
    • Compatibility: Supports cross-platform mod browsing and management.

  8. Overview of CurseForge for Studios SDK Modules

    CurseForge for Studios provides a native Unreal Engine plugin suite for integrating mod management into games. The SDK is open-source (MIT license) and uses native Unreal types and delegates, meaning there is no interop layer or manual polling (pumping) required for asynchronous work. It allows players to sign in, find, install, update, and purchase mods without leaving the game.

  9. Core capabilities of the CurseForge for Studios C++ SDK

    The CurseForge for Studios C++ SDK provides the following functionality for game integration:

    • SSO Authentication: Supports Steam, consoles, email, and custom implementations.
    • Mod Discovery: Ability to query and search mod portfolios and specific mod data.
    • Mod Management: Tools to install, update, and manage mods within the game.
    • Licensing: Distributed under MIT / BSL licenses with permissive terms.

  12. Implement a Server Connection Screen for modded servers

    The CurseForge SDK provides a built-in, white-labeled server module that automatically triggers when a player attempts to join a modded server. This screen informs the player of the required mods, the total disk space needed, and whether any required mods are premium and must be purchased before joining. The SDK handles the detection of required mods and prevents the connection from continuing until the player reviews and approves the requirements.